1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00

man: fix double spaces and dash escaping

- `-  ` -> `- `
- `.  ` -> `. `
- `\- ` -> `- `
- `-1` -> `\-1`
- fold long lines along the way

This makes the minus sign come out as a Unicode minus sign
(0x2212), and title separator dashes as Unicode hyphen (0x2010),
with `groff -Tutf8` v1.23.0.

Ref: https://lwn.net/Articles/947941/

Closes #1210
This commit is contained in:
Viktor Szakats
2023-11-03 11:04:22 +00:00
parent 8cca7b7752
commit a3ffc4221d
57 changed files with 99 additions and 97 deletions

View File

@ -14,8 +14,8 @@ libssh2_session_supported_algs(LIBSSH2_SESSION* session,
.fi
.SH DESCRIPTION
\fIsession\fP - An instance of initialized LIBSSH2_SESSION (the function will
use its pointer to the memory allocation function). \fImethod_type\fP -
Method type. See \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address
use its pointer to the memory allocation function). \fImethod_type\fP -
Method type. See \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address
of a pointer that will point to an array of returned algorithms
Get a list of supported algorithms for the given \fImethod_type\fP. The
@ -30,7 +30,7 @@ libssh2_session_flag(session, LIBSSH2_FLAG_COMPRESS, 1) must be called before
calling this function, otherwise only "none" will be returned.
If successful, the function will allocate and fill the array with supported
algorithms (the same names as defined in RFC 4253). The array is not NULL
algorithms (the same names as defined in RFC 4253). The array is not NULL
terminated.
.SH EXAMPLE
.nf
@ -61,12 +61,12 @@ else {
.fi
.SH RETURN VALUE
On success, a number of returned algorithms (i.e a positive number will be
returned). In case of a failure, an error code (a negative number, see below)
is returned. 0 should never be returned.
returned). In case of a failure, an error code (a negative number, see below)
is returned. 0 should never be returned.
.SH ERRORS
\fILIBSSH2_ERROR_BAD_USE\fP - Invalid address of algs.
\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - Unknown method type.
\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - Unknown method type.
\fILIBSSH2_ERROR_INVAL\fP - Internal error (normally should not occur).