mirror of https://github.com/libssh2/libssh2.git synced 2025-10-24 14:53:03 +03:00

Files

Viktor Szakats b889b39945 docs: convert man page sources to "curldown" format

To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.

- add options to not build the `.3` man pages:
  - autotools: `--disable-docs`
  - cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
  manually fixed copyrights, inline function references and a couple
  of other things.

Credits-to: Daniel Stenberg

Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671

Closes #1660

2025-10-09 04:05:38 +02:00

1008 B

Raw Blame History

c, SPDX-License-Identifier, Title, Section, Source, See-also

c	SPDX-License-Identifier	Title	Section	Source	See-also
Copyright (C) The libssh2 project and its contributors.	BSD-3-Clause	libssh2_session_flag	3	libssh2

NAME

libssh2_session_flag - TODO

SYNOPSIS

#include <libssh2.h>

int
libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value);

DESCRIPTION

Set options for the created session. flag is the option to set, while value is typically set to 1 or 0 to enable or disable the option.

FLAGS

LIBSSH2_FLAG_SIGPIPE

If set, libssh2 will not attempt to block SIGPIPEs but will let them trigger from the underlying socket layer.

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.

RETURN VALUE

Returns regular libssh2 error code.

AVAILABILITY

This function has existed since the age of dawn. LIBSSH2_FLAG_COMPRESS was added in version 1.2.8.

1008 B Raw Blame History