welterde/l2tpns
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: gen-docs - Fix pandoc options and re-generate manpages

Browse source 
Tested with:

  LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man \
  --warnings -E UTF-8 -l -Tutf8 -Z docs/manpages/startup-config.5 > /dev/null
This commit is contained in:
Sebastien Badia 2021-01-31 23:35:26 +01:00
parent bf1e1d2d8a
commit b45df29dc7
No known key found for this signature in database
GPG key ID: 8716CE4614A452D8
4 changed files with 21 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/gen-docs.sh
View file

@ -16,7 +16,7 @@ echo "Manpages generation …"
for src in src/man/*.md
do
pandoc -f markdown -t man "$src" > manpages/"$(basename "$src" .md)" && echo "$(basename "$src" .md) successfully built in docs/manpages directory" || echo "Unable to generate manpage from $src"
pandoc -s -t man "$src" -o manpages/"$(basename "$src" .md)" && echo "$(basename "$src" .md) successfully built in docs/manpages directory" || echo "Unable to generate manpage from $src"
done
# We then generate the rest of the documentation

9
docs/manpages/l2tpns.8
View file

@ -1,3 +1,7 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "L2TPNS" "8" "January 31, 2021" "Layer 2 tunneling protocol network server (LNS)" ""
.hy
.SH NAME
.PP
l2tpns - Layer 2 tunneling protocol network server (LNS)
@ -174,8 +178,7 @@ which must be open a L2TP TUNNEL:
.SH SEE ALSO
.PP
\f[B]startup-config\f[R](5), \f[B]nsctl\f[R](8)
.SH AUTHOR
.PP
.SH AUTHORS
This manual page was written by Jonathan McDowell <noodles@earth.li> and
Fernando Alves (fendo\[at]sameswifi.fr), for the Debian GNU/Linux system
Fernando Alves (<fendo@sameswifi.fr>), for the Debian GNU/Linux system
(but may be used by others).

11
docs/manpages/nsctl.8
View file

@ -1,3 +1,7 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "NSCTL" "8" "January 31, 2021" "Manage running l2tpns instance" ""
.hy
.SH NAME
.PP
nsctl - manage running l2tpns instance
@ -44,8 +48,7 @@ be acted upon).
.SH SEE ALSO
.PP
\f[B]l2tpns\f[R](8)
.SH AUTHOR
.PP
.SH AUTHORS
This manual page was written by Jonathan McDowell
<noodles\[at]the.earth.li>, for the Debian GNU/Linux system (but may be
used by others).
<noodles@the.earth.li>, for the Debian GNU/Linux system (but may be used
by others).

8
docs/manpages/startup-config.5
View file

@ -1,3 +1,7 @@
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "STARTUP-CONFIG" "5" "January 31, 2021" "Configuration file for l2tpns" ""
.hy
.SH NAME
.PP
startup-config - configuration file for l2tpns
@ -679,4 +683,6 @@ May not be specified on rules with layer 4 matches.
.RE
.SH SEE ALSO
.PP
l2tpns(8) (http://man.he.net/man8/l2tpns)
l2tpns(8), nsctl(8)
.SH AUTHORS
l2tpns developers <l2tpns@lists.ffdn.org>.