--- gvpe/doc/gvpe.conf.5	2005/03/06 18:34:46	1.7
+++ gvpe/doc/gvpe.conf.5	2005/06/21 08:48:03	1.15
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "GVPE.CONF 5"
-.TH GVPE.CONF 5 "2005-03-06" "1.8" "GNU Virtual Private Ethernet"
+.TH GVPE.CONF 5 "2005-06-21" "1.9" "GNU Virtual Private Ethernet"
 .SH "NAME"
 gvpe.conf \- configuration file for the GNU VPE daemon
 .SH "SYNOPSIS"
@@ -160,8 +160,8 @@
 The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable
 = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and
 extend to the end of the line. They can be used on their own lines, or
-after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or
-after values, but not within the variable names or values themselves.
+after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
+values, but not within the variable names or values themselves.
 .PP
 The only exception to the above is the \*(L"on\*(R" directive that can prefix any
 \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or
@@ -204,57 +204,119 @@
 .IX Item "dns-forw-port = port-number"
 The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
 which is fine in most cases).
+.IP "dns-max-outstanding = integer-number-of-requests" 4
+.IX Item "dns-max-outstanding = integer-number-of-requests"
+The maximum number of outstanding \s-1DNS\s0 transport requests
+(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
+limit without receiving replies. In heavily overloaded situations it might
+help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
+number of parallel requests.
+.Sp
+The default should be working ok for most links.
+.IP "dns-overlap-factor = float" 4
+.IX Item "dns-overlap-factor = float"
+The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
+during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
+must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
+rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
+request might be generated every \fBmin_latency\fR seconds, which means on
+average there should only ever be one outstanding request.  A factor of
+\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
+latency measured.
+.Sp
+For congested or picky dns forwarders you could use a value nearer to or
+exceeding \f(CW1\fR.
+.Sp
+The default should be working ok for most links.
+.IP "dns-send-interval = send-interval-in-seconds" 4
+.IX Item "dns-send-interval = send-interval-in-seconds"
+The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
+use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
+the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
+not send more than 100 \s-1DNS\s0 requests per connection per second. For
+high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
+congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
+\&\f(CW0.2\fR or even higher.
+.Sp
+The default should be working ok for most links.
+.IP "dns-timeout-factor = float" 4
+.IX Item "dns-timeout-factor = float"
+Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
+get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
+will resend the request when no reply has been received for longer than
+eight times the minimum (= expected) latency, assuming the request or
+reply has been lost.
+.Sp
+For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the
+link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values
+near or below \f(CW1\fR makes no sense whatsoever.
+.Sp
+The default should be working ok for most links.
 .IP "if-up = relative-or-absolute-path" 4
 .IX Item "if-up = relative-or-absolute-path"
 Sets the path of a script that should be called immediately after the
 network interface is initialized (but not neccessarily up). The following
-environment variables are passed to it (the values are just examples):
+environment variables are passed to it (the values are just examples).
+.Sp
+Variables that have the same value on all nodes:
 .RS 4
 .IP "CONFBASE=/etc/gvpe" 4
 .IX Item "CONFBASE=/etc/gvpe"
 The configuration base directory.
 .IP "IFNAME=vpn0" 4
 .IX Item "IFNAME=vpn0"
-The interface to initialize.
+The network interface to initialize.
+.IP "IFTYPE=native # or tincd" 4
+.IX Item "IFTYPE=native # or tincd"
+.PD 0
+.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
+.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
+.PD
+The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the
+\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
+select the correct syntax to use for network-related commands.
 .IP "MTU=1436" 4
 .IX Item "MTU=1436"
 The \s-1MTU\s0 to set the interface to. You can use lower values (if done
 consistently on all hosts), but this is usually ineffective.
+.IP "NODES=5" 4
+.IX Item "NODES=5"
+The number of nodes in this \s-1GVPE\s0 network.
+.RE
+.RS 4
+.Sp
+Variables that are node-specific and with values pertaining to the node
+running this \s-1GVPE:\s0
+.IP "IFUPDATA=string" 4
+.IX Item "IFUPDATA=string"
+The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
 .IP "MAC=fe:fd:80:00:00:01" 4
 .IX Item "MAC=fe:fd:80:00:00:01"
-The \s-1MAC\s0 address to set the interface to. The script *must* set the
-interface \s-1MAC\s0 to this value. You will most likely use one of these:
+The \s-1MAC\s0 address the network interface has to use.
 .Sp
-.Vb 2
-\&   ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
-\&   ifconfig $IFNAME ether $MAC mtu $MTU up      # FreeBSD
-.Ve
-.Sp
-Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
-.IP "IFTYPE=native # or tincd" 4
-.IX Item "IFTYPE=native # or tincd"
-.PD 0
-.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
-.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
-.PD
-The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os
-name in lowercase) that this gvpe was configured for. Can be used to select
-the correct syntax to use for network-related commands.
+Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
+do this automatically.  Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for
+platform-specific information.
 .IP "NODENAME=branch1" 4
 .IX Item "NODENAME=branch1"
-The nickname of the current node, as passed to the gvpe daemon.
+The nickname of the node.
 .IP "NODEID=1" 4
 .IX Item "NODEID=1"
-The numerical node id of the current node. The first node mentioned in the
-config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
+The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
+node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
 .RE
 .RS 4
 .Sp
+In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
+available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
+node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
+the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
+.Sp
 Here is a simple if-up script:
 .Sp
 .Vb 5
 \&   #!/bin/sh
-\&   ip link set $IFNAME address $MAC mtu $MTU up
+\&   ip link set $IFNAME up
 \&   [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
 \&   [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
 \&   ip route add 10.0.0.0/8 dev $IFNAME
@@ -352,8 +414,8 @@
 .IP "node-up = relative-or-absolute-path" 4
 .IX Item "node-up = relative-or-absolute-path"
 Sets a command (default: no script) that should be called whenever a
-connection is established (even on rekeying operations). In addition
-to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
+connection is established (even on rekeying operations). In addition to
+all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
 variables will be set:
 .RS 4
 .IP "DESTNODE=branch2" 4
@@ -431,8 +493,7 @@
 don't talk to it).
 .IP "dns-domain = domain-suffix" 4
 .IX Item "dns-domain = domain-suffix"
-The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server. Needs to be
-set on both client and server.
+The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
 .Sp
 The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
 i.e.
@@ -455,30 +516,57 @@
 change.
 .IP "dns-port = port-number" 4
 .IX Item "dns-port = port-number"
-The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW0\fR on all \s-1DNS\s0 tunnel
-clients and \f(CW53\fR on the server.
+The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
+.IP "enable-dns = yes|true|on | no|false|off" 4
+.IX Item "enable-dns = yes|true|on | no|false|off"
+See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
+protocol. Avoid this protocol if you can.
+.Sp
+Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
+client. Support for this transport protocol is only available when gvpe
+was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
+.IP "enable-icmp = yes|true|on | no|false|off" 4
+.IX Item "enable-icmp = yes|true|on | no|false|off"
+See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
+.Sp
+Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
+node.
 .IP "enable-rawip = yes|true|on | no|false|off" 4
 .IX Item "enable-rawip = yes|true|on | no|false|off"
+See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
+.Sp
 Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
-(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
-is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
+(default: \f(CW\*(C`no\*(C'\fR).
 .IP "enable-tcp = yes|true|on | no|false|off" 4
 .IX Item "enable-tcp = yes|true|on | no|false|off"
+See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
+.Sp
 Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
-(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only
-available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never
-use this transport unless you really must, it is horribly ineffiecent and
-resource-intensive compared to the other transports.
+(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available
+when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
 .IP "enable-udp = yes|true|on | no|false|off" 4
 .IX Item "enable-udp = yes|true|on | no|false|off"
+See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
+.Sp
 Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
 unless no other protocol is enabled for a node, in which case this
-protocol is enabled automatically). This is a good general choice since
-\&\s-1UDP\s0 tunnels well through many firewalls.
+protocol is enabled automatically).
 .Sp
 \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
 it might get switched on automatically, as some future version might
 default to another default protocol.
+.IP "icmp-type = integer" 4
+.IX Item "icmp-type = integer"
+Sets the type value to be used for outgoing (and incoming) packets sent
+via the \s-1ICMP\s0 transport.
+.Sp
+The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
+\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
+\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
+.IP "if-up-data = value" 4
+.IX Item "if-up-data = value"
+The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
+script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
 .IP "inherit-tos = yes|true|on | no|false|off" 4
 .IX Item "inherit-tos = yes|true|on | no|false|off"
 Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
@@ -487,14 +575,14 @@
 to the tunnel device, which is usually what you want.
 .IP "max-retry = positive-number" 4
 .IX Item "max-retry = positive-number"
-The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between
+The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
 retries to establish a connection to this node. When a connection cannot
 be established, gvpe uses exponential backoff capped at this value. It's
 sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
 connections to routers that usually are stable but sometimes are down, to
-assure quick reconnections.
-.IP "router-priority = 0 | 1 | positive\-number>2" 4
-.IX Item "router-priority = 0 | 1 | positive-number>2"
+assure quick reconnections even after longer downtimes.
+.IP "router-priority = 0 | 1 | positive\-number>=2" 4
+.IX Item "router-priority = 0 | 1 | positive-number>=2"
 Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
 some host tries to connect to another host without a hostname, it asks
 the router host for it's \s-1IP\s0 address. The router host is the one with the
@@ -540,4 +628,4 @@
 \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
 .SH "AUTHOR"
 .IX Header "AUTHOR"
-Marc Lehmann <gvpe@plan9.de>
+Marc Lehmann <gvpe@schmorp.de>