libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_session_flag 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_session_flag - TODO
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value);
12
.fi
13
.SH DESCRIPTION
14
Set options for the created session. \fIflag\fP is the option to set, while
15
\fIvalue\fP is typically set to 1 or 0 to enable or disable the option.
16
.SH FLAGS
17
.IP LIBSSH2_FLAG_SIGPIPE
18
If set, libssh2 will not attempt to block SIGPIPEs but will let them trigger
19
from the underlying socket layer.
20
.IP LIBSSH2_FLAG_COMPRESS
21
If set - before the connection negotiation is performed - libssh2 will try to
22
negotiate compression enabling for this connection. By default libssh2 will
23
not attempt to use compression.
24
.SH RETURN VALUE
25
Returns regular libssh2 error code.
26
.SH AVAILABILITY
27
This function has existed since the age of dawn. LIBSSH2_FLAG_COMPRESS was
28
added in version 1.2.8.
29
.SH SEE ALSO
30