--- gvpe/doc/gvpe.conf.5 2005/03/06 18:34:46 1.7 +++ gvpe/doc/gvpe.conf.5 2005/03/17 23:59:37 1.11 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "GVPE.CONF 5" -.TH GVPE.CONF 5 "2005-03-06" "1.8" "GNU Virtual Private Ethernet" +.TH GVPE.CONF 5 "2005-03-17" "1.8" "GNU Virtual Private Ethernet" .SH "NAME" gvpe.conf \- configuration file for the GNU VPE daemon .SH "SYNOPSIS" @@ -431,8 +431,7 @@ don't talk to it). .IP "dns-domain = domain-suffix" 4 .IX Item "dns-domain = domain-suffix" -The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server. Needs to be -set on both client and server. +The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. .Sp The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, i.e. @@ -455,30 +454,53 @@ change. .IP "dns-port = port-number" 4 .IX Item "dns-port = port-number" -The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW0\fR on all \s-1DNS\s0 tunnel -clients and \f(CW53\fR on the server. +The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. +.IP "enable-dns = yes|true|on | no|false|off" 4 +.IX Item "enable-dns = yes|true|on | no|false|off" +See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport +protocol. Avoid this protocol if you can. +.Sp +Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as +client. Support for this transport protocol is only available when gvpe +was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. +.IP "enable-icmp = yes|true|on | no|false|off" 4 +.IX Item "enable-icmp = yes|true|on | no|false|off" +See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. +.Sp +Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this +node. .IP "enable-rawip = yes|true|on | no|false|off" 4 .IX Item "enable-rawip = yes|true|on | no|false|off" +See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. +.Sp Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol -(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet -is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). +(default: \f(CW\*(C`no\*(C'\fR). .IP "enable-tcp = yes|true|on | no|false|off" 4 .IX Item "enable-tcp = yes|true|on | no|false|off" +See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. +.Sp Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port -(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only -available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never -use this transport unless you really must, it is horribly ineffiecent and -resource-intensive compared to the other transports. +(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available +when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. .IP "enable-udp = yes|true|on | no|false|off" 4 .IX Item "enable-udp = yes|true|on | no|false|off" +See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. +.Sp Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, unless no other protocol is enabled for a node, in which case this -protocol is enabled automatically). This is a good general choice since -\&\s-1UDP\s0 tunnels well through many firewalls. +protocol is enabled automatically). .Sp \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though it might get switched on automatically, as some future version might default to another default protocol. +.IP "icmp-type = integer" 4 +.IX Item "icmp-type = integer" +Sets the type value to be used for outgoing (and incoming) packets sent +via the \s-1ICMP\s0 transport. +.Sp +The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as +\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. +\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. .IP "inherit-tos = yes|true|on | no|false|off" 4 .IX Item "inherit-tos = yes|true|on | no|false|off" Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when @@ -487,14 +509,14 @@ to the tunnel device, which is usually what you want. .IP "max-retry = positive-number" 4 .IX Item "max-retry = positive-number" -The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between +The maximum interval in seconds (default: \f(CW3600\fR, one hour) between retries to establish a connection to this node. When a connection cannot be established, gvpe uses exponential backoff capped at this value. It's sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on connections to routers that usually are stable but sometimes are down, to -assure quick reconnections. -.IP "router-priority = 0 | 1 | positive\-number>2" 4 -.IX Item "router-priority = 0 | 1 | positive-number>2" +assure quick reconnections even after longer downtimes. +.IP "router-priority = 0 | 1 | positive\-number>=2" 4 +.IX Item "router-priority = 0 | 1 | positive-number>=2" Sets the router priority of the given host (default: \f(CW0\fR, disabled). If some host tries to connect to another host without a hostname, it asks the router host for it's \s-1IP\s0 address. The router host is the one with the