Skip to content

Commit

Permalink
Add man page for libssh2_init and libssh2_exit. Fix libssh2_exit prot…
Browse files Browse the repository at this point in the history
…otype.
  • Loading branch information
jas4711 committed Mar 19, 2010
1 parent 55ede3b commit 6c3c3e1
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,11 @@ dist_man_MANS = \
libssh2_channel_write_stderr.3 \
libssh2_channel_x11_req.3 \
libssh2_channel_x11_req_ex.3 \
libssh2_exit.3 \
libssh2_free_host_entry.3 \
libssh2_host_entry_match.3 \
libssh2_hostkey_hash.3 \
libssh2_init.3 \
libssh2_knownhost_add.3 \
libssh2_knownhost_check.3 \
libssh2_knownhost_del.3 \
Expand Down
14 changes: 14 additions & 0 deletions docs/libssh2_exit.3
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.TH libssh2_exit 3 "19 Mar 2010" "libssh2 1.2.5" "libssh2 manual"
.SH NAME
libssh2_init - global library deinitialization
.SH SYNOPSIS
#include <libssh2.h>

int
libssh2_exit(void);

.SH DESCRIPTION
Exit the libssh2 functions and free's all memory used internal.

.SH SEE ALSO
.BR libssh2_init(3)
21 changes: 21 additions & 0 deletions docs/libssh2_init.3
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion include/libssh2.h
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ LIBSSH2_API int libssh2_init(int flags);
*
* Exit the libssh2 functions and free's all memory used internal.
*/
LIBSSH2_API void libssh2_exit();
LIBSSH2_API void libssh2_exit(void);

/* Session API */
LIBSSH2_API LIBSSH2_SESSION *
Expand Down

0 comments on commit 6c3c3e1

Please sign in to comment.