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.7 by pcg, Sun Mar 6 18:34:46 2005 UTC vs.
Revision 1.8 by pcg, Mon Mar 7 01:31:26 2005 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "GVPE.CONF 5" 131.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2005-03-06" "1.8" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2005-03-07" "1.8" "GNU Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 134gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 3 137.Vb 3
… …
429\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 429\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
430take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 430take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
431don't talk to it). 431don't talk to it).
432.IP "dns-domain = domain-suffix" 4 432.IP "dns-domain = domain-suffix" 4
433.IX Item "dns-domain = domain-suffix" 433.IX Item "dns-domain = domain-suffix"
434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server. Needs to be 434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
435set on both client and server.
436.Sp 435.Sp
437The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 436The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
438i.e. 437i.e.
439.Sp 438.Sp
440.Vb 2 439.Vb 2
… …
453The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 452The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
454but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 453but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
455change. 454change.
456.IP "dns-port = port-number" 4 455.IP "dns-port = port-number" 4
457.IX Item "dns-port = port-number" 456.IX Item "dns-port = port-number"
458The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW0\fR on all \s-1DNS\s0 tunnel 457The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
459clients and \f(CW53\fR on the server. 458.IP "enable-dns = yes|true|on | no|false|off" 4
459.IX Item "enable-dns = yes|true|on | no|false|off"
460Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
461client (only available when gvpe was compiled with \f(CW\*(C`\-\-enable\-dns\*(C'\fR).
462.Sp
463This is the worst choice of transport protocol with respect to overhead
464(overhead cna be 2\-3 times higher than the transferred data), and probably
465the best choice when tunneling through firewalls.
460.IP "enable-rawip = yes|true|on | no|false|off" 4 466.IP "enable-rawip = yes|true|on | no|false|off" 4
461.IX Item "enable-rawip = yes|true|on | no|false|off" 467.IX Item "enable-rawip = yes|true|on | no|false|off"
462Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 468Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
463(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet 469(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the minimum overhead per
464is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). 470packet is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
465.IP "enable-tcp = yes|true|on | no|false|off" 4 471.IP "enable-tcp = yes|true|on | no|false|off" 4
466.IX Item "enable-tcp = yes|true|on | no|false|off" 472.IX Item "enable-tcp = yes|true|on | no|false|off"
467Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 473Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
468(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only 474(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only
469available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never 475available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never
470use this transport unless you really must, it is horribly ineffiecent and 476use this transport unless you really must, it is very inefficient and
471resource-intensive compared to the other transports. 477resource-intensive compared to the other transports (except for \s-1DNS\s0, which
478is worse).
472.IP "enable-udp = yes|true|on | no|false|off" 4 479.IP "enable-udp = yes|true|on | no|false|off" 4
473.IX Item "enable-udp = yes|true|on | no|false|off" 480.IX Item "enable-udp = yes|true|on | no|false|off"
474Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 481Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
475unless no other protocol is enabled for a node, in which case this 482unless no other protocol is enabled for a node, in which case this
476protocol is enabled automatically). This is a good general choice since 483protocol is enabled automatically). This is a good general choice since
… …
485sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 492sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
486outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 493outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
487to the tunnel device, which is usually what you want. 494to the tunnel device, which is usually what you want.
488.IP "max-retry = positive-number" 4 495.IP "max-retry = positive-number" 4
489.IX Item "max-retry = positive-number" 496.IX Item "max-retry = positive-number"
490The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between 497The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
491retries to establish a connection to this node. When a connection cannot 498retries to establish a connection to this node. When a connection cannot
492be established, gvpe uses exponential backoff capped at this value. It's 499be established, gvpe uses exponential backoff capped at this value. It's
493sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 500sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
494connections to routers that usually are stable but sometimes are down, to 501connections to routers that usually are stable but sometimes are down, to
495assure quick reconnections. 502assure quick reconnections even after longer downtimes.
496.IP "router-priority = 0 | 1 | positive\-number>2" 4 503.IP "router-priority = 0 | 1 | positive\-number>=2" 4
497.IX Item "router-priority = 0 | 1 | positive-number>2" 504.IX Item "router-priority = 0 | 1 | positive-number>=2"
498Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 505Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
499some host tries to connect to another host without a hostname, it asks 506some host tries to connect to another host without a hostname, it asks
500the router host for it's \s-1IP\s0 address. The router host is the one with the 507the router host for it's \s-1IP\s0 address. The router host is the one with the
501highest priority larger than \f(CW1\fR that is currently reachable. 508highest priority larger than \f(CW1\fR that is currently reachable.
502.Sp 509.Sp

Diff Legend

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