Package libssh2-docs

Documentation for libssh2

http://www.libssh2.org/

The libssh2-docs package contains man pages and examples for
developing applications that use libssh2.

Library Functions
Library Function Description
libssh2_agent_connect connect to an ssh-agent
libssh2_agent_disconnect close a connection to an ssh-agent
libssh2_agent_free free an ssh-agent handle
libssh2_agent_get_identity get a public key off the collection of public keys managed by ssh-agent
libssh2_agent_init init an ssh-agent handle
libssh2_agent_list_identities request an ssh-agent to list of public keys.
libssh2_agent_userauth authenticate a session with a public key, with the help of ssh-agent
libssh2_banner_set set the SSH protocol banner for the local client
libssh2_base64_decode decode a base64 encoded string
libssh2_channel_close close a channel
libssh2_channel_direct_tcpip convenience macro for libssh2_channel_direct_tcpip_ex(3) calls
libssh2_channel_direct_tcpip_ex Tunnel a TCP connection through an SSH session
libssh2_channel_eof check a channel's EOF status
libssh2_channel_exec convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_flush convenience macro for libssh2_channel_flush_ex(3) calls
libssh2_channel_flush_ex flush a channel
libssh2_channel_flush_stderr convenience macro for libssh2_channel_flush_ex(3) calls
libssh2_channel_forward_accept accept a queued connection
libssh2_channel_forward_cancel cancel a forwarded TCP port
libssh2_channel_forward_listen convenience macro for libssh2_channel_forward_listen_ex(3) calls
libssh2_channel_forward_listen_ex listen to inbound connections
libssh2_channel_free free all resources associated with a channel
libssh2_channel_get_exit_signal get the remote exit signal
libssh2_channel_get_exit_status get the remote exit code
libssh2_channel_handle_extended_data set extended data handling mode
libssh2_channel_handle_extended_data2 set extended data handling mode
libssh2_channel_ignore_extended_data convenience macro for libssh2_channel_handle_extended_data(3) calls
libssh2_channel_open_ex establish a generic session channel
libssh2_channel_open_session convenience macro for libssh2_channel_open_ex(3) calls
libssh2_channel_process_startup request a shell on a channel
libssh2_channel_read convenience macro for libssh2_channel_read_ex(3) calls
libssh2_channel_read_ex read data from a channel stream
libssh2_channel_read_stderr convenience macro for libssh2_channel_read_ex(3) calls
libssh2_channel_receive_window_adjust adjust the channel window
libssh2_channel_receive_window_adjust2 adjust the channel window
libssh2_channel_request_pty convenience macro for libssh2_channel_request_pty_ex(3) calls
libssh2_channel_request_pty_ex short function description
libssh2_channel_request_pty_size convenience macro for libssh2_channel_request_pty_size_ex(3) calls
libssh2_channel_request_pty_size_ex TODO
libssh2_channel_send_eof send EOF to remote server
libssh2_channel_set_blocking set or clear blocking mode on channel
libssh2_channel_setenv convenience macro for libssh2_channel_setenv_ex(3) calls
libssh2_channel_setenv_ex set an environment variable on the channel
libssh2_channel_shell convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_subsystem convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_wait_closed wait for the remote to close the channel
libssh2_channel_wait_eof wait for the remote to reply to an EOF request
libssh2_channel_window_read convenience macro for libssh2_channel_window_read_ex(3) calls
libssh2_channel_window_read_ex Check the status of the read window
libssh2_channel_window_write convenience macro for libssh2_channel_window_write_ex(3) calls
libssh2_channel_window_write_ex Check the status of the write window
libssh2_channel_write convenience macro for libssh2_channel_write_ex(3)
libssh2_channel_write_ex write data to a channel stream blocking
libssh2_channel_write_stderr convenience macro for libssh2_channel_write_ex(3)
libssh2_channel_x11_req convenience macro for libssh2_channel_x11_req_ex(3) calls
libssh2_channel_x11_req_ex request an X11 forwarding channel
libssh2_exit global library deinitialization
libssh2_free deallocate libssh2 memory
libssh2_hostkey_hash return a hash of the remote host's key
libssh2_init global library initialization
libssh2_keepalive_config short function description
libssh2_keepalive_send short function description
libssh2_knownhost_add add a known host
libssh2_knownhost_addc add a known host
libssh2_knownhost_check check a host+key against the list of known hosts
libssh2_knownhost_checkp check a host+key against the list of known hosts
libssh2_knownhost_del delete a known host entry
libssh2_knownhost_free free a collection of known hosts
libssh2_knownhost_get get a known host off the collection of known hosts
libssh2_knownhost_init init a collection of known hosts
libssh2_knownhost_readfile parse a file of known hosts
libssh2_knownhost_readline read a known host line
libssh2_knownhost_writefile write a collection of known hosts to a file
libssh2_knownhost_writeline convert a known host to a line for storage
libssh2_poll poll for activity on a socket, channel or listener
libssh2_poll_channel_read check if data is available
libssh2_publickey_add convenience macro for libssh2_publickey_add_ex(3) calls
libssh2_publickey_add_ex Add a public key entry
libssh2_publickey_init TODO
libssh2_publickey_list_fetch TODO
libssh2_publickey_list_free TODO
libssh2_publickey_remove convenience macro for libssh2_publickey_remove_ex(3) calls
libssh2_publickey_remove_ex TODO
libssh2_publickey_shutdown TODO
libssh2_scp_recv request a remote file via SCP
libssh2_scp_recv2 request a remote file via SCP
libssh2_scp_send convenience macro for libssh2_scp_send_ex(3) calls
libssh2_scp_send64 Send a file via SCP
libssh2_scp_send_ex Send a file via SCP
libssh2_session_abstract return a pointer to a session's abstract pointer
libssh2_session_banner_get get the remote banner
libssh2_session_banner_set set the SSH protocol banner for the local client
libssh2_session_block_directions get directions to wait for
libssh2_session_callback_set set a callback function
libssh2_session_disconnect convenience macro for libssh2_session_disconnect_ex(3) calls
libssh2_session_disconnect_ex terminate transport layer
libssh2_session_flag TODO
libssh2_session_free frees resources associated with a session instance
libssh2_session_get_blocking TODO
libssh2_session_get_timeout get the timeout for blocking functions
libssh2_session_handshake perform the SSH handshake
libssh2_session_hostkey get the remote key
libssh2_session_init convenience macro for libssh2_session_init_ex(3) calls
libssh2_session_init_ex initializes an SSH session object
libssh2_session_last_errno get the most recent error number
libssh2_session_last_error get the most recent error
libssh2_session_method_pref set preferred key exchange method
libssh2_session_methods return the currently active algorithms
libssh2_session_set_blocking set or clear blocking mode on session
libssh2_session_set_last_error sets the internal error state
libssh2_session_set_timeout set timeout for blocking functions
libssh2_session_startup begin transport layer
libssh2_session_supported_algs get list of supported algorithms
libssh2_sftp_close convenience macro for libssh2_sftp_close_handle(3) calls
libssh2_sftp_closedir convenience macro for libssh2_sftp_close_handle(3) calls
libssh2_sftp_close_handle close filehandle
libssh2_sftp_fsetstat convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_fstat convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_fstat_ex get or set attributes on an SFTP file handle
libssh2_sftp_fsync synchronize file to disk
libssh2_sftp_get_channel return the channel of sftp
libssh2_sftp_init open SFTP channel for the given SSH session.
libssh2_sftp_last_error return the last SFTP-specific error code
libssh2_sftp_lstat convenience macro for libssh2_sftp_stat_ex(3) calls
libssh2_sftp_mkdir convenience macro for libssh2_sftp_mkdir_ex(3) calls
libssh2_sftp_mkdir_ex create a directory on the remote file system
libssh2_sftp_open convenience macro for libssh2_sftp_open_ex(3) calls
libssh2_sftp_opendir convenience macro for libssh2_sftp_open_ex(3) calls
libssh2_sftp_open_ex open filehandle for file on SFTP.
libssh2_sftp_read read data from an SFTP handle
libssh2_sftp_readdir convenience macro for libssh2_sftp_readdir_ex(3) calls
libssh2_sftp_readdir_ex read directory data from an SFTP handle
libssh2_sftp_readlink convenience macro for libssh2_sftp_symlink_ex(3)
libssh2_sftp_realpath convenience macro for libssh2_sftp_symlink_ex(3)
libssh2_sftp_rename convenience macro for libssh2_sftp_rename_ex(3) calls
libssh2_sftp_rename_ex rename an SFTP file
libssh2_sftp_rewind convenience macro for libssh2_sftp_seek64(3) calls
libssh2_sftp_rmdir convenience macro for libssh2_sftp_rmdir_ex(3)
libssh2_sftp_rmdir_ex remove an SFTP directory
libssh2_sftp_seek set the read/write position indicator within a file
libssh2_sftp_seek64 set the read/write position within a file
libssh2_sftp_setstat convenience macro for libssh2_sftp_stat_ex(3) calls
libssh2_sftp_shutdown shut down an SFTP session
libssh2_sftp_stat convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_stat_ex get status about an SFTP file
libssh2_sftp_statvfs get file system statistics
libssh2_sftp_symlink convenience macro for libssh2_sftp_symlink_ex(3)
libssh2_sftp_symlink_ex read or set a symbolic link
libssh2_sftp_tell get the current read/write position indicator for a file
libssh2_sftp_tell64 get the current read/write position indicator for a file
libssh2_sftp_unlink convenience macro for libssh2_sftp_unlink_ex(3) calls
libssh2_sftp_unlink_ex unlink an SFTP file
libssh2_sftp_write write SFTP data
libssh2_trace enable debug info from inside libssh2
libssh2_trace_sethandler set a trace output handler
libssh2_userauth_authenticated return authentication status
libssh2_userauth_hostbased_fromfile convenience macro for libssh2_userauth_hostbased_fromfile_ex(3) calls
libssh2_userauth_hostbased_fromfile_ex TODO
libssh2_userauth_keyboard_interactive convenience macro for libssh2_userauth_keyboard_interactive_ex(3) calls
libssh2_userauth_keyboard_interactive_ex authenticate a session using keyboard-interactive authentication
libssh2_userauth_list list supported authentication methods
libssh2_userauth_password convenience macro for libssh2_userauth_password_ex(3) calls
libssh2_userauth_password_ex authenticate a session with username and password
libssh2_userauth_publickey authenticate using a callback function
libssh2_userauth_publickey_fromfile convenience macro for libssh2_userauth_publickey_fromfile_ex(3) calls
libssh2_userauth_publickey_fromfile_ex authenticate a session with a public key, read from a file
libssh2_userauth_publickey_frommemory authenticate a session with a public key, read from memory
libssh2_version return the libssh2 version number