[ViewVC] Diff of: cvs/gvpe/doc/gvpe.conf.5.pod

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.30 by root, Tue Dec 4 13:23:17 2012 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
29	extend to the end of the line. They can be used on their own lines, or	29	extend to the end of the line. They can be used on their own lines, or
30	after any directives. Whitespace is allowed around the C<=> sign or after	30	after any directives. Whitespace is allowed around the C<=> sign or after
31	values, but not within the variable names or values themselves.	31	values, but not within the variable names or values themselves.
32		32
33	The only exception to the above is the "on" directive that can prefix any	33	All settings are applied "in order", that is, later settings of the same
34	C<name = value> setting and will only "execute" it on the named node, or	34	variable overwrite earlier ones.
35	(if the nodename starts with "!") on all nodes except the named one.
36		35
		36	The 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
		44	You can prefix any configuration directive with C<on> and a nodename. GVPE
		45	will will only "execute" it on the named node, or (if the nodename starts
		46	with C<!>) on all nodes except the named one.
		47
37	For example, set the MTU to C<1450> everywhere, loglevel to C<noise> on	48	Example: set the MTU to C<1450> everywhere, C<loglevel> to C<noise> on
38	branch1, and connect to C<ondemand> everywhere but on branch2:	49	C<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
44	All settings are applied "in order", that is, later settings of the same	55	=item include relative-or-absolute-path
45	variable overwrite earlier ones.	56
		57	Reads the specified file (the path must not contain whitespace or C<=>
		58	characters) and evaluate all config directives in it as if they were
		59	spelled out in place of the C<include> directive.
		60
		61	The path is a printf format string, that is, you must escape any C<%>
		62	by doubling it, and you can have a single C<%s> inside, which will be
		63	replaced by the current nodename.
		64
		65	Relative paths are interpreted relative to the GVPE config directory.
		66
		67	Example: include the file F<local.conf> in the config directory on every
		68	node.
		69
		70	include local.conf
		71
		72	Example: 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
49	Usually, a config file starts with a few global settings (like the UDP	80	Usually, a config file starts with a few global settings (like the UDP
50	port to listen on), followed by node-specific sections that begin with a	81	port to listen on), followed by node-specific sections that begin with a
…		…
67	values on different nodes using C<on>), but will affect the behaviour of	98	values on different nodes using C<on>), but will affect the behaviour of
68	the gvpe daemon and all connections it creates.	99	the gvpe daemon and all connections it creates.
69		100
70	=over 4	101	=over 4
71		102
		103	=item chroot = path or /
		104
		105	Tells GVPE to chroot(2) to the specified path after reading all necessary
		106	files, binding to sockets and running the C<if-up> script, but before
		107	running C<node-up> or any other scripts.
		108
		109	The special path F</> instructs GVPE to create (and remove) an empty
		110	temporary directory to use as new root. This is most secure, but makes it
		111	impossible to use any scripts other than the C<if-up> one.
		112
		113	=item chuid = numerical-uid
		114
		115	=item chgid = numerical-gid
		116
		117	These two options tell GVPE to change to the given user and/or group id
		118	after reading all necessary files, binding to sockets and running the
		119	C<if-up> script.
		120
		121	Other scripts, such as C<node-up>, are run with the new user id or group id.
		122
		123	=item chuser = username
		124
		125	Alternative to C<chuid> and C<chgid>: Sets both C<chuid> and C<chgid>
		126	to the user and (primary) group ids of the specified user (for example,
		127	C<nobody>).
		128
72	=item dns-forw-host = hostname/ip	129	=item dns-forw-host = hostname/ip
73		130
74	The DNS server to forward DNS requests to for the DNS tunnel protocol	131	The DNS server to forward DNS requests to for the DNS tunnel protocol
75	(default: C<127.0.0.1>, changing it is highly recommended).	132	(default: C<127.0.0.1>, changing it is highly recommended).
76		133
77	=item dns-forw-port = port-number	134	=item dns-forw-port = port-number
78		135
79	The port where the C<dns-forw-host> is to be contacted (default: C<53>,	136	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
80	which is fine in most cases).	137	which is fine in most cases).
		138
		139	=item dns-case-preserving = yes\|true\|on \| no\|false\|off
		140
		141	Sets whether the DNS transport forwarding server preserves case (DNS
		142	servers have to, but some access systems are even more broken than others)
		143	(default: true).
		144
		145	Normally, when the forwarding server changes the case of domain names then
		146	GVPE will automatically set this to false.
81		147
82	=item dns-max-outstanding = integer-number-of-requests	148	=item dns-max-outstanding = integer-number-of-requests
83		149
84	The maximum number of outstanding DNS transport requests	150	The maximum number of outstanding DNS transport requests
85	(default: C<100>). GVPE will never issue more requests then the given	151	(default: C<100>). GVPE will never issue more requests then the given
…		…
284		350
285	=item keepalive = seconds	351	=item keepalive = seconds
286		352
287	Sets the keepalive probe interval in seconds (default: C<60>). After this	353	Sets the keepalive probe interval in seconds (default: C<60>). After this
288	many seconds of inactivity the daemon will start to send keepalive probe	354	many seconds of inactivity the daemon will start to send keepalive probe
289	every 3 seconds until it receives a reply from the other end. If no reply	355	every 3 seconds until it receives a reply from the other end. If no reply
290	is received within 15 seconds, the peer is considered unreachable and the	356	is received within 15 seconds, the peer is considered unreachable and the
291	connection is closed.	357	connection is closed.
292		358
293	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	359	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
294		360
…		…
358		424
359	#!/bin/sh	425	#!/bin/sh
360	{	426	{
361	echo update delete $DESTNODE.lowttl.example.net. a	427	echo update delete $DESTNODE.lowttl.example.net. a
362	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	428	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
363	echo	429	echo
364	} \| nsupdate -d -k $CONFBASE:key.example.net.	430	} \| nsupdate -d -k $CONFBASE:key.example.net.
365		431
366	=item node-change = relative-or-absolute-path	432	=item node-change = relative-or-absolute-path
367		433
368	Same as C<node-change>, but gets called whenever something about a	434	Same as C<node-change>, but gets called whenever something about a
…		…
424		490
425	Allow direct connections to this node. See C<deny-direct> for more info.	491	Allow direct connections to this node. See C<deny-direct> for more info.
426		492
427	=item compress = yes\|true\|on \| no\|false\|off	493	=item compress = yes\|true\|on \| no\|false\|off
428		494
		495	For the current node, this specified whether it will accept compressed
		496	packets, and for all other nodes, this specifies whether to try to
429	Wether to compress data packets sent to this node (default: C<yes>).	497	compress data packets sent to this node (default: C<yes>). Compression is
430	Compression is really cheap even on slow computers and has no size	498	really cheap even on slow computers, has no size overhead at all and will
431	overhead at all, so enabling this is often a good idea.	499	only be used when the other side supports compression, so enabling this is
		500	often a good idea.
432		501
433	=item connect = ondemand \| never \| always \| disabled	502	=item connect = ondemand \| never \| always \| disabled
434		503
435	Sets the connect mode (default: C<always>). It can be C<always> (always	504	Sets the connect mode (default: C<always>). It can be C<always> (always
436	try to establish and keep a connection to the given node), C<never>	505	try to establish and keep a connection to the given node), C<never>
…		…
527		596
528	=item enable-udp = yes\|true\|on \| no\|false\|off	597	=item enable-udp = yes\|true\|on \| no\|false\|off
529		598
530	See gvpe.protocol(7) for a description of the UDP transport protocol.	599	See gvpe.protocol(7) for a description of the UDP transport protocol.
531		600
532	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,	601	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>).
533	unless no other protocol is enabled for a node, in which case this
534	protocol is enabled automatically).
535
536	NOTE: Please specify C<enable-udp = yes> if you want to use it even though
537	it might get switched on automatically, as some future version might
538	default to another default protocol.
539		602
540	=item hostname = hostname \| ip [can not be defaulted]	603	=item hostname = hostname \| ip [can not be defaulted]
541		604
542	Forces the address of this node to be set to the given DNS hostname or IP	605	Forces the address of this node to be set to the given DNS hostname or IP
543	address. It will be resolved before each connect request, so dyndns should	606	address. It will be resolved before each connect request, so dyndns should
…		…
562	The value specified using this directive will be passed to the C<if-up>	625	The value specified using this directive will be passed to the C<if-up>
563	script in the environment variable C<IFUPDATA>.	626	script in the environment variable C<IFUPDATA>.
564		627
565	=item inherit-tos = yes\|true\|on \| no\|false\|off	628	=item inherit-tos = yes\|true\|on \| no\|false\|off
566		629
567	Wether to inherit the TOS settings of packets sent to the tunnel when	630	Whether to inherit the TOS settings of packets sent to the tunnel when
568	sending packets to this node (default: C<yes>). If set to C<yes> then	631	sending packets to this node (default: C<yes>). If set to C<yes> then
569	outgoing tunnel packets will have the same TOS setting as the packets sent	632	outgoing tunnel packets will have the same TOS setting as the packets sent
570	to the tunnel device, which is usually what you want.	633	to the tunnel device, which is usually what you want.
571		634
572	=item max-retry = positive-number	635	=item max-retry = positive-number

Diff Legend

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

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.30 by root, Tue Dec 4 13:23:17 2012 UTC

Diff Legend

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.30 by root, Tue Dec 4 13:23:17 2012 UTC