b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
1.2 KiB
c, SPDX-License-Identifier, Title, Section, Source, See-also
| c | SPDX-License-Identifier | Title | Section | Source | See-also | ||
|---|---|---|---|---|---|---|---|
| Copyright (C) The libssh2 project and its contributors. | BSD-3-Clause | libssh2_channel_request_auth_agent | 3 | libssh2 |
|
NAME
libssh2_channel_request_auth_agent - request agent forwarding for a session
SYNOPSIS
#include <libssh2.h>
int
libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);
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.
To use agent forwarding, libssh2_session_callback_set2(3) must first be called to set LIBSSH2_CALLBACK_AUTHAGENT. This callback will be invoked when the remote host opens a connection to the local agent.
channel - Previously opened channel instance such as returned by libssh2_channel_open_ex(3)
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.