Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_trace (3ssh2)

Name

libssh2_trace - enable debug info from inside libssh2

Synopsis

#include <libssh2.h>

void libssh2_trace(LIBSSH2_SESSION *session, int bitmask);

Description

libssh2_trace(3ssh2)            libssh2 manual            libssh2_trace(3ssh2)



NAME
       libssh2_trace - enable debug info from inside libssh2

SYNOPSIS
       #include <libssh2.h>

       void 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



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 1.0                       26 Dec 2008             libssh2_trace(3ssh2)