diff --git a/docs/Makefile.am b/docs/Makefile.am index 5a821f5..071ca96 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.26 2007/06/15 11:01:22 jehousley Exp $ +# $Id: Makefile.am,v 1.27 2007/11/29 10:02:58 bagder Exp $ EXTRA_DIST = template.3 @@ -23,6 +23,7 @@ dist_man_MANS = \ libssh2_channel_set_blocking.3 \ libssh2_channel_setenv_ex.3 \ libssh2_channel_wait_eof.3 \ + libssh2_channel_wait_closed.3 \ libssh2_channel_x11_req_ex.3 \ libssh2_hostkey_hash.3 \ libssh2_scp_recv.3 \ diff --git a/docs/libssh2_channel_wait_closed.3 b/docs/libssh2_channel_wait_closed.3 new file mode 100644 index 0000000..5429348 --- /dev/null +++ b/docs/libssh2_channel_wait_closed.3 @@ -0,0 +1,24 @@ +.\" $Id: libssh2_channel_wait_closed.3,v 1.1 2007/11/29 10:02:58 bagder Exp $ +.\" +.TH libssh2_channel_wait_eof 3 "29 Nov 2007" "libssh2 0.19" "libssh2 manual" +.SH NAME +libssh2_channel_wait_closed - wait for the remote to close the channel +.SH SYNOPSIS +#include + +int +libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +Enter a temporary blocking state until the remote host closes the named +channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to +examine the exit status. + +.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 SEE ALSO +.BR libssh2_channel_send_eof(3) +.BR libssh2_channel_eof(3) +.BR libssh2_channel_wait_eof(3)