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

1.1 KiB

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_trace	3	libssh2

NAME

libssh2_trace - enable debug info from inside libssh2

SYNOPSIS

#include <libssh2.h>

int
libssh2_trace(LIBSSH2_SESSION *session, int bitmask);

DESCRIPTION

This is a function present in the library that can be used to get debug info from within libssh2 when it is running. Helpful when trying to trace or debug behaviors. Note that this function has no effect unless libssh2 was built to support tracing! It is usually disabled in release builds.

bitmask can be set to the logical OR of none, one or more of these:

LIBSSH2_TRACE_SOCKET

Socket low-level debugging

LIBSSH2_TRACE_TRANS

Transport layer debugging

LIBSSH2_TRACE_KEX

Key exchange debugging

LIBSSH2_TRACE_AUTH

Authentication debugging

LIBSSH2_TRACE_CONN

Connection layer debugging

LIBSSH2_TRACE_SCP

SCP debugging

LIBSSH2_TRACE_SFTP

SFTP debugging

LIBSSH2_TRACE_ERROR

Error debugging

LIBSSH2_TRACE_PUBLICKEY

Public Key debugging

RETURN VALUE

Currently always 0, no error.

1.1 KiB Raw Blame History