mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-26 16:48:48 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
26 lines
604 B
Groff
26 lines
604 B
Groff
.\"
|
|
.\" Copyright (c) 2009 by Daiki Ueno
|
|
.\"
|
|
.TH libssh2_agent_connect 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_agent_connect - connect to an ssh-agent
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_agent_connect(LIBSSH2_AGENT *agent);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Connect to an ssh-agent running on the system.
|
|
|
|
Call \fBlibssh2_agent_disconnect(3)\fP to close the connection after
|
|
you're doing using it.
|
|
.SH RETURN VALUE
|
|
Returns 0 if succeeded, or a negative value for error.
|
|
.SH AVAILABILITY
|
|
Added in libssh2 1.2
|
|
.SH SEE ALSO
|
|
.BR libssh2_agent_init(3)
|
|
.BR libssh2_agent_disconnect(3)
|