Linux Manuals session 3

libssh2_channel_setenv_ex – set an environment variable on the channel Synopsis#include <libssh2.h> int libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, unsigned int varname_len, const char *value, unsigned int value_len); int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *value); Descriptionchannel – Previously opened channel instance such as returned by libssh2_channel_open_ex(3) varname – Name of environment variable to set on the remote…

libssh2_channel_setenv – convenience macro for libssh2_channel_setenv_ex(3) calls Synopsis#include <libssh2.h> int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, const char *varname, const char *value); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_setenv_ex(3). Return ValueSee libssh2_channel_setenv_ex(3) ErrorsSee libssh2_channel_setenv_ex(3) See Alsolibssh2_channel_setenv_ex(3)

libssh2_channel_set_blocking – set or clear blocking mode on channel Synopsis#include <libssh2.h> void libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking); Descriptionchannel – 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. Currently this is just a short cut call to libssh2_session_set_blocking(3)…

libssh2_channel_send_eof – send EOF to remote server Synopsis#include <libssh2.h> int libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); DescriptionTell the remote host that no further data will be sent on the specified channel. Processes typically interpret this as a closed stdin descriptor. Return ValueReturn 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN…

libssh2_channel_request_pty_size_ex – TODO SynopsisDescriptionReturn ValueErrorsSee Also

libssh2_channel_request_pty_size – convenience macro for libssh2_channel_request_pty_size_ex(3) calls Synopsis#include <libssh2.h> int libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel, int width, int height); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_request_pty_size_ex(3). Return ValueSee libssh2_channel_request_pty_size_ex(3) ErrorsSee libssh2_channel_request_pty_size_ex(3) See Alsolibssh2_channel_request_pty_size_ex(3)

libssh2_channel_request_pty_ex – short function description Synopsis#include <libssh2.h> int libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, unsigned int term_len, const char *modes, unsigned int modes_len, int width, int height, int width_px, int height_px); int libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term); Descriptionchannel – Previously opened channel instance such as returned by libssh2_channel_open_ex(3) term – Terminal emulation (e.g. vt102, ansi, etc…) term_len…

libssh2_channel_request_pty – convenience macro for libssh2_channel_request_pty_ex(3) calls Synopsis#include <libssh2.h> int libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_request_pty_ex(3). Return ValueSee libssh2_channel_request_pty_ex(3) ErrorsSee libssh2_channel_request_pty_ex(3) See Alsolibssh2_channel_request_pty_ex(3)

libssh2_channel_receive_window_adjust2 – adjust the channel window Synopsis#include <libssh2.h> int libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel,                                  unsigned long adjustment,                                  unsigned char force,                                  unsigned int *window); DescriptionAdjust 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 amount will be queued for a later packet. This…

libssh2_channel_receive_window_adjust – adjust the channel window Synopsis#include <libssh2.h> unsigned long libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel,                                 unsigned long adjustment,                                 unsigned char force); DescriptionThis function is deprecated in 1.1. Use libssh2_channel_receive_window_adjust2(3)! 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 amount will…

libssh2_channel_read_stderr – convenience macro for libssh2_channel_read_ex(3) calls Synopsis#include <libssh2.h> ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_read_ex(3). Return ValueSee libssh2_channel_read_ex(3) ErrorsSee libssh2_channel_read_ex(3) See Alsolibssh2_channel_read_ex(3)

libssh2_channel_read_ex – read data from a channel stream Synopsis#include <libssh2.h> ssize_t libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen); ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); DescriptionAttempt to read data from an active channel stream. All channel streams have one standard I/O substream (stream_id == 0), and may…

libssh2_channel_read – convenience macro for libssh2_channel_read_ex(3) calls Synopsis#include <libssh2.h> ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_read_ex(3). Return ValueSee libssh2_channel_read_ex(3) ErrorsSee libssh2_channel_read_ex(3) See Alsolibssh2_channel_read_ex(3)

libssh2_channel_process_startup – request a shell on a channel Synopsis#include <libssh2.h> int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, const char *request, unsigned int request_len, const char *message, unsigned int message_len);Descriptionchannel – Active session channel instance. request – Type of process to startup. The SSH2 protocol currently defines shell, exec, and subsystem as standard process services. request_len – Length of request…

libssh2_channel_open_session – convenience macro for libssh2_channel_open_ex(3) calls Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_channel_open_session(LIBSSH2_SESSION *session); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_open_ex(3). Return ValueSee libssh2_channel_open_ex(3) ErrorsSee libssh2_channel_open_ex(3) See Alsolibssh2_channel_open_ex(3)

libssh2_channel_open_ex – establish a generic session channel Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, unsigned int channel_type_len, unsigned int window_size, unsigned int packet_size, const char *message, unsigned int message_len); LIBSSH2_CHANNEL * libssh2_channel_open_session(session); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) channel_type – Channel type to open. Typically one of session, direct-tcpip, or tcpip-forward….

libssh2_channel_ignore_extended_data – convenience macro for libssh2_channel_handle_extended_data(3) calls Synopsis#include <libssh2.h> libssh2_channel_ignore_extended_data(arguments) DescriptionThis function is deprecated. Use the libssh2_channel_handle_extended_data2(3) function instead! This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_handle_extended_data(3). Return ValueSee libssh2_channel_handle_extended_data(3) ErrorsSee libssh2_channel_handle_extended_data(3) See Alsolibssh2_channel_handle_extended_data(3)

libssh2_channel_handle_extended_data2 – set extended data handling mode Synopsis#include <libssh2.h> int libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int ignore_mode); Descriptionchannel – Active channel stream to change extended data handling on. ignore_mode – One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL: Queue extended data for eventual reading LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE: Treat extended data and ordinary data the same. Merge all substreams such that calls…

libssh2_channel_handle_extended_data – set extended data handling mode Synopsis#include <libssh2.h> void libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode); DescriptionThis function is deprecated. Use the libssh2_channel_handle_extended_data2(3) function instead! channel – Active channel stream to change extended data handling on. ignore_mode – One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL: Queue extended data for eventual reading LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE: Treat extended data and ordinary…

libssh2_channel_get_exit_status – get the remote exit code Synopsis#include <libssh2.h> int libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel) Descriptionchannel – Closed channel stream to retreive exit status from. Returns the exit code raised by the process running on the remote host at the other end of the named channel. Note that the exit status may not be available if the remote…