mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-19 02:24:04 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
23 lines
585 B
Groff
23 lines
585 B
Groff
.TH libssh2_init 3 "19 Mar 2010" "libssh2 1.2.5" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_init - global library initialization
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
#define LIBSSH2_INIT_NO_CRYPTO 0x0001
|
|
|
|
int
|
|
libssh2_init(int flags);
|
|
.fi
|
|
.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 AVAILABILITY
|
|
Added in libssh2 1.2.5
|
|
.SH SEE ALSO
|
|
.BR libssh2_exit(3)
|