mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-28 11:45:02 +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
24 lines
872 B
Groff
24 lines
872 B
Groff
.TH libssh2_channel_request_auth_agent 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_channel_request_auth_agent - request agent forwarding for a session
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Request that agent forwarding be enabled for this SSH session. This sends the
|
|
request over this specific channel, which causes the agent listener to be
|
|
started on the remote side upon success. This agent listener will then run
|
|
for the duration of the SSH session.
|
|
|
|
\fIchannel\fP - Previously opened channel instance such as returned by
|
|
.BR libssh2_channel_open_ex(3)
|
|
|
|
.SH RETURN VALUE
|
|
Return 0 on success or negative on failure. It returns
|
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
|
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
|