--- gvpe/doc/gvpe.conf.5 2011/02/15 13:31:22 1.27 +++ gvpe/doc/gvpe.conf.5 2011/03/06 13:49:49 1.28 @@ -1,7 +1,15 @@ -.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -40,25 +48,22 @@ . ds R" '' '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 +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.ie \nF \{\ +.if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.el \{\ -. de IX -.. -.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -124,11 +129,7 @@ .\" ======================================================================== .\" .IX Title "GVPE.CONF 5" -.TH GVPE.CONF 5 "2011-02-12" "2.24" "GNU Virtual Private Ethernet" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.if n .ad l -.nh +.TH GVPE.CONF 5 "2011-02-15" "2.24" "GNU Virtual Private Ethernet" .SH "NAME" gvpe.conf \- configuration file for the GNU VPE daemon .SH "SYNOPSIS" @@ -138,16 +139,22 @@ \& udp\-port = 407 \& mtu = 1492 \& ifname = vpn0 -\& +.Ve +.PP +.Vb 3 \& # first node is named branch1 and is at 1.2.3.4 \& node = branch1 \& hostname = 1.2.3.4 -\& +.Ve +.PP +.Vb 4 \& # second node uses dns to resolve the address \& node = branch2 \& hostname = www.example.net \& udp\-port = 500 # this host uses a different udp\-port -\& +.Ve +.PP +.Vb 3 \& # third node has no fixed ip address \& node = branch3 \& connect = ondemand @@ -190,7 +197,7 @@ node section they will set the default values for all following nodes. .SH "CONFIG VARIABLES" .IX Header "CONFIG VARIABLES" -.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0" +.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" .IX Subsection "GLOBAL SETTINGS" Global settings will affect the behaviour of the running gvpe daemon, that is, they are in some sense node-specific (config files can set different @@ -505,9 +512,9 @@ .Vb 1 \& ip rule add not fwmark 1000 lookup 99 .Ve -.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" +.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" .IX Subsection "NODE SPECIFIC SETTINGS" -The following settings are node-specific, that is, every node can have +The following settings are node\-specific, that is, every node can have different settings, even within the same gvpe instance. Settings that are set before the first node section set the defaults, settings that are set within a node section only apply to the given node. @@ -616,13 +623,7 @@ .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). -.Sp -\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though -it might get switched on automatically, as some future version might -default to another default protocol. +Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR). .IP "hostname = hostname | ip [can not be defaulted]" 4 .IX Item "hostname = hostname | ip [can not be defaulted]" Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 @@ -639,7 +640,7 @@ 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-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. +\&\*(L"ping\-reply\*(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" @@ -714,7 +715,7 @@ .IP "if-up" 4 .IX Item "if-up" The if-up script -.IP "node-up, node-down" 4 +.IP "node\-up, node-down" 4 .IX Item "node-up, node-down" If used the node up or node-down scripts. .IP "hostkey" 4