correct comment: throttle_speed rather than throttle_rate

[l2tpns.git] / Docs / startup-config.5

diff --git a/Docs/startup-config.5 b/Docs/startup-config.5
index 35d5346..07fc79c 100644 (file)
--- a/Docs/startup-config.5
+++ b/Docs/startup-config.5
@@ -2,7 +2,7 @@
 .de Id
 .ds Dt \\$4 \\$5
 ..
 .de Id
 .ds Dt \\$4 \\$5
 ..

-.Id $Id: startup-config.5,v 1.7 2005-05-10 11:59:25 bodea Exp $
+.Id $Id: startup-config.5,v 1.17 2006-04-27 14:38:14 bodea Exp $

 .TH STARTUP-CONFIG 5 "\*(Dt" L2TPNS "File Formats and Conventions"
 .SH NAME
 startup\-config \- configuration file for l2tpns
 .TH STARTUP-CONFIG 5 "\*(Dt" L2TPNS "File Formats and Conventions"
 .SH NAME
 startup\-config \- configuration file for l2tpns


@@ -63,6 +63,20 @@ for authenticating tunnel request.  Must be the same as the LAC, or
 authentication will fail.  Only actually be used if the LAC requests
 authentication.
 .TP
 authentication will fail.  Only actually be used if the LAC requests
 authentication.
 .TP

+.B l2tp_mtu
+MTU of interface for L2TP traffic (default: 1500).  Used to set link
+MRU and adjust TCP MSS.
+.TP
+.B ppp_restart_time
+Restart timer for PPP protocol negotiation in seconds (default: 3).
+.TP
+.B ppp_max_configure
+Number of configure requests to send before giving up (default: 10).
+.TP
+.B ppp_max_failure
+Number of Configure-Nak requests to send before sending a
+Configure-Reject (default: 5).
+.TP

 .BR primary_dns , " secondary_dns"
 Whenever a PPP connection is established, DNS servers will be sent to the
 user, both a primary and a secondary.  If either is set to 0.0.0.0, then that
 .BR primary_dns , " secondary_dns"
 Whenever a PPP connection is established, DNS servers will be sent to the
 user, both a primary and a secondary.  If either is set to 0.0.0.0, then that


@@ -91,10 +105,7 @@ record when the session is closed.
 If
 .B radius_accounting
 is on, defines the interval between sending of RADIUS interim
 If
 .B radius_accounting
 is on, defines the interval between sending of RADIUS interim

-accounting records (in seconds).  Note: checking of this interval
-occurs no more frequently than
-.B cleanup_interval
-seconds (see below).
+accounting records (in seconds).

 .TP
 .B radius_secret
 Secret to be used in RADIUS packets.
 .TP
 .B radius_secret
 Secret to be used in RADIUS packets.


@@ -103,6 +114,18 @@ Secret to be used in RADIUS packets.
 A comma separated list of supported RADIUS authentication methods
 ("pap" or "chap"), in order of preference (default "pap").
 .TP
 A comma separated list of supported RADIUS authentication methods
 ("pap" or "chap"), in order of preference (default "pap").
 .TP

+.B radius_dae_port
+Port for DAE RADIUS (Packet of Death/Disconnect, Change of Authorization)
+requests (default: 3799).
+.TP
+.B allow_duplicate_users
+Allow multiple logins with the same username.  If false (the default),
+any prior session with the same username will be dropped when a new
+session is established.
+.TP
+.B guest_account
+Allow multiple logins matching this specific username.
+.TP

 .B bind_address
 When the tun interface is created, it is assigned the address
 specified here.  If no address is given, 1.1.1.1 is used.  Packets
 .B bind_address
 When the tun interface is created, it is assigned the address
 specified here.  If no address is given, 1.1.1.1 is used.  Packets


@@ -129,10 +152,6 @@ session requires two buckets (in and out).
 If set to a directory, then every 5 minutes the current usage for
 every connected use will be dumped to a file in this directory.
 .TP
 If set to a directory, then every 5 minutes the current usage for
 every connected use will be dumped to a file in this directory.
 .TP

-.B setuid
-After starting up and binding the interface, change UID to this.  This
-doesn't work properly.
-.TP

 .B dump_speed
 If set to true, then the current bandwidth utilization will be logged
 every second.  Even if this is disabled, you can see this information
 .B dump_speed
 If set to true, then the current bandwidth utilization will be logged
 every second.  Even if this is disabled, you can see this information


@@ -140,9 +159,6 @@ by running the
 .B uptime
 command on the CLI.
 .TP
 .B uptime
 command on the CLI.
 .TP

-.B cleanup_interval
-Interval between regular cleanups (in seconds).
-.TP

 .B multi_read_count
 Number of packets to read off each of the UDP and TUN fds when
 returned as readable by select (default: 10).  Avoids incurring the
 .B multi_read_count
 Number of packets to read off each of the UDP and TUN fds when
 returned as readable by select (default: 10).  Avoids incurring the


@@ -181,6 +197,9 @@ Multicast cluster address (default: 239.192.13.13).
 .B cluster_interface
 Interface for cluster packets (default: eth0).
 .TP
 .B cluster_interface
 Interface for cluster packets (default: eth0).
 .TP

+.B cluster_mcast_ttl
+TTL for multicast packets (default: 1).
+.TP

 .B cluster_hb_interval
 Interval in tenths of a second between cluster heartbeat/pings.
 .TP
 .B cluster_hb_interval
 Interval in tenths of a second between cluster heartbeat/pings.
 .TP


@@ -189,6 +208,10 @@ Cluster heartbeat timeout in tenths of a second.  A new master will be
 elected when this interval has been passed without seeing a heartbeat
 from the master.
 .TP
 elected when this interval has been passed without seeing a heartbeat
 from the master.
 .TP

+.B cluster_master_min_adv
+Determines the minumum number of up to date slaves required before the
+master will drop routes (default: 1).
+.TP

 .B ipv6_prefix
 Enable negotiation of IPv6.  This forms the the first 64 bits of the
 client allocated address.  The remaining 64 come from the allocated
 .B ipv6_prefix
 Enable negotiation of IPv6.  This forms the the first 64 bits of the
 client allocated address.  The remaining 64 come from the allocated