Add libssh2_channel_open_ex.3 and libssh2_channel_process_startup.3

docs/Makefile.am

@@ -1,4 +1,4 @@
-# $Id: Makefile.am,v 1.12 2007/06/13 20:09:15 jehousley Exp $
+# $Id: Makefile.am,v 1.13 2007/06/13 20:54:25 jehousley Exp $
 
 EXTRA_DIST = template.3
 
@@ -14,6 +14,8 @@ dist_man_MANS =
 	libssh2_channel_free.3 \
 	libssh2_channel_handle_extended_data.3 \
 	libssh2_channel_handle_extended_data2.3 \
+	libssh2_channel_open_ex.3 \
+	libssh2_channel_process_startup.3 \
 	libssh2_channel_read_ex.3 \
 	libssh2_channel_set_blocking.3 \
 	libssh2_channel_wait_eof.3

docs/libssh2_channel_open_ex.3

@@ -0,0 +1,56 @@
+.\" $Id: libssh2_channel_open_ex.3,v 1.1 2007/06/13 20:54:25 jehousley Exp $
+.\"
+.TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_open_ex - establish a generic session channel
+.SH 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);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init(3)
+
+\fIchannel_type\fP - Channel type to open. Typically one of session, 
+direct-tcpip, or tcpip-forward. The SSH2 protocol allowed for additional 
+types including local, custom channel types.
+
+\fIchannel_type_len\fP - Length of channel_type
+
+\fIwindow_size\fP - Maximum amount of unacknowledged data remote host is 
+allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST packet.
+
+\fIpacket_size\fP - Maximum number of bytes remote host is allowed to send 
+in a single SSH_MSG_CHANNEL_DATA or SSG_MSG_CHANNEL_EXTENDED_DATA packet.
+
+\fImessage\fP - Additional data as required by the selected channel_type.
+
+\fImessage_len\fP - Length of message parameter.
+
+Allocate a new channel for exchanging data with the server. This method is 
+typically called through its macroized form: 
+.BR libssh2_channel_open_session(3)
+or via 
+.BR libssh2_channel_direct_tcpip(3)
+or
+.BR libssh2_channel_forward_listen(3)
+
+.SH RETURN VALUE
+Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
+
+.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_FAILURE\fP - 
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
+
+.SH SEE ALSO
+Add related functions

docs/libssh2_channel_process_startup.3

@@ -0,0 +1,49 @@
+.\" $Id: libssh2_channel_process_startup.3,v 1.1 2007/06/13 20:54:25 jehousley Exp $
+.\"
+.TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_process_startup - request a shell on a channel
+.SH 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);
+
+int
+libssh2_channel_shell(LIBSSH2_CHANNEL *channel);
+
+int
+libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *message);
+
+int
+libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *message);
+
+.SH DESCRIPTION
+\fIchannel\fP - Active session channel instance.
+
+\fIrequest\fP - Type of process to startup. The SSH2 protocol currently 
+defines shell, exec, and subsystem as standard process services.
+
+\fIrequest_len\fP - Length of request parameter.
+
+\fImessage\fP - Request specific message data to include.
+
+\fImessage_len\fP - Length of message parameter.
+
+Initiate a request on a session type channel such as returned by 
+.BR libssh2_channel_open_session(3)
+
+.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)