1
1

Add libssh2_banner_set.3 and libssh2_channel_close.3

Этот коммит содержится в:
James Housley 2007-06-13 17:03:38 +00:00
родитель 2003dc1546
Коммит e6daab80fa
3 изменённых файлов: 83 добавлений и 9 удалений

Просмотреть файл

@ -1,12 +1,23 @@
# $Id: Makefile.am,v 1.8 2007/06/07 16:07:09 jehousley Exp $
# $Id: Makefile.am,v 1.9 2007/06/13 17:03:38 jehousley Exp $
EXTRA_DIST = template.3
dist_man_MANS = libssh2_channel_forward_accept.3 \
libssh2_session_init.3 libssh2_channel_forward_listen_ex.3 \
libssh2_session_startup.3 libssh2_channel_read_ex.3 \
libssh2_sftp_init.3 libssh2_sftp_open_ex.3 \
libssh2_channel_set_blocking.3 libssh2_session_free.3 \
libssh2_poll.3 libssh2_poll_channel_read.3 libssh2_sftp_read.3 \
libssh2_sftp_readdir.3 libssh2_sftp_mkdir_ex.3 \
libssh2_session_disconnect_ex.3 libssh2_channel_wait_eof.3
dist_man_MANS =
libssh2_banner_set.3 \
libssh2_channel_close.3 \
libssh2_channel_forward_accept.3 \
libssh2_channel_forward_listen_ex.3 \
libssh2_channel_read_ex.3 \
libssh2_channel_set_blocking.3 \
libssh2_channel_wait_eof.3
libssh2_session_free.3 \
libssh2_session_disconnect_ex.3 \
libssh2_session_init.3 \
libssh2_session_startup.3 \
libssh2_poll.3 \
libssh2_poll_channel_read.3 \
libssh2_sftp_init.3 \
libssh2_sftp_open_ex.3 \
libssh2_sftp_mkdir_ex.3 \
libssh2_sftp_read.3 \
libssh2_sftp_readdir.3

32
docs/libssh2_banner_set.3 Обычный файл
Просмотреть файл

@ -0,0 +1,32 @@
.\" $Id: libssh2_banner_set.3,v 1.1 2007/06/13 17:03:38 jehousley Exp $
.\"
.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_banner_set - set the SSH prococol banner for the local client
.SH SYNOPSIS
#include <libssh2.h>
int
libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
.SH DESCRIPTION
\fIsession\fP - Session instance as returned by
.BR libssh2_session_init(3)
\fIbanner\fP - A pointer to a user defined banner
Set the banner that will be sent to the remote host when the SSH session is
started with
.BR libssh2_session_startup(3)
. This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.
.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.
.SH SEE ALSO
.BR libssh2_session_startup(3)

31
docs/libssh2_channel_close.3 Обычный файл
Просмотреть файл

@ -0,0 +1,31 @@
.\" $Id: libssh2_channel_close.3,v 1.1 2007/06/13 17:03:38 jehousley Exp $
.\"
.TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_channel_close - close a channel<
.SH SYNOPSIS
#include <libssh2.h>
int
libssh2_channel_close(LIBSSH2_CHANNEL *channel);
.SH DESCRIPTION
\fIchannel\fP - active channel stream to set closed status on.
Close an active data channel. In practice this means sending an SSH_MSG_CLOSE
packet to the remote host which serves as instruction that no further data
will be sent to it. The remote host may still send data back until it sends
its own close message in response. To wait for the remote end to close its
connection as well, follow this command with
.BR libssh2_channel_wait_closed(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_SOCKET_SEND\fP - Unable to send data on socket.
.SH SEE ALSO
.BR libssh2_channel_open(3)