mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-26 16:48:48 +03:00
- 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 #949
38 lines
1.0 KiB
Groff
38 lines
1.0 KiB
Groff
.TH libssh2_trace 3 "26 Dec 2008" "libssh2 1.0" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_trace - enable debug info from inside libssh2
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
void
|
|
libssh2_trace(LIBSSH2_SESSION *session, int bitmask);
|
|
.fi
|
|
.SH 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.
|
|
|
|
\fBbitmask\fP can be set to the logical OR of none, one or more of these:
|
|
.RS
|
|
.IP LIBSSH2_TRACE_SOCKET
|
|
Socket low-level debugging
|
|
.IP LIBSSH2_TRACE_TRANS
|
|
Transport layer debugging
|
|
.IP LIBSSH2_TRACE_KEX
|
|
Key exchange debugging
|
|
.IP LIBSSH2_TRACE_AUTH
|
|
Authentication debugging
|
|
.IP LIBSSH2_TRACE_CONN
|
|
Connection layer debugging
|
|
.IP LIBSSH2_TRACE_SCP
|
|
SCP debugging
|
|
.IP LIBSSH2_TRACE_SFTP
|
|
SFTP debugging
|
|
.IP LIBSSH2_TRACE_ERROR
|
|
Error debugging
|
|
.IP LIBSSH2_TRACE_PUBLICKEY
|
|
Public Key debugging
|
|
.RE
|