📦 libssh2-doc

186 pages

L

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_get_identity_path(3)gets the custom ssh-agent socket path✨
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_set_identity_path(3)set an ssh-agent socket path on disk✨
libssh2_agent_sign(3)sign data, with the help of ssh-agent✨
libssh2_agent_userauth(3)authenticate a session with a public key, with the help of ssh-agent✨
libssh2_banner_set(3)set the SSH protocol banner for the local client✨
libssh2_base64_decode(3)decode a base64 encoded string✨
libssh2_channel_close(3)close a channel✨
libssh2_channel_direct_streamlocal_ex(3)Tunnel a UNIX socket connection through an SSH session✨
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_auth_agent(3)request agent forwarding for a session✨
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_signal_ex(3)Send a signal to process previously opened on channel.✨
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_crypto_engine(3)retrieve used crypto engine✨
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_recv2(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 protocol 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_callback_set2(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)evaluate blocking mode on session✨
libssh2_session_get_read_timeout(3)get the timeout for packet read functions✨
libssh2_session_get_timeout(3)get the timeout for blocking functions✨
libssh2_session_handshake(3)perform the SSH handshake✨
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_last_error(3)sets the internal error state✨
libssh2_session_set_read_timeout(3)set timeout for packet read functions✨
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_fsync(3)synchronize file to disk✨
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_open_ex_r(3)open filehandle for file on SFTP.✨
libssh2_sftp_open_r(3)convenience macro for libssh2_sftp_open_ex_r(3) calls✨
libssh2_sftp_opendir(3)convenience macro for libssh2_sftp_open_ex(3) calls✨
libssh2_sftp_posix_rename(3)convenience macro for libssh2_sftp_posix_rename_ex(3) calls✨
libssh2_sftp_posix_rename_ex(3)rename an SFTP file using POSIX semantics✨
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_sign_sk(3)Create a signature from a FIDO2 authenticator.✨
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_banner(3)get the server's userauth banner message✨
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_userauth_publickey_frommemory(3)authenticate a session with a public key, read from memory✨
libssh2_userauth_publickey_sk(3)authenticate a session with a FIDO2 authenticator✨
libssh2_version(3)return the libssh2 version number✨