mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-29 13:01:14 +03:00
docs: simplify .TH
header & other cleanups [ci skip]
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
This commit is contained in:
@ -1,4 +1,4 @@
|
||||
.TH libssh2_userauth_password_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
||||
.TH libssh2_userauth_password_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
||||
.SH NAME
|
||||
libssh2_userauth_password_ex - authenticate a session with username and password
|
||||
.SH SYNOPSIS
|
||||
@ -39,12 +39,10 @@ Attempt basic password authentication. Note that many SSH servers
|
||||
which appear to support ordinary password authentication actually have
|
||||
it disabled and use Keyboard Interactive authentication (routed via
|
||||
PAM or another authentication backed) instead.
|
||||
|
||||
.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
|
||||
Some of the errors this function may return include:
|
||||
|
||||
|
Reference in New Issue
Block a user