From 30203f167b055206bbc76b62501981f01cbd165d Mon Sep 17 00:00:00 2001 From: Kian Kasad Date: Fri, 20 Dec 2024 14:23:32 -0800 Subject: [PATCH] docs: improve man page for `libssh2_channel_request_auth_agent` Mention that the callback is needed for full functionality. This is inspired/copied from the existing X11 man pages. Closes #1503 --- docs/libssh2_channel_request_auth_agent.3 | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/libssh2_channel_request_auth_agent.3 b/docs/libssh2_channel_request_auth_agent.3 index 8f9ab62b..4da47bab 100644 --- a/docs/libssh2_channel_request_auth_agent.3 +++ b/docs/libssh2_channel_request_auth_agent.3 @@ -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 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 .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 is not really a failure per se. + +.SH SEE ALSO +.BR libssh2_session_callback_set2(3)