1
0
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:
Viktor Szakats
2023-04-26 17:49:01 +00:00
parent d7bec41df3
commit 592e2b37fa
183 changed files with 199 additions and 283 deletions

View File

@ -1,4 +1,4 @@
.TH libssh2_userauth_authenticated 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.TH libssh2_userauth_authenticated 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME
libssh2_userauth_authenticated - return authentication status
.SH SYNOPSIS
@ -13,9 +13,7 @@ libssh2_userauth_authenticated(LIBSSH2_SESSION *session);
.BR libssh2_session_init_ex(3)
Indicates whether or not the named session has been successfully authenticated.
.SH RETURN VALUE
Returns 1 if authenticated and 0 if not.
.SH SEE ALSO
.BR libssh2_session_init_ex(3)