libssh2

1
.\" Copyright (C) Daiki Ueno
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_agent_init 3 "23 Dec 2009" "libssh2" "libssh2"
4
.SH NAME
5
libssh2_agent_init - init an ssh-agent handle
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
LIBSSH2_AGENT *
11
libssh2_agent_init(LIBSSH2_SESSION *session);
12
.fi
13
.SH DESCRIPTION
14
Init an ssh-agent handle. Returns the handle to an internal
15
representation of an ssh-agent connection. After the successful
16
initialization, an application can call \fBlibssh2_agent_connect(3)\fP
17
to connect to a running ssh-agent.
18

19
Call \fBlibssh2_agent_free(3)\fP to free the handle again after you are
20
doing using it.
21
.SH RETURN VALUE
22
Returns a handle pointer or NULL if something went wrong. The returned handle
23
is used as input to all other ssh-agent related functions libssh2 provides.
24
.SH AVAILABILITY
25
Added in libssh2 1.2
26
.SH SEE ALSO
27
.BR libssh2_agent_connect(3)
28
.BR libssh2_agent_free(3)
29