1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-05-01 13:44:44 +03:00
libssh2/docs/template.3
Viktor Szakats e590450dcc
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
2023-04-11 00:38:35 +00:00

22 lines
390 B
Groff

.TH libssh2_template 3 "1 Jun 2022" "libssh2 1.10.0" "libssh2 manual"
.SH NAME
libssh2_template - short function description
.SH SYNOPSIS
.nf
#include <libssh2.h>
void
libssh2_template(void);
.fi
.SH DESCRIPTION
Long text describing the function and its input arguments.
.SH RETURN VALUE
Describe what the function returns.
.SH ERRORS
Add error codes
.SH SEE ALSO
Add related functions