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

man: fixups

- add missing `.fi` tags.
- fix misplaced `.nf` tags.
- add `.nf`/`.fi` tags `SYNOPSIS` where missing.
- fix missing/wrong function name from `SH NAME`.
- fix wrong function name in `TH`.
- keep return values in a separate line.
- indent.
- fold long lines.
- deleted `libssh2_channel_direct_streamlocal()`, there is no such function.
- add missing types.
- add missing headers.

Closes #949
This commit is contained in:
Viktor Szakats
2023-04-11 00:38:35 +00:00
parent 504026262d
commit e590450dcc
176 changed files with 761 additions and 358 deletions

View File

@ -2,11 +2,13 @@
.SH NAME
libssh2_keepalive_send - short function description
.SH SYNOPSIS
#include <libssh2.h>
.nf
#include <libssh2.h>
int libssh2_keepalive_send(LIBSSH2_SESSION *session,
int *seconds_to_next);
int
libssh2_keepalive_send(LIBSSH2_SESSION *session,
int *seconds_to_next);
.fi
.SH DESCRIPTION
Send a keepalive message if needed. \fBseconds_to_next\fP indicates how many
seconds you can sleep after this call before you need to call it again.