libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_request_auth_agent 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_request_auth_agent - request agent forwarding for a session
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);
12
.fi
13
.SH DESCRIPTION
14
Request that agent forwarding be enabled for this SSH session. This sends the
15
request over this specific channel, which causes the agent listener to be
16
started on the remote side upon success. This agent listener will then run
17
for the duration of the SSH session.
18

19
\fIchannel\fP - Previously opened channel instance such as returned by
20
.BR libssh2_channel_open_ex(3)
21
.SH RETURN VALUE
22
Return 0 on success or negative on failure. It returns
23
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
24
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
25