mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-19 02:24:04 +03:00
9839ebe5e9
With deprecated-at versions and suggested replacement function. It's possible to silence them by defining `LIBSSH2_DISABLE_DEPRECATION`. Also add depcreated-at versions to documentation, and unify wording. Ref: https://github.com/libssh2/libssh2/pull/1260#issuecomment-1837017987 Closes #1289
37 lines
1.2 KiB
Groff
37 lines
1.2 KiB
Groff
.\" Copyright (C) The libssh2 project and its contributors.
|
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
|
.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
|
.SH NAME
|
|
libssh2_banner_set - set the SSH protocol banner for the local client
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This function is \fBDEPRECATED\fP in 1.4.0. Use the
|
|
\fIlibssh2_session_banner_set(3)\fP function instead!
|
|
|
|
\fIsession\fP - Session instance as returned by
|
|
.BR libssh2_session_init_ex(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_handshake(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 is not really a failure per se.
|
|
.SH AVAILABILITY
|
|
Marked as deprecated since 1.4.0
|
|
.SH ERRORS
|
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_handshake(3)
|