mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-30 12:05:34 +03:00
3a391f6cf2
We now allow libssh2_session_flag() to enable compression with a new flag and I added documentation for the previous LIBSSH2_FLAG_SIGPIPE flag which I wasn't really aware of!
26 lines
974 B
Groff
26 lines
974 B
Groff
.\" $Id: libssh2_session_flag.3,v 1.2 2009/03/23 13:17:49 bagder Exp $
|
|
.\"
|
|
.TH libssh2_session_flag 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_flag - TODO
|
|
.SH SYNOPSIS
|
|
int
|
|
libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value);
|
|
.SH DESCRIPTION
|
|
Set options for the created session. \fIflag\fP is the option to set, while
|
|
\fIvalue\fP is typically set to 1 or 0 to enable or disable the option.
|
|
.SH FLAGS
|
|
.IP LIBSSH2_FLAG_SIGPIPE
|
|
If set, libssh2 will not attempt to block SIGPIPEs but will let them trigger
|
|
from the underlying socket layer.
|
|
.IP LIBSSH2_FLAG_COMPRESS
|
|
If set - before the connection negotiation is performed - libssh2 will try to
|
|
negotiate compression enabling for this connection. By default libssh2 will
|
|
not attempt to use compression.
|
|
.SH RETURN VALUE
|
|
Returns regular libssh2 error code.
|
|
.SH AVAILABILITY
|
|
This function has existed since the age of dawn. LIBSSH2_FLAG_COMPRESS was
|
|
added in version 1.2.8.
|
|
.SH SEE ALSO
|