From 26dad4590b94a84b8bc4d92e1c8c7dd9b19028b6 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Wed, 4 May 2011 23:26:26 +0200 Subject: [PATCH] timeout: added man pages --- docs/Makefile.am | 2 ++ docs/libssh2_session_get_timeout.3 | 17 +++++++++++++++++ docs/libssh2_session_set_timeout.3 | 18 ++++++++++++++++++ 3 files changed, 37 insertions(+) create mode 100644 docs/libssh2_session_get_timeout.3 create mode 100644 docs/libssh2_session_set_timeout.3 diff --git a/docs/Makefile.am b/docs/Makefile.am index 7ae5c47..ee14576 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -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 \ diff --git a/docs/libssh2_session_get_timeout.3 b/docs/libssh2_session_get_timeout.3 new file mode 100644 index 0000000..4ae1d1d --- /dev/null +++ b/docs/libssh2_session_get_timeout.3 @@ -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 +.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) diff --git a/docs/libssh2_session_set_timeout.3 b/docs/libssh2_session_set_timeout.3 new file mode 100644 index 0000000..b9fb8ed --- /dev/null +++ b/docs/libssh2_session_set_timeout.3 @@ -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 +.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)