mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-17 04:22:32 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_userauth_banner
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_session_init_ex(3)
|
|
- libssh2_userauth_list(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_userauth_banner - get the server's userauth banner message
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_userauth_banner(LIBSSH2_SESSION *session, char **banner);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*session* - Session instance as returned by libssh2_session_init_ex(3)
|
|
|
|
*banner* - Should point to a pointer that gets filled with banner message.
|
|
|
|
After an authentication has been attempted, such as a
|
|
**SSH_USERAUTH_NONE** request sent by *libssh2_userauth_list(3)*
|
|
this function can be called to retrieve the userauth banner sent by
|
|
the server. If no such banner is sent, or if an authentication has not
|
|
yet been attempted, returns **LIBSSH2_ERROR_MISSING_USERAUTH_BANNER**.
|
|
|
|
# RETURN VALUE
|
|
|
|
On success returns 0 and an UTF-8 NUL-terminated string is stored in the
|
|
*banner*. This string is internally managed by libssh2 and will be
|
|
deallocated upon session termination.
|
|
On failure returns **LIBSSH2_ERROR_MISSING_USERAUTH_BANNER**.
|