--- gvpe/doc/gvpe.conf.5 2005/03/14 17:40:01 1.9 +++ gvpe/doc/gvpe.conf.5 2005/03/17 22:24:31 1.10 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "GVPE.CONF 5" -.TH GVPE.CONF 5 "2005-03-14" "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" @@ -457,35 +457,38 @@ 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 (only available when gvpe was compiled with \f(CW\*(C`\-\-enable\-dns\*(C'\fR). +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 -\&\fB\s-1WARNING:\s0\fR Parsing and generating \s-1DNS\s0 packets is rather tricky. The code -almost certainly contains buffer overflows and other, likely exploitable, -bugs. You have been warned. -.Sp -This is the worst choice of transport protocol with respect to overhead -(overhead can be 2\-3 times higher than the transferred data), and probably -the best choice when tunneling through firewalls. +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 minimum 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 very inefficient and -resource-intensive compared to the other transports (except for \s-1DNS\s0, which -is worse). +(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