ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.28 by root, Sun Mar 6 13:49:49 2011 UTC vs.
Revision 1.34 by root, Fri Oct 11 08:40:56 2013 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
… …
46. ds PI \(*p 38. ds PI \(*p
47. ds L" `` 39. ds L" ``
48. ds R" '' 40. ds R" ''
49'br\} 41'br\}
50.\" 42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 47.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 49.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
55.if \nF \{\ 51.ie \nF \{\
56. de IX 52. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
58.. 54..
59. nr % 0 55. nr % 0
60. rr F 56. rr F
61.\} 57.\}
62.\" 58.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 59. de IX
64.\" way too many mistakes in technical documents. 60..
65.hy 0 61.\}
66.if n .na
67.\" 62.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 64.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 65. \" fudge factors for nroff and troff
71.if n \{\ 66.if n \{\
… …
127.\} 122.\}
128.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
129.\" ======================================================================== 124.\" ========================================================================
130.\" 125.\"
131.IX Title "GVPE.CONF 5" 126.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2011-02-15" "2.24" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2013-10-11" "2.25" "GNU Virtual Private Ethernet"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
133.SH "NAME" 132.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 133gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 134.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 135.IX Header "SYNOPSIS"
137.Vb 4 136.Vb 4
138\& # global options for all nodes 137\& # global options for all nodes
139\& udp\-port = 407 138\& udp\-port = 407
140\& mtu = 1492 139\& mtu = 1492
141\& ifname = vpn0 140\& ifname = vpn0
142.Ve 141\&
143.PP
144.Vb 3
145\& # first node is named branch1 and is at 1.2.3.4 142\& # first node is named branch1 and is at 1.2.3.4
146\& node = branch1 143\& node = branch1
147\& hostname = 1.2.3.4 144\& hostname = 1.2.3.4
148.Ve 145\&
149.PP
150.Vb 4
151\& # second node uses dns to resolve the address 146\& # second node uses dns to resolve the address
152\& node = branch2 147\& node = branch2
153\& hostname = www.example.net 148\& hostname = www.example.net
154\& udp\-port = 500 # this host uses a different udp\-port 149\& udp\-port = 500 # this host uses a different udp\-port
155.Ve 150\&
156.PP
157.Vb 3
158\& # third node has no fixed ip address 151\& # third node has no fixed ip address
159\& node = branch3 152\& node = branch3
160\& connect = ondemand 153\& connect = ondemand
161.Ve 154.Ve
162.SH "DESCRIPTION" 155.SH "DESCRIPTION"
… …
165= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and 158= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and
166extend to the end of the line. They can be used on their own lines, or 159extend to the end of the line. They can be used on their own lines, or
167after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after 160after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
168values, but not within the variable names or values themselves. 161values, but not within the variable names or values themselves.
169.PP 162.PP
170The only exception to the above is the \*(L"on\*(R" directive that can prefix any 163All settings are applied \*(L"in order\*(R", that is, later settings of the same
171\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
172(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
173.PP 165.PP
166The only exceptions to the above are the following directives:
167.IP "node nodename" 4
168.IX Item "node nodename"
169Introduces a node section. The nodename is used to select the right
170configuration section and is the same string as is passed as an argument
171to the gvpe daemon.
172.Sp
173Multiple \f(CW\*(C`node\*(C'\fR statements with the same node name are supported and will
174be merged together.
175.IP "global" 4
176.IX Item "global"
177This statement switches back to the global section, which is mainly
178useful if you want to include a second config file, e..g for local
179customisations. To do that, simply include this at the very end of your
180config file:
181.Sp
182.Vb 2
183\& global
184\& include local.conf
185.Ve
186.IP "on nodename ..." 4
187.IX Item "on nodename ..."
188.PD 0
189.IP "on !nodename ..." 4
190.IX Item "on !nodename ..."
191.PD
192You can prefix any configuration directive with \f(CW\*(C`on\*(C'\fR and a nodename. \s-1GVPE\s0
193will will only \*(L"execute\*(R" it on the named node, or (if the nodename starts
194with \f(CW\*(C`!\*(C'\fR) on all nodes except the named one.
195.Sp
174For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on 196Example: set the \s-1MTU\s0 to \f(CW1450\fR everywhere, \f(CW\*(C`loglevel\*(C'\fR to \f(CW\*(C`noise\*(C'\fR on
175branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: 197\&\f(CW\*(C`branch1\*(C'\fR, and \f(CW\*(C`connect\*(C'\fR to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2.
176.PP 198.Sp
177.Vb 3 199.Vb 3
178\& mtu = 1450 200\& mtu = 1450
179\& on branch1 loglevel = noise 201\& on branch1 loglevel = noise
180\& on !branch2 connect = ondemand 202\& on !branch2 connect = ondemand
181.Ve 203.Ve
182.PP 204.IP "include relative-or-absolute-path" 4
183All settings are applied \*(L"in order\*(R", that is, later settings of the same 205.IX Item "include relative-or-absolute-path"
184variable overwrite earlier ones. 206Reads the specified file (the path must not contain whitespace or \f(CW\*(C`=\*(C'\fR
207characters) and evaluate all config directives in it as if they were
208spelled out in place of the \f(CW\*(C`include\*(C'\fR directive.
209.Sp
210The path is a printf format string, that is, you must escape any \f(CW\*(C`%\*(C'\fR
211by doubling it, and you can have a single \f(CW%s\fR inside, which will be
212replaced by the current nodename.
213.Sp
214Relative paths are interpreted relative to the \s-1GVPE\s0 config directory.
215.Sp
216Example: include the file \fIlocal.conf\fR in the config directory on every
217node.
218.Sp
219.Vb 1
220\& include local.conf
221.Ve
222.Sp
223Example: include a file \fIconf/\fRnodename\fI.conf\fR
224.Sp
225.Vb 1
226\& include conf/%s.conf
227.Ve
185.SH "ANATOMY OF A CONFIG FILE" 228.SH "ANATOMY OF A CONFIG FILE"
186.IX Header "ANATOMY OF A CONFIG FILE" 229.IX Header "ANATOMY OF A CONFIG FILE"
187Usually, a config file starts with a few global settings (like the \s-1UDP\s0 230Usually, a config file starts with a few global settings (like the \s-1UDP\s0
188port to listen on), followed by node-specific sections that begin with a 231port to listen on), followed by node-specific sections that begin with a
189\&\f(CW\*(C`node = nickname\*(C'\fR line. 232\&\f(CW\*(C`node = nickname\*(C'\fR line.
… …
195.PP 238.PP
196Node-specific settings can be used at any time. If used before the first 239Node-specific settings can be used at any time. If used before the first
197node section they will set the default values for all following nodes. 240node section they will set the default values for all following nodes.
198.SH "CONFIG VARIABLES" 241.SH "CONFIG VARIABLES"
199.IX Header "CONFIG VARIABLES" 242.IX Header "CONFIG VARIABLES"
200.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 243.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
201.IX Subsection "GLOBAL SETTINGS" 244.IX Subsection "GLOBAL SETTINGS"
202Global settings will affect the behaviour of the running gvpe daemon, that 245Global settings will affect the behaviour of the running gvpe daemon, that
203is, they are in some sense node-specific (config files can set different 246is, they are in some sense node-specific (config files can set different
204values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of 247values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
205the gvpe daemon and all connections it creates. 248the gvpe daemon and all connections it creates.
249.IP "chroot = path or /" 4
250.IX Item "chroot = path or /"
251Tells \s-1GVPE\s0 to \fIchroot\fR\|(2) to the specified path after reading all necessary
252files, binding to sockets and running the \f(CW\*(C`if\-up\*(C'\fR script, but before
253running \f(CW\*(C`node\-up\*(C'\fR or any other scripts.
254.Sp
255The special path \fI/\fR instructs \s-1GVPE\s0 to create (and remove) an empty
256temporary directory to use as new root. This is most secure, but makes it
257impossible to use any scripts other than the \f(CW\*(C`if\-up\*(C'\fR one.
258.IP "chuid = numerical-uid" 4
259.IX Item "chuid = numerical-uid"
260.PD 0
261.IP "chgid = numerical-gid" 4
262.IX Item "chgid = numerical-gid"
263.PD
264These two options tell \s-1GVPE\s0 to change to the given user and/or group id
265after reading all necessary files, binding to sockets and running the
266\&\f(CW\*(C`if\-up\*(C'\fR script.
267.Sp
268Other scripts, such as \f(CW\*(C`node\-up\*(C'\fR, are run with the new user id or group id.
269.IP "chuser = username" 4
270.IX Item "chuser = username"
271Alternative to \f(CW\*(C`chuid\*(C'\fR and \f(CW\*(C`chgid\*(C'\fR: Sets both \f(CW\*(C`chuid\*(C'\fR and \f(CW\*(C`chgid\*(C'\fR
272to the user and (primary) group ids of the specified user (for example,
273\&\f(CW\*(C`nobody\*(C'\fR).
206.IP "dns-forw-host = hostname/ip" 4 274.IP "dns-forw-host = hostname/ip" 4
207.IX Item "dns-forw-host = hostname/ip" 275.IX Item "dns-forw-host = hostname/ip"
208The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol 276The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol
209(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 277(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
210.IP "dns-forw-port = port-number" 4 278.IP "dns-forw-port = port-number" 4
211.IX Item "dns-forw-port = port-number" 279.IX Item "dns-forw-port = port-number"
212The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 280The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
213which is fine in most cases). 281which is fine in most cases).
282.IP "dns-case-preserving = yes|true|on | no|false|off" 4
283.IX Item "dns-case-preserving = yes|true|on | no|false|off"
284Sets whether the \s-1DNS\s0 transport forwarding server preserves case (\s-1DNS\s0
285servers have to, but some access systems are even more broken than others)
286(default: true).
287.Sp
288Normally, when the forwarding server changes the case of domain names then
289\&\s-1GVPE\s0 will automatically set this to false.
214.IP "dns-max-outstanding = integer-number-of-requests" 4 290.IP "dns-max-outstanding = integer-number-of-requests" 4
215.IX Item "dns-max-outstanding = integer-number-of-requests" 291.IX Item "dns-max-outstanding = integer-number-of-requests"
216The maximum number of outstanding \s-1DNS\s0 transport requests 292The maximum number of outstanding \s-1DNS\s0 transport requests
217(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given 293(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
218limit without receiving replies. In heavily overloaded situations it might 294limit without receiving replies. In heavily overloaded situations it might
… …
400currently supported. 476currently supported.
401.IP "keepalive = seconds" 4 477.IP "keepalive = seconds" 4
402.IX Item "keepalive = seconds" 478.IX Item "keepalive = seconds"
403Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this 479Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
404many seconds of inactivity the daemon will start to send keepalive probe 480many seconds of inactivity the daemon will start to send keepalive probe
405every 3 seconds until it receives a reply from the other end. If no reply 481every 3 seconds until it receives a reply from the other end. If no reply
406is received within 15 seconds, the peer is considered unreachable and the 482is received within 15 seconds, the peer is considered unreachable and the
407connection is closed. 483connection is closed.
408.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 484.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
409.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 485.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
410Set the logging level. Connection established messages are logged at level 486Set the logging level. Connection established messages are logged at level
… …
417this information to the \f(CW\*(C`if\-up\*(C'\fR script. 493this information to the \f(CW\*(C`if\-up\*(C'\fR script.
418.Sp 494.Sp
419Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 495Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
420.Sp 496.Sp
421This value must be the minimum of the \s-1MTU\s0 values of all nodes. 497This value must be the minimum of the \s-1MTU\s0 values of all nodes.
422.IP "node = nickname" 4 498.IP "nfmark = integer" 4
423.IX Item "node = nickname" 499.IX Item "nfmark = integer"
424Not really a config setting but introduces a node section. The nickname is 500This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries
425used to select the right configuration section and must be passed as an 501to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
426argument to the gvpe daemon. 502send packets.
503.Sp
504This can be used to make gvpe use a different set of routing rules. For
505example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
506put all routing rules into table \f(CW99\fR and then use an ip rule to make
507gvpe traffic avoid that routing table, in effect routing normal traffic
508via gvpe and gvpe traffic via the normal system routing tables:
509.Sp
510.Vb 1
511\& ip rule add not fwmark 1000 lookup 99
512.Ve
427.IP "node-up = relative-or-absolute-path" 4 513.IP "node-up = relative-or-absolute-path" 4
428.IX Item "node-up = relative-or-absolute-path" 514.IX Item "node-up = relative-or-absolute-path"
429Sets a command (default: none) that should be called whenever a connection 515Sets a command (default: none) that should be called whenever a connection
430is established (even on rekeying operations). Note that node\-up/down 516is established (even on rekeying operations). Note that node\-up/down
431scripts will be run asynchronously, but execution is serialised, so there 517scripts will be run asynchronously, but execution is serialised, so there
… …
464.Vb 6 550.Vb 6
465\& #!/bin/sh 551\& #!/bin/sh
466\& { 552\& {
467\& echo update delete $DESTNODE.lowttl.example.net. a 553\& echo update delete $DESTNODE.lowttl.example.net. a
468\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 554\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
469\& echo 555\& echo
470\& } | nsupdate \-d \-k $CONFBASE:key.example.net. 556\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
471.Ve 557.Ve
472.RE 558.RE
473.IP "node-change = relative-or-absolute-path" 4 559.IP "node-change = relative-or-absolute-path" 4
474.IX Item "node-change = relative-or-absolute-path" 560.IX Item "node-change = relative-or-absolute-path"
… …
478.IX Item "node-down = relative-or-absolute-path" 564.IX Item "node-down = relative-or-absolute-path"
479Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 565Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
480.IP "pid-file = path" 4 566.IP "pid-file = path" 4
481.IX Item "pid-file = path" 567.IX Item "pid-file = path"
482The path to the pid file to check and create 568The path to the pid file to check and create
483(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). 569(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). The first \f(CW%s\fR is replaced by
570the nodename \- any other use of \f(CW\*(C`%\*(C'\fR must be written as \f(CW\*(C`%%\*(C'\fR.
484.IP "private-key = relative-path-to-key" 4 571.IP "private-key = relative-path-to-key" 4
485.IX Item "private-key = relative-path-to-key" 572.IX Item "private-key = relative-path-to-key"
486Sets the path (relative to the config directory) to the private key 573Sets the path (relative to the config directory) to the private key
487(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must 574(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
488be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 575be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
… …
492Since only the private key file of the current node is used and the 579Since only the private key file of the current node is used and the
493private key file should be kept secret per-node to avoid spoofing, it is 580private key file should be kept secret per-node to avoid spoofing, it is
494not recommended to use this feature. 581not recommended to use this feature.
495.IP "rekey = seconds" 4 582.IP "rekey = seconds" 4
496.IX Item "rekey = seconds" 583.IX Item "rekey = seconds"
497Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 584Sets the rekeying interval in seconds (default: \f(CW3607\fR). Connections are
498reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption 585reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
499key. 586key.
500.IP "nfmark = integer" 4 587.IP "seed-device = path" 4
501.IX Item "nfmark = integer" 588.IX Item "seed-device = path"
502This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries 589The random device used to initially and regularly seed the random
503to set the netfilter mark (or fwmark) value on all sockets gvpe uses to 590number generator (default: \fI/dev/urandom\fR). Randomness is of paramount
504send packets. 591importance to the security of the algorithms used in gvpe.
505.Sp 592.Sp
506This can be used to make gvpe use a different set of routing rules. For 593On program start and every seed-interval, gvpe will read 64 octets.
507example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
508put all routing rules into table \f(CW99\fR and then use an ip rule to make
509gvpe traffic avoid that routing table, in effect routing normal traffic
510via gvpe and gvpe traffic via the normal system routing tables:
511.Sp 594.Sp
512.Vb 1 595Setting this path to the empty string will disable this functionality
513\& ip rule add not fwmark 1000 lookup 99 596completely (the underlying crypto library will likely look for entropy
514.Ve 597sources on it's own though, so not all is lost).
598.IP "seed-interval = seconds" 4
599.IX Item "seed-interval = seconds"
600The number of seconds between reseeds of the random number generator
601(default: \f(CW3613\fR). A value of \f(CW0\fR disables this regular reseeding.
602.IP "serial = string" 4
603.IX Item "serial = string"
604The configuration serial number. This can be any string up to 16 bytes
605length. Only when the serial matches on both sides of a conenction will
606the connection succeed. This is \fInot\fR a security mechanism and eay to
607spoof, this mechanism exists to alert users that their config is outdated.
608.Sp
609It's recommended to specify this is a date string such as \f(CW\*(C`2013\-05\-05\*(C'\fR or
610\&\f(CW\*(C`20121205084417).\*(C'\fR
611.Sp
612The exact algorithm is as this: if a connection request is received form a
613node with an identical serial, then it succeeds normally.
614.Sp
615If the remote serial is lower than the local serial, it is ignored.
616.Sp
617If the remote serial is higher than the local serial, a warning message is
618logged.
515.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 619.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
516.IX Subsection "NODE SPECIFIC SETTINGS" 620.IX Subsection "NODE SPECIFIC SETTINGS"
517The following settings are node\-specific, that is, every node can have 621The following settings are node-specific, that is, every node can have
518different settings, even within the same gvpe instance. Settings that are 622different settings, even within the same gvpe instance. Settings that are
519set before the first node section set the defaults, settings that are 623set before the first node section set the defaults, settings that are
520set within a node section only apply to the given node. 624set within a node section only apply to the given node.
521.IP "allow-direct = nodename" 4 625.IP "allow-direct = nodename" 4
522.IX Item "allow-direct = nodename" 626.IX Item "allow-direct = nodename"
… …
638.IX Item "icmp-type = integer" 742.IX Item "icmp-type = integer"
639Sets the type value to be used for outgoing (and incoming) packets sent 743Sets the type value to be used for outgoing (and incoming) packets sent
640via the \s-1ICMP\s0 transport. 744via the \s-1ICMP\s0 transport.
641.Sp 745.Sp
642The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 746The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
643\&\*(L"ping\-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 747\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
644\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 748\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
645.IP "if-up-data = value" 4 749.IP "if-up-data = value" 4
646.IX Item "if-up-data = value" 750.IX Item "if-up-data = value"
647The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR 751The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
648script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. 752script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
… …
650.IX Item "inherit-tos = yes|true|on | no|false|off" 754.IX Item "inherit-tos = yes|true|on | no|false|off"
651Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 755Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
652sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 756sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
653outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 757outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
654to the tunnel device, which is usually what you want. 758to the tunnel device, which is usually what you want.
759.IP "low-power = yes|true|on | no|false|off" 4
760.IX Item "low-power = yes|true|on | no|false|off"
761If true, designates a node as a low-power node. Low-power nodes use
762larger timeouts and try to reduce cpu time. Other nodes talking to a
763low-power node will also use larger timeouts, and will use less aggressive
764optimisations, in the hope of reducing load. Security is not compromised.
765.Sp
766The typical low-power node would be a mobile phone, where wakeups and
767encryption can significantly increase power drain.
655.IP "max-retry = positive-number" 4 768.IP "max-retry = positive-number" 4
656.IX Item "max-retry = positive-number" 769.IX Item "max-retry = positive-number"
657The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 770The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
658retries to establish a connection to this node. When a connection cannot 771retries to establish a connection to this node. When a connection cannot
659be established, gvpe uses exponential back-off capped at this value. It's 772be established, gvpe uses exponential back-off capped at this value. It's
… …
713.IX Item "gvpe.conf" 826.IX Item "gvpe.conf"
714The config file. 827The config file.
715.IP "if-up" 4 828.IP "if-up" 4
716.IX Item "if-up" 829.IX Item "if-up"
717The if-up script 830The if-up script
718.IP "node\-up, node-down" 4 831.IP "node-up, node-down" 4
719.IX Item "node-up, node-down" 832.IX Item "node-up, node-down"
720If used the node up or node-down scripts. 833If used the node up or node-down scripts.
721.IP "hostkey" 4 834.IP "hostkey" 4
722.IX Item "hostkey" 835.IX Item "hostkey"
723The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 836The (default path of the) private key of the current host.
724.IP "pubkey/nodename" 4 837.IP "pubkey/nodename" 4
725.IX Item "pubkey/nodename" 838.IX Item "pubkey/nodename"
726The public keys of the other nodes, one file per node. 839The public keys of the other nodes, one file per node.
727.SH "SEE ALSO" 840.SH "SEE ALSO"
728.IX Header "SEE ALSO" 841.IX Header "SEE ALSO"
729\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 842\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
730.SH "AUTHOR" 843.SH "AUTHOR"
731.IX Header "AUTHOR" 844.IX Header "AUTHOR"
732Marc Lehmann <gvpe@schmorp.de> 845Marc Lehmann <gvpe@schmorp.de>
846.SH "POD ERRORS"
847.IX Header "POD ERRORS"
848Hey! \fBThe above document had some coding errors, which are explained below:\fR
849.IP "Around line 516:" 4
850.IX Item "Around line 516:"
851Unterminated C<...> sequence

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines