diff --git a/docs/libssh2_channel_forward_accept.3 b/docs/libssh2_channel_forward_accept.3 new file mode 100644 index 0000000..d1d998a --- /dev/null +++ b/docs/libssh2_channel_forward_accept.3 @@ -0,0 +1,16 @@ +.\" $Id: libssh2_channel_forward_accept.3,v 1.1 2006/12/21 14:09:12 bagder Exp $ +.\" +.TH libssh2_channel_forward_accept 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_forward_accept - accept a queued connection +.SH SYNOPSIS +.B #include + +.B LIBSSH2_CHANNEL * libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener); +.SH DESCRIPTION +\fIlistener\fP is a forwarding listener instance as returned by +\fBlibssh2_channel_forward_listen(3)\fP. +.SH RETURN VALUE +A newly allocated channel instance or NULL on failure. +.SH "SEE ALSO" +.BI libssh2_channel_forward_listen(3) diff --git a/docs/libssh2_channel_forward_listen_ex.3 b/docs/libssh2_channel_forward_listen_ex.3 new file mode 100644 index 0000000..99bd371 --- /dev/null +++ b/docs/libssh2_channel_forward_listen_ex.3 @@ -0,0 +1,40 @@ +.\" $Id: libssh2_channel_forward_listen_ex.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ +.\" +.TH libssh2_channel_forward_listen_ex 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_forward_listen_ex - listen to inbound connections +.SH SYNOPSIS +#include + +LIBSSH2_LISTENER * libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, + char *host, + int port, + int *bound_port, + int queue_maxsize); + +LIBSSH2_LISTENER * libssh2_channel_forward_listen(LIBSSH2_SESSION *session, + int port); +.SH DESCRIPTION +Instruct the remote SSH server to begin listening for inbound TCP/IP +connections. New connections will be queued by the library until accepted by +\fIlibssh2_channel_forward_accept(3)\fP. + +\fIsession\fP - instance as returned by libssh2_session_init(). + +\fIhost\fP - specific address to bind to on the remote host. Binding to +0.0.0.0 (default when NULL is passed) will bind to all available addresses. + +\fIport\fP - port to bind to on the remote host. When 0 is passed, the remote +host will select the first available dynamic port. + +\fIbound_port\fP - Populated with the actual port bound on the remote +host. Useful when requesting dynamic port numbers. + +\fIqueue_maxsize\fP - Maximum nuber of pending connections to queue before +rejecting further attempts. + +\fIlibssh2_channel_forward_listen(3)\fP is a macro. +.SH RETURN VALUE +A newly allocated LIBSSH2_LISTENER instance or NULL on failure. +.SH "SEE ALSO" +.BI libssh2_channel_forward_accept(3) diff --git a/docs/libssh2_channel_read_ex.3 b/docs/libssh2_channel_read_ex.3 new file mode 100644 index 0000000..c98536b --- /dev/null +++ b/docs/libssh2_channel_read_ex.3 @@ -0,0 +1,36 @@ +.\" $Id: libssh2_channel_read_ex.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ +.\" +.TH libssh2_channel_read_ex 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_read_ex - read data from a channel stream +.SH SYNOPSIS +#include + +int libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, + char *buf, size_t buflen); + +int libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, + size_t buflen); + +int libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, + size_t buflen); +.SH DESCRIPTION +Attempt to read data from an active channel stream. All channel streams have +one standard I/O substream (stream_id == 0), and may have up to 2^32 extended +data streams as identified by the selected \fIstream_id\fP. The SSH2 protocol +currently defines a stream ID of 1 to be the stderr substream. + +\fIchannel\fP - active channel stream to read from. + +\fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR) + +\fIbuf\fP - pointer to storage buffer to read data into + +\fIbuflen\fP - size of the buf storage + +\fIlibssh2_channel_read(3)\fP and \fIlibssh2_channel_read_stderr(3)\fP are +macros. +.SH RETURN VALUE +Actual number of bytes read or -1 on failure. +.SH "SEE ALSO" + diff --git a/docs/libssh2_channel_set_blocking.3 b/docs/libssh2_channel_set_blocking.3 new file mode 100644 index 0000000..6255b0c --- /dev/null +++ b/docs/libssh2_channel_set_blocking.3 @@ -0,0 +1,23 @@ +.\" $Id: libssh2_channel_set_blocking.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ +.\" +.TH libssh2_channel_set_blocking 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_set_blocking - set or clear blocking mode on channel +.SH SYNOPSIS +#include + +void libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking); +.SH DESCRIPTION +Set or clear blocking mode on the selected channel. If a read is performed on +a channel with no data currently available, a blocking channel will wait for +data to arrive and return what it receives. A non-blocking channel will return +immediately with an empty buffer. + +\fIchannel\fP - channel stream to set or clean blocking status on. + +\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to +make it non-blocking. +.SH RETURN VALUE +None +.SH "SEE ALSO" +.BI libssh2_channel_read_ex(3) diff --git a/docs/libssh2_session_free.3 b/docs/libssh2_session_free.3 new file mode 100644 index 0000000..db1ecc3 --- /dev/null +++ b/docs/libssh2_session_free.3 @@ -0,0 +1,17 @@ +.\" $Id: libssh2_session_free.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ +.\" +.TH libssh2_session_free 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_free - frees resources associated with a session instance +.SH SYNOPSIS +#include + +void libssh2_session_free(LIBSSH2_SESSION *session); +.SH DESCRIPTION +Frees resources associated with a session instance. Typically called after +\fIlibssh2_session_disconnect(3)\fP. +.SH RETURN VALUE +None +.SH "SEE ALSO" +.BI libssh2_session_init(3), +.BI libssh2_session_disconnect(3) diff --git a/docs/libssh2_session_init.3 b/docs/libssh2_session_init.3 new file mode 100644 index 0000000..233077a --- /dev/null +++ b/docs/libssh2_session_init.3 @@ -0,0 +1,29 @@ +.\" $Id: libssh2_session_init.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ +.\" +.TH libssh2_session_init 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_init - initializes an SSH session object +.SH SYNOPSIS +#include + +LIBSSH2_SESSION *libssh2_session_init_ex( + LIBSSH2_ALLOC_FUNC((*myalloc)), + LIBSSH2_FREE_FUNC((*myfree)), + LIBSSH2_REALLOC_FUNC((*myrealloc)), + void *abstract); + +LIBSSH2_SESSION *libssh2_session_init(void); +.SH DESCRIPTION +Initializes an SSH session object. By default system memory allocators +(malloc(), free(), realloc()) will be used for any dynamicly allocated memory +blocks. Alternate memory allocation functions may be specified using the +extended version of this API call, and/or optional application specific data +may be attached to the session object. + +This method must be called first, prior to configuring session options or +starting up an SSH session with a remote server. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors. +.SH "SEE ALSO" +.BI libssh2_session_free(3), +.BI libssh2_session_startup(3) diff --git a/docs/libssh2_session_startup.3 b/docs/libssh2_session_startup.3 new file mode 100644 index 0000000..2298f31 --- /dev/null +++ b/docs/libssh2_session_startup.3 @@ -0,0 +1,16 @@ +.\" $Id: libssh2_session_startup.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ +.\" +.TH libssh2_session_startup 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_startup - begin transport layer +.SH SYNOPSIS +#include + +int libssh2_session_startup(LIBSSH2_SESSION *session, int socket); +.SH DESCRIPTION +Begin transport layer protocol negotiation with the connected host. +.SH RETURN VALUE +0 on success, -1 on failure +.SH "SEE ALSO" +.BI libssh2_session_free(3), +.BI libssh2_session_init(3)