diff --git a/docs/libssh2_channel_readnb_ex.3 b/docs/libssh2_channel_readnb_ex.3 deleted file mode 100644 index 3a1e1c4..0000000 --- a/docs/libssh2_channel_readnb_ex.3 +++ /dev/null @@ -1,39 +0,0 @@ -.\" $Id: libssh2_channel_readnb_ex.3,v 1.4 2007/06/08 13:33:08 jehousley Exp $ -.\" -.TH libssh2_channel_read_ex 3 "1 June 2007" "libssh2 0.15" "libssh2 manual" -.SH NAME -libssh2_channel_read_ex - read data from a channel stream -.SH SYNOPSIS -#include - -int libssh2_channel_readnb_ex(LIBSSH2_CHANNEL *channel, int stream_id, - char *buf, size_t buflen); - -int libssh2_channel_readnb(LIBSSH2_CHANNEL *channel, char *buf, - size_t buflen); - -int libssh2_channel_readnb_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 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 "SEE ALSO" -.BR libssh2_poll_channel_read(3) -