diff --git a/docs/Makefile.am b/docs/Makefile.am index f10f592d..1403e069 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.13 2007/06/13 20:54:25 jehousley Exp $ +# $Id: Makefile.am,v 1.14 2007/06/13 21:07:59 jehousley Exp $ EXTRA_DIST = template.3 @@ -17,6 +17,8 @@ dist_man_MANS = libssh2_channel_open_ex.3 \ libssh2_channel_process_startup.3 \ libssh2_channel_read_ex.3 \ + libssh2_channel_request_pty_ex.3 \ + libssh2_channel_send_eof.3 \ libssh2_channel_set_blocking.3 \ libssh2_channel_wait_eof.3 libssh2_session_free.3 \ diff --git a/docs/libssh2_channel_request_pty_ex.3 b/docs/libssh2_channel_request_pty_ex.3 new file mode 100644 index 00000000..ba69a2df --- /dev/null +++ b/docs/libssh2_channel_request_pty_ex.3 @@ -0,0 +1,52 @@ +.\" $Id: libssh2_channel_request_pty_ex.3,v 1.1 2007/06/13 21:07:59 jehousley Exp $ +.\" +.TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_request_pty_ex - short function description +.SH SYNOPSIS +#include + +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); + +.SH DESCRIPTION +\fIchannel\fP - Previously opened channel instance such as returned by +.BR libssh2_channel_open_session(3) + +\fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...) + +\fIterm_len\fP - Length of term parameter + +\fImodes\fP - Terminal mode modifier values + +\fImodes_len\fP - Length of modes parameter. + +\fIwidth\fP - Width of pty in characters + +\fIheight\fP - Height of pty in characters + +\fIwidth_px\fP - Width of pty in pixels + +\fIheight_px\fP - Height of pty in pixels + +Request a PTY on an established channel. Note that this does not make sense +for all channel types and may be ignored by the server despite returning +success. + +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. + +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - + +.SH SEE ALSO +.BR libssh2_channel_open_session(3) diff --git a/docs/libssh2_channel_send_eof.3 b/docs/libssh2_channel_send_eof.3 new file mode 100644 index 00000000..60bc55e1 --- /dev/null +++ b/docs/libssh2_channel_send_eof.3 @@ -0,0 +1,26 @@ +.\" $Id: libssh2_channel_send_eof.3,v 1.1 2007/06/13 21:07:59 jehousley Exp $ +.\" +.TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_send_eof - send EOF to remote server +.SH SYNOPSIS +#include + +int +libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +Tell the remote host that no further data will be sent on the specified +channel. Processes typically interpret this as a closed stdin descriptor. + +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. + +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +.SH SEE ALSO +.BR libssh2_channel_wait_eof(3) +.BR libssh2_channel_eof(3)