lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-08-05 20:55:47 +03:00
Code Activity

docs: improve man page for libssh2_channel_request_auth_agent

Browse Source 
Mention that the callback is needed for full functionality.

This is inspired/copied from the existing X11 man pages.

Closes #1503
This commit is contained in:
Kian Kasad
2024-12-20 14:23:32 -08:00
committed by Viktor Szakats
parent 30befffe04
commit 30203f167b
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/libssh2_channel_request_auth_agent.3
View File

@@ -16,9 +16,18 @@ 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 started on the remote side upon success. This agent listener will then run
for the duration of the SSH session. for the duration of the SSH session.
To use agent forwarding,
.BR libssh2_session_callback_set2(3)
must first be called to set \fBLIBSSH2_CALLBACK_AUTHAGENT\fP.
This callback will be invoked when the remote host opens a connection to the
local agent.
\fIchannel\fP - Previously opened channel instance such as returned by \fIchannel\fP - Previously opened channel instance such as returned by
.BR libssh2_channel_open_ex(3) .BR libssh2_channel_open_ex(3)
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
.SH SEE ALSO
.BR libssh2_session_callback_set2(3)