--- gvpe/doc/gvpe.conf.5 2013/10/11 08:40:56 1.34 +++ gvpe/doc/gvpe.conf.5 2015/07/30 19:03:44 1.35 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30) .\" .\" Standard preamble: .\" ======================================================================== @@ -38,6 +38,8 @@ . ds PI \(*p . ds L" `` . ds R" '' +. ds C` +. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -48,17 +50,24 @@ .\" 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. -.ie \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX .. -. nr % 0 -. rr F -.\} -.el \{\ -. 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. @@ -124,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "GVPE.CONF 5" -.TH GVPE.CONF 5 "2013-10-11" "2.25" "GNU Virtual Private Ethernet" +.TH GVPE.CONF 5 "2015-06-25" "2.25" "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 @@ -240,7 +249,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" +.SS "\s-1GLOBAL SETTINGS\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 @@ -387,8 +396,8 @@ The nickname of the node. .IP "NODEID=1" 4 .IX Item "NODEID=1" -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. +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 1,\s0 the second \s-1ID 2\s0 and so on. .RE .RS 4 .Sp @@ -432,11 +441,11 @@ .Sp The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 -compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 -(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241). +compatible). Other common choices are 50 (\s-1IPSEC, ESP\s0), 51 (\s-1IPSEC, AH\s0), 4 +(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP,\s0 rfc1241). .Sp Many versions of Linux seem to have a bug that causes them to reorder -packets for some ip protocols (\s-1GRE\s0, \s-1ESP\s0) but not for others (\s-1AH\s0), so +packets for some ip protocols (\s-1GRE, ESP\s0) but not for others (\s-1AH\s0), so choose wisely (that is, use 51, \s-1AH\s0). .IP "http-proxy-host = hostname/ip" 4 .IX Item "http-proxy-host = hostname/ip" @@ -607,7 +616,7 @@ spoof, this mechanism exists to alert users that their config is outdated. .Sp It's recommended to specify this is a date string such as \f(CW\*(C`2013\-05\-05\*(C'\fR or -\&\f(CW\*(C`20121205084417).\*(C'\fR +\&\f(CW20121205084417\fR. .Sp The exact algorithm is as this: if a connection request is received form a node with an identical serial, then it succeeds normally. @@ -616,7 +625,7 @@ .Sp If the remote serial is higher than the local serial, a warning message is logged. -.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" +.SS "\s-1NODE SPECIFIC SETTINGS\s0" .IX Subsection "NODE SPECIFIC SETTINGS" The following settings are node-specific, that is, every node can have different settings, even within the same gvpe instance. Settings that are @@ -712,7 +721,7 @@ 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. +See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW IP\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). @@ -729,7 +738,7 @@ .Sp 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]" +.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 address. It will be resolved before each connect request, so dyndns should work fine. If this setting is not specified and a router is available, @@ -843,9 +852,3 @@ .SH "AUTHOR" .IX Header "AUTHOR" Marc Lehmann -.SH "POD ERRORS" -.IX Header "POD ERRORS" -Hey! \fBThe above document had some coding errors, which are explained below:\fR -.IP "Around line 516:" 4 -.IX Item "Around line 516:" -Unterminated C<...> sequence