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

Merge branch 'manpages' into 'master'

Browse source 
Manpages fixes

See merge request l2tpns/l2tpns!9
This commit is contained in:
Julien Rabier 2021-02-04 19:57:30 +00:00
commit a8dc396099
8 changed files with 37 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Makefile
View file

@ -73,9 +73,9 @@ install: all
$(INSTALL) -m 0755 l2tpns $(DESTDIR)$(bindir)/l2tpns $(INSTALL) -m 0755 l2tpns $(DESTDIR)$(bindir)/l2tpns
$(INSTALL) -m 0755 nsctl $(DESTDIR)$(bindir)/nsctl $(INSTALL) -m 0755 nsctl $(DESTDIR)$(bindir)/nsctl
$(INSTALL) -m 0644 docs/startup-config.5 $(DESTDIR)$(man5dir)/startup-config.5 $(INSTALL) -m 0644 docs/manpages/startup-config.5 $(DESTDIR)$(man5dir)/startup-config.5
$(INSTALL) -m 0644 docs/l2tpns.8 $(DESTDIR)$(man8dir)/l2tpns.8 $(INSTALL) -m 0644 docs/manpages/l2tpns.8 $(DESTDIR)$(man8dir)/l2tpns.8
$(INSTALL) -m 0644 docs/nsctl.8 $(DESTDIR)$(man8dir)/nsctl.8 $(INSTALL) -m 0644 docs/manpages/nsctl.8 $(DESTDIR)$(man8dir)/nsctl.8
gzip --best --force $(DESTDIR)$(man5dir)/*.5 $(DESTDIR)$(man8dir)/*.8 gzip --best --force $(DESTDIR)$(man5dir)/*.5 $(DESTDIR)$(man8dir)/*.8

2
docs/gen-docs.sh
View file

@ -16,7 +16,7 @@ echo "Manpages generation …"
for src in src/man/*.md for src in src/man/*.md
do 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 done
# We then generate the rest of the documentation # 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 .SH NAME
.PP .PP
l2tpns - Layer 2 tunneling protocol network server (LNS) l2tpns - Layer 2 tunneling protocol network server (LNS)
@ -174,8 +178,7 @@ which must be open a L2TP TUNNEL:
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[B]startup-config\f[R](5), \f[B]nsctl\f[R](8) \f[B]startup-config\f[R](5), \f[B]nsctl\f[R](8)
.SH AUTHOR .SH AUTHORS
.PP
This manual page was written by Jonathan McDowell <noodles@earth.li> and 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). (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 .SH NAME
.PP .PP
nsctl - manage running l2tpns instance nsctl - manage running l2tpns instance
@ -44,8 +48,7 @@ be acted upon).
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[B]l2tpns\f[R](8) \f[B]l2tpns\f[R](8)
.SH AUTHOR .SH AUTHORS
.PP
This manual page was written by Jonathan McDowell This manual page was written by Jonathan McDowell
<noodles\[at]the.earth.li>, for the Debian GNU/Linux system (but may be <noodles@the.earth.li>, for the Debian GNU/Linux system (but may be used
used by others). 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 .SH NAME
.PP .PP
startup-config - configuration file for l2tpns startup-config - configuration file for l2tpns
@ -679,4 +683,6 @@ May not be specified on rules with layer 4 matches.
.RE .RE
.SH SEE ALSO .SH SEE ALSO
.PP .PP
l2tpns(8) (http://man.he.net/man8/l2tpns) l2tpns(8), nsctl(8)
.SH AUTHORS
l2tpns developers <l2tpns@lists.ffdn.org>.

8
docs/src/man/l2tpns.8.md
View file

@ -1,3 +1,7 @@
% L2TPNS(8) Layer 2 tunneling protocol network server (LNS)
% This manual page was written by Jonathan McDowell <noodles@earth.li> and Fernando Alves (<fendo@sameswifi.fr>), for the Debian GNU/Linux system (but may be used by others)
% January 31, 2021
# NAME # NAME
l2tpns - Layer 2 tunneling protocol network server (LNS) l2tpns - Layer 2 tunneling protocol network server (LNS)
@ -114,7 +118,3 @@ Once running, **l2tpns** may be controlled by telnetting to port 23 on the machi
# SEE ALSO # SEE ALSO
**startup-config**(5), **nsctl**(8) **startup-config**(5), **nsctl**(8)
# AUTHOR
This manual page was written by Jonathan McDowell <noodles@earth.li> and Fernando Alves (fendo@sameswifi.fr), for the Debian GNU/Linux system (but may be used by others).

11
docs/src/man/nsctl.8.md
View file

@ -1,3 +1,7 @@
% NSCTL(8) Manage running l2tpns instance
% This manual page was written by Jonathan McDowell <noodles@the.earth.li>, for the Debian GNU/Linux system (but may be used by others)
% January 31, 2021
NAME NAME
==== ====
@ -59,10 +63,3 @@ SEE ALSO
======== ========
**l2tpns**(8) **l2tpns**(8)
AUTHOR
======
This manual page was written by Jonathan McDowell
\<noodles\@the.earth.li\>, for the Debian GNU/Linux system (but may be
used by others).

6
docs/src/man/startup-config.5.md
View file

@ -1,3 +1,7 @@
% STARTUP-CONFIG(5) Configuration file for l2tpns
% l2tpns developers <l2tpns@lists.ffdn.org>
% January 31, 2021
# NAME # NAME
startup-config - configuration file for l2tpns startup-config - configuration file for l2tpns
@ -394,4 +398,4 @@ _flags_ may be one of:
# SEE ALSO # SEE ALSO
[l2tpns(8)](http://man.he.net/man8/l2tpns) l2tpns(8), nsctl(8)