1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-04-19 02:24:04 +03:00
libssh2/docs/template.3
Viktor Szakats 592e2b37fa
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.
2023-04-26 17:55:51 +00:00

21 lines
413 B
Groff

.TH libssh2_template 3 "1 Jun 2022" "libssh2" "libssh2"
.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 AVAILABILITY
Added in libssh2 ?.?.?
.SH SEE ALSO
Add related functions