mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
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
43 lines
893 B
Markdown
43 lines
893 B
Markdown
---
|
|
c: Copyright (C) Daiki Ueno
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_agent_init
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_agent_connect(3)
|
|
- libssh2_agent_free(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_agent_init - init an ssh-agent handle
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
LIBSSH2_AGENT *
|
|
libssh2_agent_init(LIBSSH2_SESSION *session);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Init an ssh-agent handle. Returns the handle to an internal
|
|
representation of an ssh-agent connection. After the successful
|
|
initialization, an application can call **libssh2_agent_connect(3)**
|
|
to connect to a running ssh-agent.
|
|
|
|
Call **libssh2_agent_free(3)** to free the handle again after you are
|
|
doing using it.
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns a handle pointer or NULL if something went wrong. The returned handle
|
|
is used as input to all other ssh-agent related functions libssh2 provides.
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in libssh2 1.2
|