Clean source manpages

This commit is contained in:
Julien Rabier 2021-02-05 12:18:30 +01:00
parent a8dc396099
commit f261d4fffe
6 changed files with 559 additions and 673 deletions

View file

@ -21,160 +21,138 @@ Once running, \f[B]l2tpns\f[R] may be controlled by telnetting to port
23 on the machine running the daemon and with the \f[B]nsctl\f[R]
utility.
.SH OPTIONS
.IP \[bu] 2
.PP
\f[B]-d\f[R] Detach from terminal and fork into the background.
By default l2tpns will stay in the foreground.
.RS 2
By default l2tpns will stay in the foreground
.PP
\&.
.RE
.IP \[bu] 2
\f[B]-v\f[R] Increase verbosity for debugging.
Can be used multiple times.
.RS 2
Can be used multiple times
.PP
\&.
.RE
.IP \[bu] 2
\f[B]-c\f[R] \f[I]file\f[R]
.RS 2
\f[B]-c\f[R] \f[I]file\f[R] Specify configuration file
.PP
Specify configuration file.
.RE
.IP \[bu] 2
\f[B]-h\f[R] \f[I]hostname\f[R]
.RS 2
.PP
Force hostname to \f[I]hostname\f[R].
.RE
\f[B]-h\f[R] \f[I]hostname\f[R] Force hostname to \f[I]hostname\f[R]
.SH FILES
.IP \[bu] 2
.PP
\f[I]/etc/l2tpns/startup-config\f[R]
.RS 2
.PD 0
.P
.PD
The default configuration file
.PP
The default configuration file.
.RE
.IP \[bu] 2
\f[I]/etc/l2tpns/ip_pool\f[R]
.RS 2
.PD 0
.P
.PD
IP address pool configuration
.PP
IP address pool configuration.
.RE
.IP \[bu] 2
\f[I]/etc/l2tpns/users\f[R]
.RS 2
.PP
Username/password configuration for access to admin interface.
.RE
.PD 0
.P
.PD
Username/password configuration for access to admin interface
.SH SIGNALS
.IP \[bu] 2
\f[B]SIGHUP\f[R] Reload the config from disk and re-open log file.
.RS 2
.PP
\&.
.RE
.IP \[bu] 2
\f[B]SIGHUP\f[R]
.PD 0
.P
.PD
Reload the config from disk and re-open log file
.PP
\f[B]SIGTERM\f[R], \f[B]SIGINT\f[R]
.RS 2
.PP
.PD 0
.P
.PD
Stop process.
Tunnels and sessions are not terminated.
This signal should be used to stop l2tpns on a cluster node where there
are other machines to continue handling traffic.
.RE
.IP \[bu] 2
\f[B]SIGQUIT\f[R]
.RS 2
are other machines to continue handling traffic
.PP
Shut down tunnels and sessions, exit process when complete.
.RE
\f[B]SIGQUIT\f[R]
.PD 0
.P
.PD
Shut down tunnels and sessions, exit process when complete
.SH MANAGED RADIUS ATTRIBUTE
.IP \[bu] 2
.PP
\f[B]Ascend-Client-Primary-DNS\f[R],
\f[B]Ascend-Client-Secondary-DNS\f[R]
.RS 2
.PD 0
.P
.PD
Specifies a primary and secondary DNS server address to send to user
.PP
Specifies a primary and secondary DNS server address to send to user.
.RE
.IP \[bu] 2
\f[B]Delegated-IPv6-Prefix\f[R]
.RS 2
.PD 0
.P
.PD
Assign a network address IPv6 prefix to a user by DHCPv6
.PP
Assign a network address IPv6 prefix to a user by DHCPv6.
.RE
.IP \[bu] 2
\f[B]Framed-IP-Address\f[R]
.RS 2
.PP
.PD 0
.P
.PD
The address to be configured for the user (IPv4 address of the interface
ppp).
.RE
.IP \[bu] 2
ppp)
.PP
\f[B]Framed-Route\f[R]
.RS 2
.PD 0
.P
.PD
provides routing information to be configured for the user
.PP
provides routing information to be configured for the user.
.RE
.IP \[bu] 2
\f[B]Framed-IPv6-Route\f[R]
.RS 2
.PP
.PD 0
.P
.PD
Has the same action as \f[B]Delegated-IPv6-Prefix\f[R].
\f[B]Delegated-IPv6-Prefix\f[R] is the correct one to use.
.RE
.IP \[bu] 2
\f[B]Delegated-IPv6-Prefix\f[R] is the correct one to use
.PP
\f[B]Framed-IPv6-Address\f[R]
.RS 2
.PP
.PD 0
.P
.PD
IPv6 address to be assigned to the user by DHCPv6 (IPv6 address of the
interface ppp).
.RE
.IP \[bu] 2
interface ppp)
.PP
\f[B]Idle-Timeout\f[R]
.RS 2
.PP
.PD 0
.P
.PD
disconnects the session if no data for more than \f[B]Idle-Timeout\f[R]
(in seconds).
.RE
.IP \[bu] 2
\f[B]Session-Timeout\f[R]
.RS 2
(in seconds)
.PP
\f[B]Session-Timeout\f[R]
.PD 0
.P
.PD
disconnects the user session when the time \f[B]Session-Timeout\f[R] is
reached (in seconds).
.RE
.IP \[bu] 2
reached (in seconds)
.PP
\f[B]Tunnel-Type\f[R], \f[B]Tunnel-Medium-Type\f[R],
\f[B]Tunnel-Server-Endpoint\f[R], \f[B]Tunnel-Password\f[R],
\f[B]Tunnel-Assignment-Id\f[R]
.RS 2
.PP
.PD 0
.P
.PD
attributes returned by the Radius of the remote LNS server (LAC
functionality).
.PP
example, Radius that return the information of 2 remote LNS server with
which must be open a L2TP TUNNEL:
.IP \[bu] 2
\f[B]Tunnel-Type\f[R]: 1 = L2TP
.IP \[bu] 2
\f[B]Tunnel-Medium-Type\f[R]: 1 = IPv4
.IP \[bu] 2
\f[B]Tunnel-Password\f[R]: 1 = \[lq]TheSecretL2TP\[rq]
.IP \[bu] 2
\f[B]Tunnel-Server-Endpoint\f[R]: 1 = \[lq]88.xx.xx.x1\[rq]
.IP \[bu] 2
\f[B]Tunnel-Assignment-Id\f[R]: 1 = \[lq]friendisp_lns1\[rq]
.IP \[bu] 2
\f[B]Tunnel-Type\f[R]: 2 = L2TP
.IP \[bu] 2
\f[B]Tunnel-Medium-Type\f[R]: 2 = IPv4
.IP \[bu] 2
\f[B]Tunnel-Password\f[R]: 2 = \[lq]TheSecretL2TP\[rq]
.IP \[bu] 2
\f[B]Tunnel-Server-Endpoint\f[R]: 2 = \[lq]88.xx.xx.x2\[rq]
.IP \[bu] 2
\f[B]Tunnel-Assignment-Id\f[R]: 2 = \[lq]friendisp_lns2\[rq]
.RE
functionality)
.IP
.nf
\f[C]
example, Radius that return the information of 2 remote LNS server with which must be open a L2TP TUNNEL:
- Tunnel-Type: 1 = L2TP
- Tunnel-Medium-Type: 1 = IPv4
- Tunnel-Password: 1 = \[dq]TheSecretL2TP\[dq]
- Tunnel-Server-Endpoint: 1 = \[dq]88.xx.xx.x1\[dq]
- Tunnel-Assignment-Id: 1 = \[dq]friendisp_lns1\[dq]
- Tunnel-Type: 2 = L2TP
- Tunnel-Medium-Type: 2 = IPv4
- Tunnel-Password: 2 = \[dq]TheSecretL2TP\[dq]
- Tunnel-Server-Endpoint: 2 = \[dq]88.xx.xx.x2\[dq]
- Tunnel-Assignment-Id: 2 = \[dq]friendisp_lns2\[dq]
\f[R]
.fi
.SH SEE ALSO
.PP
\f[B]startup-config\f[R](5), \f[B]nsctl\f[R](8)