lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00
Code Activity

Add man page for libssh2_init and libssh2_exit. Fix libssh2_exit prototype.

Browse Source
This commit is contained in:
Simon Josefsson
2010-03-19 09:21:48 +01:00
parent 55ede3b41b
commit 6c3c3e1b49
4 changed files with 38 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/libssh2_init.3 Normal file
View File

@ -0,0 +1,21 @@
.TH libssh2_init 3 "19 Mar 2010" "libssh2 1.2.5" "libssh2 manual"
.SH NAME
libssh2_init - global library initialization
.SH SYNOPSIS
#include <libssh2.h>
#define LIBSSH2_INIT_NO_CRYPTO 0x0001
int
libssh2_init(int flags);
.SH DESCRIPTION
Initialize the libssh2 functions. This typically initialize the
crypto library. It uses a global state, and is not thread safe -- you
must make sure this function is not called concurrently.
.SH RETURN VALUE
Returns 0 if succeeded, or a negative value for error.
.SH SEE ALSO
.BR libssh2_exit(3)