Man Pages in
libssh2-1-dev
Carta.tech
Packages
libssh2-1-dev
164
Section 3:
Library calls
libssh2_agent_connect.3
Connect to an ssh-agent
libssh2_agent_disconnect.3
Close a connection to an ssh-agent
libssh2_agent_free.3
Free an ssh-agent handle
libssh2_agent_get_identity.3
Get a public key off the collection of public keys managed by ssh-agent
libssh2_agent_init.3
Init an ssh-agent handle
libssh2_agent_list_identities.3
Request an ssh-agent to list of public keys.
libssh2_agent_userauth.3
Authenticate a session with a public key, with the help of ssh-agent
libssh2_banner_set.3
Set the ssh prococol banner for the local client
libssh2_base64_decode.3
Decode a base64 encoded string
libssh2_channel_close.3
Close a channel
libssh2_channel_direct_tcpip.3
Convenience macro for libssh2_channel_direct_tcpip_ex(3) calls
libssh2_channel_direct_tcpip_ex.3
Tunnel a tcp connection through an ssh session
libssh2_channel_eof.3
Check a channel's eof status
libssh2_channel_exec.3
Convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_flush.3
Convenience macro for libssh2_channel_flush_ex(3) calls
libssh2_channel_flush_ex.3
Flush a channel
libssh2_channel_flush_stderr.3
Convenience macro for libssh2_channel_flush_ex(3) calls
libssh2_channel_forward_accept.3
Accept a queued connection
libssh2_channel_forward_cancel.3
Cancel a forwarded tcp port
libssh2_channel_forward_listen.3
Convenience macro for libssh2_channel_forward_listen_ex(3) calls
libssh2_channel_forward_listen_ex.3
Listen to inbound connections
libssh2_channel_free.3
Free all resources associated with a channel
libssh2_channel_get_exit_signal.3
Get the remote exit signal
libssh2_channel_get_exit_status.3
Get the remote exit code
libssh2_channel_handle_extended_data.3
Set extended data handling mode
libssh2_channel_handle_extended_data2.3
Set extended data handling mode
libssh2_channel_ignore_extended_data.3
Convenience macro for libssh2_channel_handle_extended_data(3) calls
libssh2_channel_open_ex.3
Establish a generic session channel
libssh2_channel_open_session.3
Convenience macro for libssh2_channel_open_ex(3) calls
libssh2_channel_process_startup.3
Request a shell on a channel
libssh2_channel_read.3
Convenience macro for libssh2_channel_read_ex(3) calls
libssh2_channel_read_ex.3
Read data from a channel stream
libssh2_channel_read_stderr.3
Convenience macro for libssh2_channel_read_ex(3) calls
libssh2_channel_receive_window_adjust.3
Adjust the channel window
libssh2_channel_receive_window_adjust2.3
Adjust the channel window
libssh2_channel_request_pty.3
Convenience macro for libssh2_channel_request_pty_ex(3) calls
libssh2_channel_request_pty_ex.3
Short function description
libssh2_channel_request_pty_size.3
Convenience macro for libssh2_channel_request_pty_size_ex(3) calls
libssh2_channel_request_pty_size_ex.3
Todo
libssh2_channel_send_eof.3
Send eof to remote server
libssh2_channel_set_blocking.3
Set or clear blocking mode on channel
libssh2_channel_setenv.3
Convenience macro for libssh2_channel_setenv_ex(3) calls
libssh2_channel_setenv_ex.3
Set an environment variable on the channel
libssh2_channel_shell.3
Convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_subsystem.3
Convenience macro for libssh2_channel_process_startup(3) calls
libssh2_channel_wait_closed.3
Wait for the remote to close the channel
libssh2_channel_wait_eof.3
Wait for the remote to reply to an eof request
libssh2_channel_window_read.3
Convenience macro for libssh2_channel_window_read_ex(3) calls
libssh2_channel_window_read_ex.3
Check the status of the read window
libssh2_channel_window_write.3
Convenience macro for libssh2_channel_window_write_ex(3) calls
libssh2_channel_window_write_ex.3
Check the status of the write window
libssh2_channel_write.3
Convenience macro for libssh2_channel_write_ex(3)
libssh2_channel_write_ex.3
Write data to a channel stream blocking
libssh2_channel_write_stderr.3
Convenience macro for libssh2_channel_write_ex(3)
libssh2_channel_x11_req.3
Convenience macro for libssh2_channel_x11_req_ex(3) calls
libssh2_channel_x11_req_ex.3
Request an x11 forwarding channel
libssh2_exit.3
Global library deinitialization
libssh2_free.3
Deallocate libssh2 memory
libssh2_hostkey_hash.3
Return a hash of the remote host's key
libssh2_init.3
Global library initialization
libssh2_keepalive_config.3
Short function description
libssh2_keepalive_send.3
Short function description
libssh2_knownhost_add.3
Add a known host
libssh2_knownhost_addc.3
Add a known host
libssh2_knownhost_check.3
Check a host+key against the list of known hosts
libssh2_knownhost_checkp.3
Check a host+key against the list of known hosts
libssh2_knownhost_del.3
Delete a known host entry
libssh2_knownhost_free.3
Free a collection of known hosts
libssh2_knownhost_get.3
Get a known host off the collection of known hosts
libssh2_knownhost_init.3
Init a collection of known hosts
libssh2_knownhost_readfile.3
Parse a file of known hosts
libssh2_knownhost_readline.3
Read a known host line
libssh2_knownhost_writefile.3
Write a collection of known hosts to a file
libssh2_knownhost_writeline.3
Convert a known host to a line for storage
libssh2_poll.3
Poll for activity on a socket, channel or listener
libssh2_poll_channel_read.3
Check if data is available
libssh2_publickey_add.3
Convenience macro for libssh2_publickey_add_ex(3) calls
libssh2_publickey_add_ex.3
Add a public key entry
libssh2_publickey_init.3
Todo
libssh2_publickey_list_fetch.3
Todo
libssh2_publickey_list_free.3
Todo
libssh2_publickey_remove.3
Convenience macro for libssh2_publickey_remove_ex(3) calls
libssh2_publickey_remove_ex.3
Todo
libssh2_publickey_shutdown.3
Todo
libssh2_scp_recv.3
Request a remote file via scp
libssh2_scp_send.3
Convenience macro for libssh2_scp_send_ex(3) calls
libssh2_scp_send64.3
Send a file via scp
libssh2_scp_send_ex.3
Send a file via scp
libssh2_session_abstract.3
Return a pointer to a session's abstract pointer
libssh2_session_banner_get.3
Get the remote banner
libssh2_session_banner_set.3
Set the ssh prococol banner for the local client
libssh2_session_block_directions.3
Get directions to wait for
libssh2_session_callback_set.3
Set a callback function
libssh2_session_disconnect.3
Convenience macro for libssh2_session_disconnect_ex(3) calls
libssh2_session_disconnect_ex.3
Terminate transport layer
libssh2_session_flag.3
Todo
libssh2_session_free.3
Frees resources associated with a session instance
libssh2_session_get_blocking.3
Todo
libssh2_session_get_timeout.3
Get the timeout for blocking functions
libssh2_session_hostkey.3
Get the remote key
libssh2_session_init.3
Convenience macro for libssh2_session_init_ex(3) calls
libssh2_session_init_ex.3
Initializes an ssh session object
libssh2_session_last_errno.3
Get the most recent error number
libssh2_session_last_error.3
Get the most recent error
libssh2_session_method_pref.3
Set preferred key exchange method
libssh2_session_methods.3
Return the currently active algorithms
libssh2_session_set_blocking.3
Set or clear blocking mode on session
libssh2_session_set_timeout.3
Set timeout for blocking functions
libssh2_session_startup.3
Begin transport layer
libssh2_session_supported_algs.3
Get list of supported algorithms
libssh2_sftp_close.3
Convenience macro for libssh2_sftp_close_handle(3) calls
libssh2_sftp_close_handle.3
Close filehandle
libssh2_sftp_closedir.3
Convenience macro for libssh2_sftp_close_handle(3) calls
libssh2_sftp_fsetstat.3
Convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_fstat.3
Convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_fstat_ex.3
Get or set attributes on an sftp file handle
libssh2_sftp_fstatvfs.3
Get file system statistics
libssh2_sftp_get_channel.3
Return the channel of sftp
libssh2_sftp_init.3
Open sftp channel for the given ssh session.
libssh2_sftp_last_error.3
Return the last sftp-specific error code
libssh2_sftp_lstat.3
Convenience macro for libssh2_sftp_stat_ex(3) calls
libssh2_sftp_mkdir.3
Convenience macro for libssh2_sftp_mkdir_ex(3) calls
libssh2_sftp_mkdir_ex.3
Create a directory on the remote file system
libssh2_sftp_open.3
Convenience macro for libssh2_sftp_open_ex(3) calls
libssh2_sftp_open_ex.3
Open filehandle for file on sftp.
libssh2_sftp_opendir.3
Convenience macro for libssh2_sftp_open_ex(3) calls
libssh2_sftp_read.3
Read data from an sftp handle
libssh2_sftp_readdir.3
Convenience macro for libssh2_sftp_readdir_ex(3) calls
libssh2_sftp_readdir_ex.3
Read directory data from an sftp handle
libssh2_sftp_readlink.3
Convenience macro for libssh2_sftp_symlink_ex(3)
libssh2_sftp_realpath.3
Convenience macro for libssh2_sftp_symlink_ex(3)
libssh2_sftp_rename.3
Convenience macro for libssh2_sftp_rename_ex(3) calls
libssh2_sftp_rename_ex.3
Rename an sftp file
libssh2_sftp_rewind.3
Convenience macro for libssh2_sftp_seek64(3) calls
libssh2_sftp_rmdir.3
Convenience macro for libssh2_sftp_rmdir_ex(3)
libssh2_sftp_rmdir_ex.3
Remove an sftp directory
libssh2_sftp_seek.3
Set the read/write position indicator within a file
libssh2_sftp_seek64.3
Set the read/write position within a file
libssh2_sftp_setstat.3
Convenience macro for libssh2_sftp_stat_ex(3) calls
libssh2_sftp_shutdown.3
Shut down an sftp session
libssh2_sftp_stat.3
Convenience macro for libssh2_sftp_fstat_ex(3) calls
libssh2_sftp_stat_ex.3
Get status about an sftp file
libssh2_sftp_statvfs.3
Get file system statistics
libssh2_sftp_symlink.3
Convenience macro for libssh2_sftp_symlink_ex(3)
libssh2_sftp_symlink_ex.3
Read or set a symbolic link
libssh2_sftp_tell.3
Get the current read/write position indicator for a file
libssh2_sftp_tell64.3
Get the current read/write position indicator for a file
libssh2_sftp_unlink.3
Convenience macro for libssh2_sftp_unlink_ex(3) calls
libssh2_sftp_unlink_ex.3
Unlink an sftp file
libssh2_sftp_write.3
Write sftp data
libssh2_trace.3
Enable debug info from inside libssh2
libssh2_trace_sethandler.3
Set a trace output handler
libssh2_userauth_authenticated.3
Return authentication status
libssh2_userauth_hostbased_fromfile.3
Convenience macro for libssh2_userauth_hostbased_fromfile_ex(3) calls
libssh2_userauth_hostbased_fromfile_ex.3
Todo
libssh2_userauth_keyboard_interactive.3
Convenience macro for libssh2_userauth_keyboard_interactive_ex(3) calls
libssh2_userauth_keyboard_interactive_ex.3
Authenticate a session using keyboard-interactive authentication
libssh2_userauth_list.3
List supported authentication methods
libssh2_userauth_password.3
Convenience macro for libssh2_userauth_password_ex(3) calls
libssh2_userauth_password_ex.3
Authenticate a session with username and password
libssh2_userauth_publickey.3
Authenticate using a callback function
libssh2_userauth_publickey_fromfile.3
Convenience macro for libssh2_userauth_publickey_fromfile_ex(3) calls
libssh2_userauth_publickey_fromfile_ex.3
Authenticate a session with a public key, read from a file
libssh2_version.3
Return the libssh2 version number