ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/vped.conf.5
(Generate patch)

Comparing gvpe/doc/vped.conf.5 (file contents):
Revision 1.8 by pcg, Wed Oct 15 01:02:27 2003 UTC vs.
Revision 1.11 by pcg, Mon May 10 18:57:07 2004 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "VPED.CONF 5" 131.IX Title "VPED.CONF 5"
132.TH VPED.CONF 5 "2003-10-14" "1.0" "Virtual Private Ethernet" 132.TH VPED.CONF 5 "2004-04-01" "1.5" "Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134vped.conf \- vpe daemon configuration file 134vped.conf \- vpe daemon configuration file
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 3 137.Vb 4
138\& enable-udp = yes
138\& udp-port = 407 139\& udp-port = 407
139\& mtu = 1492 140\& mtu = 1492
140\& ifname = vpn0 141\& ifname = vpn0
141.Ve 142.Ve
142.PP 143.PP
… …
284.Sp 285.Sp
285.Vb 2 286.Vb 2
286\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux 287\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
287\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD 288\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
288.Ve 289.Ve
290.Sp
291Please see the \f(CW\*(C`vpe.osdep(5)\*(C'\fR manpage for platform-specific information.
289.IP "IFTYPE=native" 4 292.IP "IFTYPE=native # or tincd" 4
290.IX Item "IFTYPE=native" 293.IX Item "IFTYPE=native # or tincd"
291.PD 0 294.PD 0
292.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 295.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
293.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 296.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
294.PD 297.PD
295The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 298The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os
… …
333The node id of the remote node. 336The node id of the remote node.
334.IP "DESTIP=188.13.66.8" 4 337.IP "DESTIP=188.13.66.8" 4
335.IX Item "DESTIP=188.13.66.8" 338.IX Item "DESTIP=188.13.66.8"
336The numerical \s-1IP\s0 address of the remote host (vped accepts connections from 339The numerical \s-1IP\s0 address of the remote host (vped accepts connections from
337everywhere, as long as the other host can authenticate itself). 340everywhere, as long as the other host can authenticate itself).
338.IP "DESTPORT=407 # deprecated" 4 341.IP "DESTPORT=655 # deprecated" 4
339.IX Item "DESTPORT=407 # deprecated" 342.IX Item "DESTPORT=655 # deprecated"
340The \s-1UDP\s0 port used by the other side. 343The \s-1UDP\s0 port used by the other side.
341.IP "STATE=UP" 4 344.IP "STATE=UP" 4
342.IX Item "STATE=UP" 345.IX Item "STATE=UP"
343Node-up scripts get called with STATE=UP, node-down scripts get called 346Node-up scripts get called with STATE=UP, node-down scripts get called
344with STATE=DOWN. 347with STATE=DOWN.
… …
394.IP "http-proxy-auth = login:password" 4 397.IP "http-proxy-auth = login:password" 4
395.IX Item "http-proxy-auth = login:password" 398.IX Item "http-proxy-auth = login:password"
396The optional login and password used to authenticate to the proxy server, 399The optional login and password used to authenticate to the proxy server,
397seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is 400seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
398currently supported. 401currently supported.
402.IP "pid-file = path" 4
403.IX Item "pid-file = path"
404The path to the pid file to check and create (Default:
399.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 405.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
400.IX Subsection "NODE SPECIFIC SETTINGS" 406.IX Subsection "NODE SPECIFIC SETTINGS"
401The following settings are node\-specific, that is, every node can have 407The following settings are node\-specific, that is, every node can have
402different settings, even within the same vped instance. Settings that are 408different settings, even within the same vped instance. Settings that are
403executed before the first node section set the defaults, settings that are 409executed before the first node section set the defaults, settings that are
404executed within a node section only apply to the given node. 410executed within a node section only apply to the given node.
405.IP "udp-port = port-number" 4 411.IP "udp-port = port-number" 4
406.IX Item "udp-port = port-number" 412.IX Item "udp-port = port-number"
407Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW407\fR, not 413Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
408officially assigned by \s-1IANA\s0!). 414officially assigned by \s-1IANA\s0!).
409.IP "tcp-port = port-number" 4 415.IP "tcp-port = port-number" 4
410.IX Item "tcp-port = port-number" 416.IX Item "tcp-port = port-number"
411Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW407\fR), but sets the \s-1TCP\s0 port number. 417Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
412.IP "enable-rawip = yes|true|on | no|false|off" 4 418.IP "enable-rawip = yes|true|on | no|false|off" 4
413.IX Item "enable-rawip = yes|true|on | no|false|off" 419.IX Item "enable-rawip = yes|true|on | no|false|off"
414Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 420Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
415(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet 421(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
416is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). 422is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
417.IP "enable-udp = yes|true|on | no|false|off" 4 423.IP "enable-udp = yes|true|on | no|false|off" 4
418.IX Item "enable-udp = yes|true|on | no|false|off" 424.IX Item "enable-udp = yes|true|on | no|false|off"
419Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port 425Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR,
420(default: \f(CW\*(C`yes\*(C'\fR). This is a good general choice since \s-1UDP\s0 tunnels well 426but this will change!). This is a good general choice since \s-1UDP\s0 tunnels
421through many firewalls. 427well through many firewalls.
428.Sp
429\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as
430some future version will have all protocols disabled by default.
422.IP "enable-tcp = yes|true|on | no|false|off" 4 431.IP "enable-tcp = yes|true|on | no|false|off" 4
423.IX Item "enable-tcp = yes|true|on | no|false|off" 432.IX Item "enable-tcp = yes|true|on | no|false|off"
424Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 433Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
425(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only 434(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only
426available when vpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never 435available when vpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never

Diff Legend

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