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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.25 by pcg, Fri Sep 10 21:13:52 2010 UTC vs.
Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC

… …
28= value> pairs. Empty lines are ignored. Comments start with a C<#> and 28= value> pairs. Empty lines are ignored. Comments start with a C<#> and
29extend to the end of the line. They can be used on their own lines, or 29extend to the end of the line. They can be used on their own lines, or
30after any directives. Whitespace is allowed around the C<=> sign or after 30after any directives. Whitespace is allowed around the C<=> sign or after
31values, but not within the variable names or values themselves. 31values, but not within the variable names or values themselves.
32 32
33The only exception to the above is the "on" directive that can prefix any 33All settings are applied "in order", that is, later settings of the same
34C<name = value> setting and will only "execute" it on the named node, or 34variable overwrite earlier ones.
35(if the nodename starts with "!") on all nodes except the named one.
36 35
36The only exceptions to the above are the "on" and "include" directives:
37
38=over 4
39
40=item on nodename ...
41
42=item on !nodename ...
43
44You can prefix any configuration directive with C<on> and a nodename. GVPE
45will will only "execute" it on the named node, or (if the nodename starts
46with C<!>) on all nodes except the named one.
47
37For example, set the MTU to C<1450> everywhere, loglevel to C<noise> on 48Example: set the MTU to C<1450> everywhere, C<loglevel> to C<noise> on
38branch1, and connect to C<ondemand> everywhere but on branch2: 49C<branch1>, and C<connect> to C<ondemand> everywhere but on branch2.
39 50
40 mtu = 1450 51 mtu = 1450
41 on branch1 loglevel = noise 52 on branch1 loglevel = noise
42 on !branch2 connect = ondemand 53 on !branch2 connect = ondemand
43 54
44All settings are applied "in order", that is, later settings of the same 55=item include relative-or-absolute-path
45variable overwrite earlier ones. 56
57Reads the specified file (the path must not contain whitespace or C<=>
58characters) and evaluate all config directives in it as if they were
59spelled out in place of the C<include> directive.
60
61The path is a printf format string, that is, you must escape any C<%>
62by doubling it, and you can have a single C<%s> inside, which will be
63replaced by the current nodename.
64
65Relative paths are interpreted relative to the GVPE config directory.
66
67Example: include the file F<local.conf> in the config directory on every
68node.
69
70 include local.conf
71
72Example: include a file F<conf/>nodenameF<.conf>
73
74 include conf/%s.conf
75
76=back
46 77
47=head1 ANATOMY OF A CONFIG FILE 78=head1 ANATOMY OF A CONFIG FILE
48 79
49Usually, a config file starts with a few global settings (like the UDP 80Usually, a config file starts with a few global settings (like the UDP
50port to listen on), followed by node-specific sections that begin with a 81port to listen on), followed by node-specific sections that begin with a
… …
76 107
77=item dns-forw-port = port-number 108=item dns-forw-port = port-number
78 109
79The port where the C<dns-forw-host> is to be contacted (default: C<53>, 110The port where the C<dns-forw-host> is to be contacted (default: C<53>,
80which is fine in most cases). 111which is fine in most cases).
112
113=item dns-case-preserving = yes|true|on | no|false|off
114
115Sets whether the DNS transport forwarding server preserves case (DNS
116servers have to, but some access systems are even more broken than others)
117(default: true).
118
119Normally, when the forwarding server changes the case of domain names then
120GVPE will automatically set this to false.
81 121
82=item dns-max-outstanding = integer-number-of-requests 122=item dns-max-outstanding = integer-number-of-requests
83 123
84The maximum number of outstanding DNS transport requests 124The maximum number of outstanding DNS transport requests
85(default: C<100>). GVPE will never issue more requests then the given 125(default: C<100>). GVPE will never issue more requests then the given
… …
424 464
425Allow direct connections to this node. See C<deny-direct> for more info. 465Allow direct connections to this node. See C<deny-direct> for more info.
426 466
427=item compress = yes|true|on | no|false|off 467=item compress = yes|true|on | no|false|off
428 468
469For the current node, this specified whether it will accept compressed
470packets, and for all other nodes, this specifies whether to try to
429Wether to compress data packets sent to this node (default: C<yes>). 471compress data packets sent to this node (default: C<yes>). Compression is
430Compression is really cheap even on slow computers and has no size 472really cheap even on slow computers, has no size overhead at all and will
431overhead at all, so enabling this is often a good idea. 473only be used when the other side supports compression, so enabling this is
474often a good idea.
432 475
433=item connect = ondemand | never | always | disabled 476=item connect = ondemand | never | always | disabled
434 477
435Sets the connect mode (default: C<always>). It can be C<always> (always 478Sets the connect mode (default: C<always>). It can be C<always> (always
436try to establish and keep a connection to the given node), C<never> 479try to establish and keep a connection to the given node), C<never>
… …
527 570
528=item enable-udp = yes|true|on | no|false|off 571=item enable-udp = yes|true|on | no|false|off
529 572
530See gvpe.protocol(7) for a description of the UDP transport protocol. 573See gvpe.protocol(7) for a description of the UDP transport protocol.
531 574
532Enable the UDPv4 transport using the C<udp-port> port (default: C<no>, 575Enable the UDPv4 transport using the C<udp-port> port (default: C<no>).
533unless no other protocol is enabled for a node, in which case this
534protocol is enabled automatically).
535
536NOTE: Please specify C<enable-udp = yes> if you want to use it even though
537it might get switched on automatically, as some future version might
538default to another default protocol.
539 576
540=item hostname = hostname | ip [can not be defaulted] 577=item hostname = hostname | ip [can not be defaulted]
541 578
542Forces the address of this node to be set to the given DNS hostname or IP 579Forces the address of this node to be set to the given DNS hostname or IP
543address. It will be resolved before each connect request, so dyndns should 580address. It will be resolved before each connect request, so dyndns should
… …
562The value specified using this directive will be passed to the C<if-up> 599The value specified using this directive will be passed to the C<if-up>
563script in the environment variable C<IFUPDATA>. 600script in the environment variable C<IFUPDATA>.
564 601
565=item inherit-tos = yes|true|on | no|false|off 602=item inherit-tos = yes|true|on | no|false|off
566 603
567Wether to inherit the TOS settings of packets sent to the tunnel when 604Whether to inherit the TOS settings of packets sent to the tunnel when
568sending packets to this node (default: C<yes>). If set to C<yes> then 605sending packets to this node (default: C<yes>). If set to C<yes> then
569outgoing tunnel packets will have the same TOS setting as the packets sent 606outgoing tunnel packets will have the same TOS setting as the packets sent
570to the tunnel device, which is usually what you want. 607to the tunnel device, which is usually what you want.
571 608
572=item max-retry = positive-number 609=item max-retry = positive-number

Diff Legend

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