1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-05-08 20:01:29 +03:00
libssh2/docs/libssh2_session_set_read_timeout.3
Viktor Szakats e590450dcc
man: fixups
- 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 
2023-04-11 00:38:35 +00:00

24 lines
671 B
Groff

.TH libssh2_session_set_read_timeout 3 "13 Jan 2023" "libssh2 1.10.1" "libssh2 manual"
.SH NAME
libssh2_session_set_read_timeout - set timeout for packet read functions
.SH SYNOPSIS
.nf
#include <libssh2.h>
void
libssh2_session_set_read_timeout(LIBSSH2_SESSION *session, long timeout);
.fi
.SH DESCRIPTION
Set the \fBtimeout\fP in seconds for how long libssh2 packet read
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, the timeout will be set to
60 seconds.
.SH RETURN VALUE
Nothing
.SH AVAILABILITY
Added in 1.10.1
.SH SEE ALSO
.BR libssh2_session_get_read_timeout(3)