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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.6 by pcg, Sun Mar 6 18:34:46 2005 UTC vs.
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC

…		…
21	=head1 DESCRIPTION	21	=head1 DESCRIPTION
22		22
23	The gvpe config file consists of a series of lines that contain C<variable	23	The gvpe config file consists of a series of lines that contain C<variable
24	= value> pairs. Empty lines are ignored. Comments start with a C<#> and	24	= value> pairs. Empty lines are ignored. Comments start with a C<#> and
25	extend to the end of the line. They can be used on their own lines, or	25	extend to the end of the line. They can be used on their own lines, or
26	after any directives. Spaces are allowed before or after the C<=> sign or	26	after any directives. Whitespace is allowed around the C<=> sign or after
27	after values, but not within the variable names or values themselves.	27	values, but not within the variable names or values themselves.
28		28
29	The only exception to the above is the "on" directive that can prefix any	29	The only exception to the above is the "on" directive that can prefix any
30	C<name = value> setting and will only "execute" it on the named node, or	30	C<name = value> setting and will only "execute" it on the named node, or
31	(if the nodename starts with "!") on all nodes except the named one.	31	(if the nodename starts with "!") on all nodes except the named one.
32		32
…		…
43	listen on), followed by node-specific sections that begin with a C<node =	43	listen on), followed by node-specific sections that begin with a C<node =
44	nickname> line.	44	nickname> line.
45		45
46	Every node that is part of the network must have a section that starts	46	Every node that is part of the network must have a section that starts
47	with C<node = nickname>. The number and order of the nodes is important	47	with C<node = nickname>. The number and order of the nodes is important
48	and must be the same on all hosts. It is not uncommon for node sections to	48	and must be the same on all nodes. It is not uncommon for node sections to
49	be completely empty - if the default values are right.	49	be completely empty - if the default values are right.
50		50
51	Node-specific settings can be used at any time. If used before the first	51	Node-specific settings can be used at any time. If used before the first
52	node section they will set the default values for all following nodes.	52	node section they will set the default values for all following nodes.
53		53
…		…
70	=item dns-forw-port = port-number	70	=item dns-forw-port = port-number
71		71
72	The port where the C<dns-forw-host> is to be contacted (default: C<53>,	72	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
73	which is fine in most cases).	73	which is fine in most cases).
74		74
		75	=item dns-max-outstanding = integer-number-of-requests
		76
		77	The maximum number of outstanding DNS transport requests
		78	(default: C<100>). GVPE will never issue more requests then the given
		79	limit without receiving replies. In heavily overloaded situations it might
		80	help to set this to a low number (e.g. C<3> or even C<1>) to limit the
		81	number of parallel requests.
		82
		83	The default should be working ok for most links.
		84
		85	=item dns-overlap-factor = float
		86
		87	The DNS transport uses the minimum request latency (B<min_latency>) seen
		88	during a connection as it's timing base. This factor (default: C<0.5>,
		89	must be > 0) is multiplied by B<min_latency> to get the maximum sending
		90	rate (= minimum send interval), i.e. a factor of C<1> means that a new
		91	request might be generated every B<min_latency> seconds, which means on
		92	average there should only ever be one outstanding request. A factor of
		93	C<0.5> means that GVPE will send requests twice as often as the minimum
		94	latency measured.
		95
		96	For congested or picky dns forwarders you could use a value nearer to or
		97	exceeding C<1>.
		98
		99	The default should be working ok for most links.
		100
		101	=item dns-send-interval = send-interval-in-seconds
		102
		103	The minimum send interval (= maximum rate) that the DNS transport will
		104	use to send new DNS requests. GVPE will not exceed this rate even when
		105	the latency is very low. The default is C<0.01>, which means GVPE will
		106	not send more than 100 DNS requests per connection per second. For
		107	high-bandwidth links you could go lower, e.g. to C<0.001> or so. For
		108	congested or rate-limited links, you might want to go higher, say C<0.1>,
		109	C<0.2> or even higher.
		110
		111	The default should be working ok for most links.
		112
		113	=item dns-timeout-factor = float
		114
		115	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to
		116	get request timeouts. The default of C<8> means that the DNS transport
		117	will resend the request when no reply has been received for longer than
		118	eight times the minimum (= expected) latency, assuming the request or
		119	reply has been lost.
		120
		121	For congested links a higher value might be necessary (e.g. C<30>). If
		122	the link is very stable lower values (e.g. C<2>) might work
		123	nicely. Values near or below C<1> makes no sense whatsoever.
		124
		125	The default should be working ok for most links but will result in low
		126	throughput if packet loss is high.
		127
75	=item if-up = relative-or-absolute-path	128	=item if-up = relative-or-absolute-path
76		129
77	Sets the path of a script that should be called immediately after the	130	Sets the path of a script that should be called immediately after the
78	network interface is initialized (but not neccessarily up). The following	131	network interface is initialized (but not neccessarily up). The following
79	environment variables are passed to it (the values are just examples):	132	environment variables are passed to it (the values are just examples).
		133
		134	Variables that have the same value on all nodes:
80		135
81	=over 4	136	=over 4
82		137
83	=item CONFBASE=/etc/gvpe	138	=item CONFBASE=/etc/gvpe
84		139
85	The configuration base directory.	140	The configuration base directory.
86		141
87	=item IFNAME=vpn0	142	=item IFNAME=vpn0
88		143
89	The interface to initialize.	144	The network interface to initialize.
		145
		146	=item IFTYPE=native # or tincd
		147
		148	=item IFSUBTYPE=linux # or freebsd, darwin etc..
		149
		150	The interface type (C<native> or C<tincd>) and the subtype (usually the
		151	OS name in lowercase) that this GVPE was configured for. Can be used to
		152	select the correct syntax to use for network-related commands.
90		153
91	=item MTU=1436	154	=item MTU=1436
92		155
93	The MTU to set the interface to. You can use lower values (if done	156	The MTU to set the interface to. You can use lower values (if done
94	consistently on all hosts), but this is usually ineffective.	157	consistently on all nodes), but this is usually either inefficient or
		158	simply ineffective.
		159
		160	=item NODES=5
		161
		162	The number of nodes in this GVPE network.
		163
		164	=back
		165
		166	Variables that are node-specific and with values pertaining to the node
		167	running this GVPE:
		168
		169	=over 4
		170
		171	=item IFUPDATA=string
		172
		173	The value of the configuration directive C<if-up-data>.
95		174
96	=item MAC=fe:fd:80:00:00:01	175	=item MAC=fe:fd:80:00:00:01
97		176
98	The MAC address to set the interface to. The script must set the	177	The MAC address the network interface has to use.
99	interface MAC to this value. You will most likely use one of these:
100		178
101	ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux	179	Might be used to initialize interfaces on platforms where GVPE does not
102	ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD	180	do this automatically. Please see the C<gvpe.osdep(5)> manpage for
103		181	platform-specific information.
104	Please see the C<gvpe.osdep(5)> manpage for platform-specific information.
105
106	=item IFTYPE=native # or tincd
107
108	=item IFSUBTYPE=linux # or freebsd, darwin etc..
109
110	The interface type (C<native> or C<tincd>) and the subtype (usually the os
111	name in lowercase) that this gvpe was configured for. Can be used to select
112	the correct syntax to use for network-related commands.
113		182
114	=item NODENAME=branch1	183	=item NODENAME=branch1
115		184
116	The nickname of the current node, as passed to the gvpe daemon.	185	The nickname of the node.
117		186
118	=item NODEID=1	187	=item NODEID=1
119		188
120	The numerical node id of the current node. The first node mentioned in the	189	The numerical node ID of the node running this instance of GVPE. The first
121	config file gets ID 1, the second ID 2 and so on.	190	node mentioned in the config file gets ID 1, the second ID 2 and so on.
122		191
123	=back	192	=back
124		193
		194	In addition, all node-specific variables (except C<NODEID>) will be
		195	available with a postfix of C<_nodeid>, which contains the value for that
		196	node, e.g. the C<MAC_1> variable contains the MAC address of node #1, while
		197	the C<NODENAME_22> variable contains the name of node #22.
		198
125	Here is a simple if-up script:	199	Here is a simple if-up script:
126		200
127	#!/bin/sh	201	#!/bin/sh
128	ip link set $IFNAME address $MAC mtu $MTU up	202	ip link set $IFNAME up
129	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME	203	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
130	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME	204	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
131	ip route add 10.0.0.0/8 dev $IFNAME	205	ip route add 10.0.0.0/8 dev $IFNAME
132		206
133	More complicated examples (using routing to reduce arp traffic) can be	207	More complicated examples (using routing to reduce arp traffic) can be
…		…
148	device.	222	device.
149		223
150	=item ip-proto = numerical-ip-protocol	224	=item ip-proto = numerical-ip-protocol
151		225
152	Sets the protocol number to be used for the rawip protocol. This is a	226	Sets the protocol number to be used for the rawip protocol. This is a
153	global option because all hosts must use the same protocol, and since	227	global option because all nodes must use the same protocol, and since
154	there are no port numbers, you cannot easily run more than one gvpe	228	there are no port numbers, you cannot easily run more than one gvpe
155	instance using the same protocol, nor can you share the protocol with	229	instance using the same protocol, nor can you share the protocol with
156	other programs.	230	other programs.
157		231
158	The default is 47 (GRE), which has a good chance of tunneling through	232	The default is 47 (GRE), which has a good chance of tunneling through
…		…
173	Please note that gvpe will still try to resolve all hostnames in the	247	Please note that gvpe will still try to resolve all hostnames in the
174	configuration file, so if you are behind a proxy without access to a dns	248	configuration file, so if you are behind a proxy without access to a dns
175	server better use numerical IP addresses.	249	server better use numerical IP addresses.
176		250
177	To make best use of this option disable all protocols except tcp in your	251	To make best use of this option disable all protocols except tcp in your
178	config file and make sure your routers (or all other hosts) are listening	252	config file and make sure your routers (or all other nodes) are listening
179	on a port that the proxy allows (443, https, is a common choice).	253	on a port that the proxy allows (443, https, is a common choice).
180		254
181	If you have a router, connecting to it will suffice. Otherwise tcp must be	255	If you have a router, connecting to it will suffice. Otherwise tcp must be
182	enabled on all hosts.	256	enabled on all nodes.
183		257
184	Example:	258	Example:
185		259
186	http-proxy-host = proxy.example.com	260	http-proxy-host = proxy.example.com
187	http-proxy-port = 3128 # 8080 is another common choice	261	http-proxy-port = 3128 # 8080 is another common choice
…		…
217	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	291	maximum overhead (e.g. udp header size, encryption blocksize...) and pass
218	this information to the C<if-up> script.	292	this information to the C<if-up> script.
219		293
220	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	294	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
221		295
222	This value must be the minimum of the mtu values of all hosts.	296	This value must be the minimum of the mtu values of all nodes.
223		297
224	=item node = nickname	298	=item node = nickname
225		299
226	Not really a config setting but introduces a node section. The nickname is	300	Not really a config setting but introduces a node section. The nickname is
227	used to select the right configuration section and must be passed as an	301	used to select the right configuration section and must be passed as an
228	argument to the gvpe daemon.	302	argument to the gvpe daemon.
229		303
230	=item node-up = relative-or-absolute-path	304	=item node-up = relative-or-absolute-path
231		305
232	Sets a command (default: no script) that should be called whenever a	306	Sets a command (default: none) that should be called whenever a connection
233	connection is established (even on rekeying operations). In addition	307	is established (even on rekeying operations). Note that node-up/down
		308	scripts will be run asynchronously, but execution is serialised, so there
		309	will only ever be one such script running.
		310
234	to the variables passed to C<if-up> scripts, the following environment	311	In addition to all the variables passed to C<if-up> scripts, the following
235	variables will be set:	312	environment variables will be set:
236		313
237	=over 4	314	=over 4
238		315
239	=item DESTNODE=branch2	316	=item DESTNODE=branch2
240		317
…		…
244		321
245	The node id of the remote node.	322	The node id of the remote node.
246		323
247	=item DESTIP=188.13.66.8	324	=item DESTIP=188.13.66.8
248		325
249	The numerical IP address of the remote host (gvpe accepts connections from	326	The numerical IP address of the remote node (gvpe accepts connections from
250	everywhere, as long as the other host can authenticate itself).	327	everywhere, as long as the other node can authenticate itself).
251		328
252	=item DESTPORT=655 # deprecated	329	=item DESTPORT=655 # deprecated
253		330
254	The UDP port used by the other side.	331	The UDP port used by the other side.
255		332
…		…
286	be doubled. A single C<%s> is replaced by the hostname, so you could	363	be doubled. A single C<%s> is replaced by the hostname, so you could
287	use paths like C<hostkeys/%s> to fetch the files at the location where	364	use paths like C<hostkeys/%s> to fetch the files at the location where
288	C<gvpectrl> puts them.	365	C<gvpectrl> puts them.
289		366
290	Since only the private key file of the current node is used and the	367	Since only the private key file of the current node is used and the
291	private key file should be kept secret per-host to avoid spoofings, it is	368	private key file should be kept secret per-node to avoid spoofings, it is
292	not recommended to use this feature.	369	not recommended to use this feature.
293		370
294	=item rekey = seconds	371	=item rekey = seconds
295		372
296	Sets the rekeying interval in seconds (default: C<3600>). Connections are	373	Sets the rekeying interval in seconds (default: C<3600>). Connections are
…		…
300		377
301	=head2 NODE SPECIFIC SETTINGS	378	=head2 NODE SPECIFIC SETTINGS
302		379
303	The following settings are node-specific, that is, every node can have	380	The following settings are node-specific, that is, every node can have
304	different settings, even within the same gvpe instance. Settings that are	381	different settings, even within the same gvpe instance. Settings that are
305	executed before the first node section set the defaults, settings that are	382	set before the first node section set the defaults, settings that are
306	executed within a node section only apply to the given node.	383	set within a node section only apply to the given node.
307		384
308	=over 4	385	=over 4
309		386
		387	=item allow-direct = nodename
		388
		389	Allow direct connections to this node. See C<deny-direct> for more info.
		390
310	=item compress = yes\|true\|on \| no\|false\|off	391	=item compress = yes\|true\|on \| no\|false\|off
311		392
312	Wether to compress data packets sent to this host (default: C<yes>).	393	Wether to compress data packets sent to this node (default: C<yes>).
313	Compression is really cheap even on slow computers and has no size	394	Compression is really cheap even on slow computers and has no size
314	overhead at all, so enabling this is a good idea.	395	overhead at all, so enabling this is a good idea.
315		396
316	=item connect = ondemand \| never \| always \| disabled	397	=item connect = ondemand \| never \| always \| disabled
317		398
318	Sets the connect mode (default: C<always>). It can be C<always> (always	399	Sets the connect mode (default: C<always>). It can be C<always> (always
319	try to establish and keep a connection to the given host), C<never>	400	try to establish and keep a connection to the given node), C<never>
320	(never initiate a connection to the given host, but accept connections),	401	(never initiate a connection to the given host, but accept connections),
321	C<ondemand> (try to establish a connection on the first packet sent, and	402	C<ondemand> (try to establish a connection when there are outstanding
322	take it down after the keepalive interval) or C<disabled> (node is bad,	403	packets in the queue and take it down after the keepalive interval) or
323	don't talk to it).	404	C<disabled> (node is bad, don't talk to it).
		405
		406	Routers will automatically be forced to C<always> unless they are
		407	C<disabled>, to ensure all nodes can talk to each other.
		408
		409	=item deny-direct = nodename \| *
		410
		411	Deny direct connections to the specified node (or all nodes when C<*>
		412	is given). Only one node can be specified, but you can use multiple
		413	C<allow-direct> and C<deny-direct> statements. This only makes sense in
		414	networks with routers, as routers are required for indirect connections.
		415
		416	Sometimes, a node cannot reach some other nodes for reasons of network
		417	connectivity. For example, a node behind a firewall that only allows
		418	conenctions to/from a single other node in the network. In this case one
		419	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
		420	node I<must> be a router for this to work).
		421
		422	The algorithm to check wether a connection may be direct is as follows:
		423
		424	1. Other node mentioned in a C<allow-direct>? If yes, allow the connection.
		425
		426	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
		427
		428	3. Allow the connection.
		429
		430	That is, C<allow-direct> takes precedence over C<deny-direct>.
		431
		432	The check is done in both directions, i.e. both nodes must allow a direct
		433	connection before one is attempted, so you only need to specify connect
		434	limitations on one node.
324		435
325	=item dns-domain = domain-suffix	436	=item dns-domain = domain-suffix
326		437
327	The DNS domain suffix that points to the DNS tunnel server. Needs to be	438	The DNS domain suffix that points to the DNS tunnel server for this node.
328	set on both client and server.
329		439
330	The domain must point to a NS record that points to the I<dns-hostname>,	440	The domain must point to a NS record that points to the I<dns-hostname>,
331	i.e.	441	i.e.
332		442
333	dns-domainname = tunnel.example.net	443	dns-domainname = tunnel.example.net
…		…
344	but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might	454	but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might
345	change.	455	change.
346		456
347	=item dns-port = port-number	457	=item dns-port = port-number
348		458
349	The port to bind the DNS tunnel socket to. Must be C<0> on all DNS tunnel	459	The port to bind the DNS tunnel socket to. Must be C<53> on DNS tunnel servers.
350	clients and C<53> on the server.	460
		461	=item enable-dns = yes\|true\|on \| no\|false\|off
		462
		463	See gvpe.protocol(7) for a description of the DNS transport
		464	protocol. Avoid this protocol if you can.
		465
		466	Enable the DNS tunneling protocol on this node, either as server or as
		467	client. Support for this transport protocol is only available when gvpe
		468	was compiled using the C<--enable-dns> option.
		469
		470	=item enable-icmp = yes\|true\|on \| no\|false\|off
		471
		472	See gvpe.protocol(7) for a description of the ICMP transport protocol.
		473
		474	Enable the ICMP transport using icmp packets of type C<icmp-type> on this
		475	node.
351		476
352	=item enable-rawip = yes\|true\|on \| no\|false\|off	477	=item enable-rawip = yes\|true\|on \| no\|false\|off
353		478
		479	See gvpe.protocol(7) for a description of the RAW IP transport protocol.
		480
354	Enable the RAW IPv4 transport using the C<ip-proto> protocol	481	Enable the RAW IPv4 transport using the C<ip-proto> protocol
355	(default: C<no>). This is the best choice, since the overhead per packet	482	(default: C<no>).
356	is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).
357		483
358	=item enable-tcp = yes\|true\|on \| no\|false\|off	484	=item enable-tcp = yes\|true\|on \| no\|false\|off
359		485
		486	See gvpe.protocol(7) for a description of the TCP transport protocol.
		487
360	Enable the TCPv4 transport using the C<tcp-port> port	488	Enable the TCPv4 transport using the C<tcp-port> port
361	(default: C<no>). Support for this horribly unsuitable protocol is only	489	(default: C<no>). Support for this transport protocol is only available
362	available when gvpe was compiled using the C<--enable-tcp> option. Never	490	when gvpe was compiled using the C<--enable-tcp> option.
363	use this transport unless you really must, it is horribly ineffiecent and
364	resource-intensive compared to the other transports.
365		491
366	=item enable-udp = yes\|true\|on \| no\|false\|off	492	=item enable-udp = yes\|true\|on \| no\|false\|off
		493
		494	See gvpe.protocol(7) for a description of the UDP transport protocol.
367		495
368	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,	496	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,
369	unless no other protocol is enabled for a node, in which case this	497	unless no other protocol is enabled for a node, in which case this
370	protocol is enabled automatically). This is a good general choice since	498	protocol is enabled automatically).
371	UDP tunnels well through many firewalls.
372		499
373	NOTE: Please specify C<enable-udp = yes> if you want t use it even though	500	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
374	it might get switched on automatically, as some future version might	501	it might get switched on automatically, as some future version might
375	default to another default protocol.	502	default to another default protocol.
		503
		504	=item hostname = hostname \| ip [can not be defaulted]
		505
		506	Forces the address of this node to be set to the given dns hostname or ip
		507	address. It will be resolved before each connect request, so dyndns should
		508	work fine. If this setting is not specified and a router is available,
		509	then the router will be queried for the address of this node. Otherwise,
		510	the connection attempt will fail.
		511
		512	=item icmp-type = integer
		513
		514	Sets the type value to be used for outgoing (and incoming) packets sent
		515	via the ICMP transport.
		516
		517	The default is C<0> (which is C<echo-reply>, also known as
		518	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.
		519	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
		520
		521	=item if-up-data = value
		522
		523	The value specified using this directive will be passed to the C<if-up>
		524	script in the environment variable C<IFUPDATA>.
376		525
377	=item inherit-tos = yes\|true\|on \| no\|false\|off	526	=item inherit-tos = yes\|true\|on \| no\|false\|off
378		527
379	Wether to inherit the TOS settings of packets sent to the tunnel when	528	Wether to inherit the TOS settings of packets sent to the tunnel when
380	sending packets to this node (default: C<yes>). If set to C<yes> then	529	sending packets to this node (default: C<yes>). If set to C<yes> then
381	outgoing tunnel packets will have the same TOS setting as the packets sent	530	outgoing tunnel packets will have the same TOS setting as the packets sent
382	to the tunnel device, which is usually what you want.	531	to the tunnel device, which is usually what you want.
383		532
384	=item max-retry = positive-number	533	=item max-retry = positive-number
385		534
386	The maximum interval in seconds (default: C<28800>, 8 hours) between	535	The maximum interval in seconds (default: C<3600>, one hour) between
387	retries to establish a connection to this node. When a connection cannot	536	retries to establish a connection to this node. When a connection cannot
388	be established, gvpe uses exponential backoff capped at this value. It's	537	be established, gvpe uses exponential backoff capped at this value. It's
389	sometimes useful to set this to a much lower value (e.g. C<120>) on	538	sometimes useful to set this to a much lower value (e.g. C<120>) on
390	connections to routers that usually are stable but sometimes are down, to	539	connections to routers that usually are stable but sometimes are down, to
391	assure quick reconnections.	540	assure quick reconnections even after longer downtimes.
392		541
		542	=item max-ttl = seconds
		543
		544	Expire packets that couldn't be sent after this many seconds
		545	(default: C<60>). Gvpe will normally queue packets for a node without an
		546	active connection, in the hope of establishing a connection soon. This
		547	value specifies the maximum lifetime a packet will stay in the queue, if a
		548	packet gets older, it will be thrown away.
		549
		550	=item max-queue = positive-number>=1
		551
		552	The maximum number of packets that will be queued (default: C<512>)
		553	for this node. If more packets are sent then earlier packets will be
		554	expired. See C<max-ttl>, above.
		555
393	=item router-priority = 0 \| 1 \| positive-number>2	556	=item router-priority = 0 \| 1 \| positive-number>=2
394		557
395	Sets the router priority of the given host (default: C<0>, disabled). If	558	Sets the router priority of the given node (default: C<0>, disabled).
396	some host tries to connect to another host without a hostname, it asks
397	the router host for it's IP address. The router host is the one with the
398	highest priority larger than C<1> that is currently reachable.
399		559
400	Make sure all hosts always connect (C<connect = always>) to the router	560	If some node tries to connect to another node but it doesn't have a
401	hosts, otherwise connecting to them might be impossible.	561	hostname, it asks a router node for it's IP address. The router node
		562	chosen is the one with the highest priority larger than C<1> that is
		563	currently reachable. This is called a I<mediated> connection, as the
		564	connection itself will still be direct, but it uses another node to
		565	mediate between the two nodes.
		566
		567	The value C<0> disables routing, that means if the node receives a packet
		568	not for itself it will not forward it but instead drop it.
402		569
403	The special value C<1> allows other hosts to route through the router	570	The special value C<1> allows other hosts to route through the router
404	host, but they will never route through it by default. The value C<0>	571	host, but they will never route through it by default (i.e. the config
405	disables routing. The idea behind this is that some hosts can, if	572	file of another node needs to specify a router priority higher than one
		573	to choose such a node for routing).
		574
		575	The idea behind this is that some hosts can, if required, bump the
406	required, bump the C<router-priority> setting to higher than C<1> in their	576	C<router-priority> setting to higher than C<1> in their local config to
407	local config to route through specific hosts. If C<router-priority> is	577	route through specific hosts. If C<router-priority> is C<0>, then routing
408	C<0>, then routing will be refused, so C<1> serves as a "enable, but do	578	will be refused, so C<1> serves as a "enable, but do not use by default"
409	not use by default" switch.	579	switch.
		580
		581	Nodes with C<router-priority> set to C<2> or higher will always be forced
		582	to C<connect> = C<always> (unless they are C<disabled>).
410		583
411	=item tcp-port = port-number	584	=item tcp-port = port-number
412		585
413	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.	586	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
414		587
…		…
451		624
452	gvpe(5), gvpe(8), gvpectrl(8).	625	gvpe(5), gvpe(8), gvpectrl(8).
453		626
454	=head1 AUTHOR	627	=head1 AUTHOR
455		628
456	Marc Lehmann <gvpe@plan9.de>	629	Marc Lehmann <gvpe@schmorp.de>
457		630

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.6 by pcg, Sun Mar 6 18:34:46 2005 UTC vs. Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.6 by pcg, Sun Mar 6 18:34:46 2005 UTC vs.
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC