The libssh2-docs package contains man pages and examples for
developing applications that use libssh2.
libssh2_agent_free Free an ssh-agent handle. This function also frees the internal collection of public keys. libssh2_agent_init Init an ssh-agent handle. Returns the handle to an internal representation of an ssh-agent connection. After the successful initialization, an application can... libssh2_base64_decode This function is deemed DEPRECATED and will be removed from libssh2 in a future version. Don't use it! Decode a base64 chunk and store it into a newly allocated... libssh2_channel_close channel - active channel stream to set closed status on. Close an active data channel. In practice this means sending an SSH_MSG_CLOSE packet to the remote host... libssh2_channel_eof channel - active channel stream to set closed status on. Check if the remote host has sent an EOF status for the selected stream. libssh2_channel_flush_ex channel - Active channel stream to flush. streamid - Specific substream number to flush. Groups of substreams may be flushed by passing on of the following... libssh2_channel_forward_listen_ex Instruct the remote SSH server to begin listening for inbound TCP/IP connections. New connections will be queued by the library until accepted by... libssh2_channel_get_exit_signal channel - Closed channel stream to retrieve exit signal from. exitsignal - If not NULL, is populated by reference with the exit signal (without leading "SIG")... libssh2_channel_get_exit_status channel - Closed channel stream to retrieve exit status from. Returns the exit code raised by the process running on the remote host at the other end of the... libssh2_channel_process_startup channel - Active session channel instance. request - Type of process to startup. The SSH2 protocol currently defines shell, exec, and subsystem as standard... libssh2_channel_read_ex Attempt to read data from an active channel stream. All channel streams have one standard I/O substream (stream_id == 0), and may have up to 2^32 extended data... libssh2_channel_receive_window_adjust2 Adjust the receive window for a channel by adjustment bytes. If the amount to be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the adjustment... libssh2_channel_send_eof Tell the remote host that no further data will be sent on the specified channel. Processes typically interpret this as a closed stdin descriptor. libssh2_channel_set_blocking channel - channel stream to set or clean blocking status on. blocking - Set to a non-zero value to make the channel block, or zero to make it non-blocking... libssh2_channel_window_read_ex Check the status of the read window. Returns the number of bytes which the remote end may send without overflowing the window limit read_avail (if passed) will... libssh2_channel_window_write_ex Check the status of the write window Returns the number of bytes which may be safely written on the channel without blocking. 'window_size_initial' (if passed)... libssh2_channel_write_ex Write data to a channel stream. All channel streams have one standard I/O substream (stream_id == 0), and may have up to 2^32 extended data streams as... libssh2_exit Exit the libssh2 functions and free's all memory used internal. libssh2_free Deallocate memory allocated by earlier call to libssh2 functions. It uses the memory allocation callbacks provided by the application, if any. Otherwise, this... libssh2_init Initialize the libssh2 functions. This typically initialize the crypto library. It uses a global state, and is not thread safe -- you must make sure this... libssh2_keepalive_config Set how often keepalive messages should be sent. want_reply indicates whether the keepalive messages should request a response from the server. interval is... libssh2_keepalive_send Send a keepalive message if needed. seconds_to_next indicates how many seconds you can sleep after this call before you need to call it again. libssh2_knownhost_addc Adds a known host to the collection of known hosts identified by the 'hosts' handle. host is a pointer the host name in plain text or hashed. If hashed, it must... libssh2_knownhost_check Checks a host and its associated key against the collection of known hosts, and returns info back about the (partially) matched entry. host is a pointer the... libssh2_knownhost_checkp Checks a host and its associated key against the collection of known hosts, and returns info back about the (partially) matched entry. host is a pointer the... libssh2_knownhost_readfile Reads a collection of known hosts from a specified file and adds them to the collection of known hosts. filename specifies which file to read type specifies... libssh2_knownhost_readline Tell libssh2 to read a buffer as it if is a line from a known hosts file. line points to the start of the line len is the length of the line in bytes type... libssh2_knownhost_writefile Writes all the known hosts to the specified file using the specified file format. filename specifies what filename to create type specifies what file type it... libssh2_knownhost_writeline Converts a single known host to a single line of output for storage, using the 'type' output format. known identifies which particular known host buffer points... libssh2_poll This function is deprecated. Do note use. We encourage users to instead use the poll(3) or select(3) functions to check for socket activity or when specific... libssh2_session_callback_set Sets a custom callback handler for a previously initialized session object. Callbacks are triggered by the receipt of special packets at the Transport layer. To... libssh2_session_flag 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. libssh2_session_get_blocking Returns 0 if the state of the session has previously be set to non-blocking and it returns 1 if the state was set to blocking. libssh2_session_get_timeout Returns the timeout (in milliseconds) for how long a blocking the libssh2 function calls may wait until they consider the situation an error and return... libssh2_session_hostkey Returns a pointer to the current host key, the value len points to will get the length of the key. The value type points to the type of hostkey which is one of... libssh2_session_init_ex myalloc - Custom allocator function. Refer to the section on Callbacks for implementing an allocator callback. Pass a value of NULL to use the default system... libssh2_session_set_timeout Set the timeout in milliseconds for how long a blocking the libssh2 function calls may wait until they consider the situation an error and return... libssh2_session_supported_algs session - An instance of initialized LIBSSH2_SESSION (the function will use its pointer to the memory allocation function). method_type - Method type. See .BR... libssh2_sftp_fsync This function causes the remote server to synchronize the file data and metadata to disk (like fsync(2)). For this to work requires firstname.lastname@example.org support on... libssh2_sftp_readdir_ex Reads a block of data from a LIBSSH2_SFTP_HANDLE and returns file entry information for the next entry, if any. handle - is the SFTP File Handle as returned by... libssh2_sftp_statvfs These functions provide statvfs(2)-like operations and require email@example.com and firstname.lastname@example.org extension support on the server. sftp - SFTP... libssh2_trace 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... libssh2_trace_sethandler libssh2_trace_sethandler installs a trace output handler for your application. By default, when tracing has been switched on via a call to libssh2_trace(), all... libssh2_userauth_publickey_frommemory This function allows to authenticate a session with a public key read from memory. It's only supported when libssh2 is backed by OpenSSL. session - Session... libssh2_version If required_version is lower than or equal to the version number of the libssh2 in use, the version number of libssh2 is returned as a pointer to a zero...