timeout: added man pages
This commit is contained in:
parent
4ed1e9d96b
commit
26dad4590b
@ -102,6 +102,7 @@ dist_man_MANS = \
|
||||
libssh2_session_flag.3 \
|
||||
libssh2_session_free.3 \
|
||||
libssh2_session_get_blocking.3 \
|
||||
libssh2_session_get_timeout.3 \
|
||||
libssh2_session_hostkey.3 \
|
||||
libssh2_session_init.3 \
|
||||
libssh2_session_init_ex.3 \
|
||||
@ -110,6 +111,7 @@ dist_man_MANS = \
|
||||
libssh2_session_method_pref.3 \
|
||||
libssh2_session_methods.3 \
|
||||
libssh2_session_set_blocking.3 \
|
||||
libssh2_session_set_timeout.3 \
|
||||
libssh2_session_startup.3 \
|
||||
libssh2_sftp_close.3 \
|
||||
libssh2_sftp_close_handle.3 \
|
||||
|
17
docs/libssh2_session_get_timeout.3
Normal file
17
docs/libssh2_session_get_timeout.3
Normal file
@ -0,0 +1,17 @@
|
||||
.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual"
|
||||
.SH NAME
|
||||
libssh2_session_get_timeout - get the timeout for blocking functions
|
||||
.SH SYNOPSIS
|
||||
#include <libssh2.h>
|
||||
.nf
|
||||
long libssh2_session_get_timeout(LIBSSH2_SESSION *session);
|
||||
.SH DESCRIPTION
|
||||
Returns the \fBtimeout\fP (in milliseconds) for how long a blocking the
|
||||
libssh2 function calls may wait until they consider the situation an error and
|
||||
return LIBSSH2_ERROR_TIMEOUT.
|
||||
|
||||
By default libssh2 has no timeout (zero) for blocking functions.
|
||||
.SH RETURN VALUE
|
||||
The value of the timeout setting.
|
||||
.SH SEE ALSO
|
||||
.BR libssh2_session_set_timeout(3)
|
18
docs/libssh2_session_set_timeout.3
Normal file
18
docs/libssh2_session_set_timeout.3
Normal file
@ -0,0 +1,18 @@
|
||||
.TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual"
|
||||
.SH NAME
|
||||
libssh2_session_set_timeout - set timeout for blocking functions
|
||||
.SH SYNOPSIS
|
||||
#include <libssh2.h>
|
||||
.nf
|
||||
void libssh2_session_set_timeout(LIBSSH2_SESSION *session, long timeout);
|
||||
.SH DESCRIPTION
|
||||
Set the \fBtimeout\fP in milliseconds for how long a blocking the libssh2
|
||||
function calls may wait until they consider the situation an error and return
|
||||
LIBSSH2_ERROR_TIMEOUT.
|
||||
|
||||
By default or if you set the timeout to zero, libssh2 has no timeout for
|
||||
blocking functions.
|
||||
.SH RETURN VALUE
|
||||
Nothing
|
||||
.SH SEE ALSO
|
||||
.BR libssh2_session_get_timeout(3)
|
Loading…
x
Reference in New Issue
Block a user