--- gvpe/doc/vped.conf.5	2003/03/28 18:19:14	1.6
+++ 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:
 .\" ========================================================================
@@ -129,12 +129,13 @@
 .\" ========================================================================
 .\"
 .IX Title "VPED.CONF 5"
-.TH VPED.CONF 5 "2003-03-28" "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
@@ -261,16 +262,6 @@
 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 "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). This is a good general choice since \s-1UDP\s0 tunnels well
-through many firewalls.
-.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 "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
@@ -290,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.
@@ -335,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"
@@ -360,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
@@ -368,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