The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
libssh2_scp_send_ex – Send a file via SCP Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size, long mtime, long atime);DescriptionThis function has been deemed deprecated since libssh2 1.2.6. See libssh2_scp_send64(3). session – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer to. That is…
libssh2_scp_send64 – Send a file via SCP Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode, libssh2_uint64_t size, time_t mtime, time_t atime);Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer to. That is the remote file name. mode – File access mode to create…
libssh2_scp_send – convenience macro for libssh2_scp_send_ex(3) calls Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, int mode, size_t size); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_scp_send_ex(3). Return ValueSee libssh2_scp_send_ex(3) ErrorsSee libssh2_scp_send_ex(3) See Alsolibssh2_scp_send_ex(3)
libssh2_scp_recv – request a remote file via SCP Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer. That is the remote file name. sb – Populated with remote file’s size, mode, mtime, and atime…
libssh2_publickey_shutdown – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_list_remove_ex – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_remove – convenience macro for libssh2_publickey_remove_ex(3) calls Synopsis#include <libssh2.h> int libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, unsigned long name_len, const unsigned char *blob, unsigned long blob_len); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_publickey_remove_ex(3). Return ValueSee libssh2_publickey_remove_ex(3) ErrorsSee libssh2_publickey_remove_ex(3) See Alsolibssh2_publickey_remove_ex(3)
libssh2_publickey_list_free – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_list_fetch – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_init – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_add_ex – Add a public key entry Synopsis#include <libssh2.h> int libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, unsigned long name_len, const unsigned char *blob, unsigned long blob_len, char overwrite, unsigned long num_attrs, const libssh2_publickey_attribute attrs[]) DescriptionTBD Return ValueReturns 0 on success, negative on failure. ErrorsLIBSSH2_ERROR_BAD_USE LIBSSH2_ERROR_ALLOC, LIBSSH2_ERROR_EAGAIN LIBSSH2_ERROR_SOCKET_SEND, LIBSSH2_ERROR_SOCKET_TIMEOUT, LIBSSH2_ERROR_PUBLICKEY_PROTOCOL, See Also
libssh2_publickey_add – convenience macro for libssh2_publickey_add_ex(3) calls Synopsis#include <libssh2.h> int libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, const unsigned char *blob, unsigned long blob_len, char overwrite, unsigned long num_attrs, const libssh2_publickey_attribute attrs[]); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_publickey_add_ex(3). Return ValueSee libssh2_publickey_add_ex(3) ErrorsSee libssh2_publickey_add_ex(3) See…
libssh2_poll_channel_read – check if data is available Synopsis#include <libssh2.h> int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended); DescriptionThis function is deprecated. Do note use. libssh2_poll_channel_read(3) checks to see if data is available in the channel‘s read buffer. No attempt is made with this method to see if packets are available to be processed. For full polling support, use…
libssh2_poll – poll for activity on a socket, channel or listener Synopsis#include <libssh2.h> int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout); DescriptionThis 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 sockets are ready to get recevied from or…
libssh2_knownhost_writeline – convert a known host to a line for storage Synopsis#include <libssh2.h> libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts, struct libssh2_knownhost *known, char *buffer, size_t buflen, size_t *outlen, int type); DescriptionConverts 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 to an allocated buffer buflen is…
libssh2_knownhost_writefile – write a collection of known hosts to a file Synopsis#include <libssh2.h> int libssh2_knownhost_writefile(LIBSSH2_KNOWNHOSTS *hosts, const char *filename, int type); DescriptionWrites 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 is, and LIBSSH2_KNOWNHOST_FILE_OPENSSH is the only currently supported format….
libssh2_knownhost_readline – read a known host line Synopsis#include <libssh2.h> int libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts, const char *line, size_t len, int type): DescriptionTell 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 specifies what…
libssh2_knownhost_readfile – parse a file of known hosts Synopsis#include <libssh2.h> int libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts, const char *filename, int type); DescriptionReads 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 what file type it is, and LIBSSH2_KNOWNHOST_FILE_OPENSSH is the only currently…
libssh2_knownhost_init – init a collection of known hosts Synopsis#include <libssh2.h> LIBSSH2_KNOWNHOSTS *libssh2_knownhost_init(LIBSSH2_SESSION *session); DescriptionInit a collection of known hosts for this session. Returns the handle to an internal representation of a known host collection. Call libssh2_knownhost_free(3) to free the collection again after you’re doing using it. Return ValueReturns a handle pointer or NULL if something…
libssh2_knownhost_get – get a known host off the collection of known hosts Synopsis#include <libssh2.h> int libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts, struct libssh2_knownhost **store, struct libssh2_knownhost *prev): Descriptionlibssh2_knownhost_get(3) allows an application to iterate over all known hosts in the collection. store should point to a pointer that gets filled in to point to the known host data. prev is a pointer…