--- gvpe/doc/vped.conf.5	2003/03/24 15:20:24	1.4
+++ gvpe/doc/vped.conf.5	2004/05/10 18:57:07	1.11
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.36, Pod::Parser v1.13
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -38,8 +38,8 @@
 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 .    ds L" ""
 .    ds R" ""
-.    ds C` ""
-.    ds C' ""
+.    ds C` 
+.    ds C' 
 'br\}
 .el\{\
 .    ds -- \|\(em\|
@@ -129,12 +129,13 @@
 .\" ========================================================================
 .\"
 .IX Title "VPED.CONF 5"
-.TH VPED.CONF 5 "2003-03-24" "0.1" "Virtual Private Ethernet"
+.TH VPED.CONF 5 "2004-04-01" "1.5" "Virtual Private Ethernet"
 .SH "NAME"
 vped.conf \- vpe daemon configuration file
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-.Vb 3
+.Vb 4
+\&   enable-udp = yes
 \&   udp-port = 407
 \&   mtu = 1492
 \&   ifname = vpn0
@@ -216,8 +217,8 @@
 Since only the private key file of the current node is used and the
 private key file should be kept secret per-host to avoid spoofings, it is
 not recommended to use this feature.
-.IP "ifpersist = yes|no" 4
-.IX Item "ifpersist = yes|no"
+.IP "ifpersist = yes|true|on | no|false|off" 4
+.IX Item "ifpersist = yes|true|on | no|false|off"
 Should the tun/tap device be made persistent, that is, should the device
 stay up even when vped exits? Some versions of the tunnel device have
 problems sending packets when vped is restarted in persistent mode, so
@@ -249,6 +250,18 @@
 Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
 .Sp
 This value must be the minimum of the mtu values of all hosts.
+.IP "ip-proto = numerical-ip-protocol" 4
+.IX Item "ip-proto = numerical-ip-protocol"
+Sets the protocol number to be used for the rawip protocol. This is a
+global option because all hosts must use the same protocol, and since
+there are no port numbers, you cannot easily run more than one vped
+instance using the same protocol, nor can you share the protocol with
+other programs.
+.Sp
+The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
+firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
+common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
+(\s-1ENCAP\s0, rfc1241)
 .IP "if-up = relative-or-absolute-path" 4
 .IX Item "if-up = relative-or-absolute-path"
 Sets the path of a script that should be called immediately after the
@@ -268,11 +281,23 @@
 .IP "MAC=fe:fd:80:00:00:01" 4
 .IX Item "MAC=fe:fd:80:00:00:01"
 The \s-1MAC\s0 address to set the interface to. The script *must* set the
-interface \s-1MAC\s0 to this value. On GNU/Linux you will most likely use this:
+interface \s-1MAC\s0 to this value. You will most likely use one of these:
 .Sp
-.Vb 1
-\&   ip link set $IFNAME address $MAC mtu $MTU up
+.Vb 2
+\&   ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
+\&   ifconfig $IFNAME ether $MAC mtu $MTU up      # FreeBSD
 .Ve
+.Sp
+Please see the \f(CW\*(C`vpe.osdep(5)\*(C'\fR manpage for platform-specific information.
+.IP "IFTYPE=native # or tincd" 4
+.IX Item "IFTYPE=native # or tincd"
+.PD 0
+.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
+.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
+.PD
+The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os
+name in lowercase) that this vpe was configured for. Can be used to select
+the correct syntax to use for network-related commands.
 .IP "NODENAME=branch1" 4
 .IX Item "NODENAME=branch1"
 The nickname of the current node, as passed to the vped daemon.
@@ -313,8 +338,8 @@
 .IX Item "DESTIP=188.13.66.8"
 The numerical \s-1IP\s0 address of the remote host (vped accepts connections from
 everywhere, as long as the other host can authenticate itself).
-.IP "DESTPORT=407 # deprecated" 4
-.IX Item "DESTPORT=407 # deprecated"
+.IP "DESTPORT=655 # deprecated" 4
+.IX Item "DESTPORT=655 # deprecated"
 The \s-1UDP\s0 port used by the other side.
 .IP "STATE=UP" 4
 .IX Item "STATE=UP"
@@ -338,6 +363,45 @@
 .IP "node-down = relative-or-absolute-path" 4
 .IX Item "node-down = relative-or-absolute-path"
 Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
+.IP "http-proxy-host = hostname/ip" 4
+.IX Item "http-proxy-host = hostname/ip"
+The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if vpe was
+compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
+tcp connections through a http proxy server.
+.Sp
+\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
+port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
+requires authentication.
+.Sp
+Please note that vpe will still try to resolve all hostnames in the
+configuration file, so if you are behind a proxy without access to a dns
+server better use numerical \s-1IP\s0 addresses.
+.Sp
+To make best use of this option disable all protocols except tcp in your
+config file and make sure your routers (or all other hosts) are listening
+on a port that the proxy allows (443, https, is a common choice).
+.Sp
+If you have a router, connecting to it will suffice. Otherwise tcp must be
+enabled on all hosts.
+.Sp
+Example:
+.Sp
+.Vb 3
+\&   http-proxy-host = proxy.example.com
+\&   http-proxy-port = 3128       # 8080 is another common choice
+\&   http-proxy-auth = schmorp:grumbeere
+.Ve
+.IP "http-proxy-port = proxy-tcp-port" 4
+.IX Item "http-proxy-port = proxy-tcp-port"
+The port where your proxy server listens.
+.IP "http-proxy-auth = login:password" 4
+.IX Item "http-proxy-auth = login:password"
+The optional login and password used to authenticate to the proxy server,
+seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
+currently supported.
+.IP "pid-file = path" 4
+.IX Item "pid-file = path"
+The path to the pid file to check and create (Default:
 .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
 .IX Subsection "NODE SPECIFIC SETTINGS"
 The following settings are node\-specific, that is, every node can have
@@ -346,8 +410,31 @@
 executed within a node section only apply to the given node.
 .IP "udp-port = port-number" 4
 .IX Item "udp-port = port-number"
-Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW407\fR, not
+Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
 officially assigned by \s-1IANA\s0!).
+.IP "tcp-port = port-number" 4
+.IX Item "tcp-port = port-number"
+Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
+.IP "enable-rawip = yes|true|on | no|false|off" 4
+.IX Item "enable-rawip = yes|true|on | no|false|off"
+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+).
+.IP "enable-udp = yes|true|on | no|false|off" 4
+.IX Item "enable-udp = yes|true|on | no|false|off"
+Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR,
+but this will change!). This is a good general choice since \s-1UDP\s0 tunnels
+well through many firewalls.
+.Sp
+\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as
+some future version will have all protocols disabled by default.
+.IP "enable-tcp = yes|true|on | no|false|off" 4
+.IX Item "enable-tcp = yes|true|on | no|false|off"
+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 vpe 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.
 .IP "router-priority = positive-number" 4
 .IX Item "router-priority = positive-number"
 Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
@@ -363,17 +450,17 @@
 \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
 take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
 don't talk to it).
-.IP "inherit-tos = yes|no" 4
-.IX Item "inherit-tos = yes|no"
+.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
 sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
 outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
 to the tunnel device, which is usually what you want.
-.IP "compress = yes|no" 4
-.IX Item "compress = yes|no"
-Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR,
-compression is really cheap even on slow computers and has no size
-overhead at all).
+.IP "compress = yes|true|on | no|false|off" 4
+.IX Item "compress = yes|true|on | no|false|off"
+Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
+Compression is really cheap even on slow computers and has no size
+overhead at all, so enabling this is a good idea.
 .SH "CONFIG DIRECTORY LAYOUT"
 .IX Header "CONFIG DIRECTORY LAYOUT"
 The default (or recommended) directory layout for the config directory is:
@@ -394,7 +481,7 @@
 The public keys of the other nodes, one file per node.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
-\&\fIvpe\fR\|(8), \fIvped\fR\|(8), \fIvpectrl\fR\|(8).
+\&\fIvpe\fR\|(5), \fIvped\fR\|(8), \fIvpectrl\fR\|(8).
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Marc Lehmann <vpe@plan9.de>