diff options
author | Alex Crichton <alex@alexcrichton.com> | 2014-11-01 13:23:30 -0700 |
---|---|---|
committer | Alex Crichton <alex@alexcrichton.com> | 2014-11-01 13:23:30 -0700 |
commit | 719471f6e8069626965ed348f7d5abedcce514e2 (patch) | |
tree | e19304189a09a31c1fcce2f71fee798ddba8007d /libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_banner_set.3 | |
parent | 22ace41d1eb0f70ccae7ce0b72462dff56be3819 (diff) | |
download | ssh2-rs-719471f6e8069626965ed348f7d5abedcce514e2.zip |
Bundle libssh2
Diffstat (limited to 'libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_banner_set.3')
-rw-r--r-- | libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_banner_set.3 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_banner_set.3 b/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_banner_set.3 new file mode 100644 index 0000000..5e4161e --- /dev/null +++ b/libssh2-sys/libssh2-1.4.4-20140901/docs/libssh2_session_banner_set.3 @@ -0,0 +1,32 @@ +.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual" +.SH NAME +libssh2_session_banner_set - set the SSH protocol banner for the local client +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIbanner\fP - A pointer to a zero-terminated string holding the user defined +banner + +Set the banner that will be sent to the remote host when the SSH session is +started with \fIlibssh2_session_handshake(3)\fP This is optional; a banner +corresponding to the protocol and libssh2 version will be sent by default. +.SH RETURN VALUE +Returns 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 AVAILABILITY +Added in 1.4.0. + +Before 1.4.0 this function was known as libssh2_banner_set(3) +.SH SEE ALSO +.BR libssh2_session_handshake(3), +.BR libssh2_session_banner_get(3) |