Add of the ppp_keepalive option.

[l2tpns.git] / Docs / l2tpns.8

diff --git a/Docs/l2tpns.8 b/Docs/l2tpns.8
index 3f949e4..10eeb88 100644 (file)
--- a/Docs/l2tpns.8
+++ b/Docs/l2tpns.8
@@ -1,70 +1,257 @@
-.\" -*- nroff -*-
-.de Id
-.ds Dt \\$4 \\$5
+.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp

 ..
 ..

-.Id $Id: l2tpns.8,v 1.4 2005-06-12 06:09:35 bodea Exp $
-.TH L2TPNS 8 "\*(Dt" L2TPNS "System Management Commands"
-.SH NAME
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+.    ds C`
+.    ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+.    if \nF \{
+.        de IX
+.        tm Index:\\$1\t\\n%\t"\\$2"
+..
+.        if !\nF==2 \{
+.            nr % 0
+.            nr F 2
+.        \}
+.    \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "L2TPNS.8 1"
+.TH L2TPNS.8 1 "2014-09-14" "perl v5.20.2" "User Contributed Perl Documentation"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"

 l2tpns \- Layer 2 tunneling protocol network server (LNS)
 l2tpns \- Layer 2 tunneling protocol network server (LNS)

-.SH SYNOPSIS
-.B l2tpns
-.RB [ \-d ]
-.RB [ \-v ]
-.RB [ \-c
-.IR file ]
-.RB [ \-h
-.IR hostname ]
-.SH DESCRIPTION
-.B l2tpns
-is a daemon for terminating layer 2 tunneling protocol (L2TP: RFC
-2661) sessions.
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBl2tpns\fR [\-\fBd\fR] [\-\fBv\fR] [\-\fBc\fR \fIfile\fR] [\-\fBh\fR \fIhostname\fR]
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fBl2tpns\fR is a daemon for terminating layer 2 tunneling protocol (L2TP: \s-1RFC2661\s0) sessions.
+.PP
+\&\fBl2tpns\fR is a complete L2TP implementation. It supports the \s-1LAC, LNS, PPPOE\s0 and DHCPv6 server.

 .PP
 .PP

-Once running,
-.B l2tpns
-may be controlled by telnetting to port 23 on the machine running the
-daemon and with the
-.B nsctl
-utility.
-.SH OPTIONS
-.TP
-.B \-d
-Detach from terminal and fork into the background. By default l2tpns
-will stay in the foreground.
-.TP
-.B \-v
-Increase verbosity for debugging. Can be used multiple times.
-.TP
-.BI "\-c " file
+Once running, \fBl2tpns\fR may be controlled by telnetting to port 23 on the machine running the daemon and with the \fBnsctl\fR utility.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-d\fR Detach from terminal and fork into the background. By default l2tpns will stay in the foreground." 4
+.IX Item "-d Detach from terminal and fork into the background. By default l2tpns will stay in the foreground."
+\&.
+.IP "\fB\-v\fR Increase verbosity for debugging. Can be used multiple times." 4
+.IX Item "-v Increase verbosity for debugging. Can be used multiple times."
+\&.
+.IP "\fB\-c\fR \fIfile\fR" 4
+.IX Item "-c file"

 Specify configuration file.
 Specify configuration file.

-.TP
-.BI "\-h " hostname
-Force hostname to
-.IR hostname .
-.SH FILES
-.TP
-.I /etc/l2tpns/startup-config
+.IP "\fB\-h\fR \fIhostname\fR" 4
+.IX Item "-h hostname"
+Force hostname to \fIhostname\fR.
+.SH "FILES"
+.IX Header "FILES"
+.IP "\fI/etc/l2tpns/startup\-config\fR" 4
+.IX Item "/etc/l2tpns/startup-config"

 The default configuration file.
 The default configuration file.

-.TP
-.I /etc/l2tpns/ip_pool
-IP address pool configuration.
-.TP
-.I /etc/l2tpns/users
+.IP "\fI/etc/l2tpns/ip_pool\fR" 4
+.IX Item "/etc/l2tpns/ip_pool"
+\&\s-1IP\s0 address pool configuration.
+.IP "\fI/etc/l2tpns/users\fR" 4
+.IX Item "/etc/l2tpns/users"

 Username/password configuration for access to admin interface.
 Username/password configuration for access to admin interface.

-.SH SIGNALS
-.TP
-.B SIGHUP
-Reload the config from disk and re-open log file.
-.TP
-.BR SIGTERM ", " SIGINT
-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.
-.TP
-.B SIGQUIT
+.SH "SIGNALS"
+.IX Header "SIGNALS"
+.IP "\fB\s-1SIGHUP\s0\fR Reload the config from disk and re-open log file." 4
+.IX Item "SIGHUP Reload the config from disk and re-open log file."
+\&.
+.IP "\fB\s-1SIGTERM\s0\fR, \fB\s-1SIGINT\s0\fR" 4
+.IX Item "SIGTERM, SIGINT"
+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.
+.IP "\fB\s-1SIGQUIT\s0\fR" 4
+.IX Item "SIGQUIT"

 Shut down tunnels and sessions, exit process when complete.
 Shut down tunnels and sessions, exit process when complete.

-.SH SEE ALSO
-.BR startup-config (5),
-.BR nsctl (8)
-.SH AUTHOR
-This manual page was written by Jonathan McDowell <noodles@earth.li>,
-for the Debian GNU/Linux system (but may be used by others).
+.SH "MANAGED RADIUS ATTRIBUTE"
+.IX Header "MANAGED RADIUS ATTRIBUTE"
+.IP "\fBAscend-Client-Primary-DNS\fR, \fBAscend-Client-Secondary-DNS\fR" 4
+.IX Item "Ascend-Client-Primary-DNS, Ascend-Client-Secondary-DNS"
+Specifies a primary and secondary \s-1DNS\s0 server address to send to user.
+.IP "\fBDelegated\-IPv6\-Prefix\fR" 4
+.IX Item "Delegated-IPv6-Prefix"
+Assign a network address IPv6 prefix to a user by DHCPv6.
+.IP "\fBFramed-IP-Address\fR" 4
+.IX Item "Framed-IP-Address"
+The address to be configured for the user (IPv4 address of the interface ppp).
+.IP "\fBFramed-Route\fR" 4
+.IX Item "Framed-Route"
+provides routing information to be configured for the user.
+.IP "\fBFramed\-IPv6\-Route\fR" 4
+.IX Item "Framed-IPv6-Route"
+Has the same action as \fBDelegated\-IPv6\-Prefix\fR. \fBDelegated\-IPv6\-Prefix\fR is the correct one to use.
+.IP "\fBFramed\-IPv6\-Address\fR" 4
+.IX Item "Framed-IPv6-Address"
+IPv6 address to be assigned to the user by DHCPv6 (IPv6 address of the interface ppp).
+.IP "\fBIdle-Timeout\fR" 4
+.IX Item "Idle-Timeout"
+disconnects the session if no data for more than \fBIdle-Timeout\fR (in seconds).
+.IP "\fBSession-Timeout\fR" 4
+.IX Item "Session-Timeout"
+disconnects the user session when the time \fBSession-Timeout\fR is reached (in seconds).
+.IP "\fBTunnel-Type\fR, \fBTunnel-Medium-Type\fR, \fBTunnel-Server-Endpoint\fR, \fBTunnel-Password\fR, \fBTunnel-Assignment-Id\fR" 4
+.IX Item "Tunnel-Type, Tunnel-Medium-Type, Tunnel-Server-Endpoint, Tunnel-Password, Tunnel-Assignment-Id"
+attributes returned by the Radius of the remote \s-1LNS\s0 server (\s-1LAC\s0 functionality).
+.Sp
+example, Radius that return the information of 2 remote \s-1LNS\s0 server with which must be open a L2TP \s-1TUNNEL:\s0
+.RS 4
+.IP "\fBTunnel-Type\fR: 1 = L2TP" 4
+.IX Item "Tunnel-Type: 1 = L2TP"
+.PD 0
+.IP "\fBTunnel-Medium-Type\fR: 1 = IPv4" 4
+.IX Item "Tunnel-Medium-Type: 1 = IPv4"
+.ie n .IP "\fBTunnel-Password\fR: 1 = ""TheSecretL2TP""" 4
+.el .IP "\fBTunnel-Password\fR: 1 = ``TheSecretL2TP''" 4
+.IX Item "Tunnel-Password: 1 = TheSecretL2TP"
+.ie n .IP "\fBTunnel-Server-Endpoint\fR: 1 = ""88.xx.xx.x1""" 4
+.el .IP "\fBTunnel-Server-Endpoint\fR: 1 = ``88.xx.xx.x1''" 4
+.IX Item "Tunnel-Server-Endpoint: 1 = 88.xx.xx.x1"
+.ie n .IP "\fBTunnel-Assignment-Id\fR: 1 = ""friendisp_lns1""" 4
+.el .IP "\fBTunnel-Assignment-Id\fR: 1 = ``friendisp_lns1''" 4
+.IX Item "Tunnel-Assignment-Id: 1 = friendisp_lns1"
+.IP "\fBTunnel-Type\fR: 2 = L2TP" 4
+.IX Item "Tunnel-Type: 2 = L2TP"
+.IP "\fBTunnel-Medium-Type\fR: 2 = IPv4" 4
+.IX Item "Tunnel-Medium-Type: 2 = IPv4"
+.ie n .IP "\fBTunnel-Password\fR: 2 = ""TheSecretL2TP""" 4
+.el .IP "\fBTunnel-Password\fR: 2 = ``TheSecretL2TP''" 4
+.IX Item "Tunnel-Password: 2 = TheSecretL2TP"
+.ie n .IP "\fBTunnel-Server-Endpoint\fR: 2 = ""88.xx.xx.x2""" 4
+.el .IP "\fBTunnel-Server-Endpoint\fR: 2 = ``88.xx.xx.x2''" 4
+.IX Item "Tunnel-Server-Endpoint: 2 = 88.xx.xx.x2"
+.ie n .IP "\fBTunnel-Assignment-Id\fR: 2 = ""friendisp_lns2""" 4
+.el .IP "\fBTunnel-Assignment-Id\fR: 2 = ``friendisp_lns2''" 4
+.IX Item "Tunnel-Assignment-Id: 2 = friendisp_lns2"
+.RE
+.RS 4
+.RE
+.PD
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBstartup-config\fR(5), \fBnsctl\fR(8)
+.SH "AUTHOR"
+.IX Header "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).