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

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.10 by pcg, Thu Mar 17 22:24:31 2005 UTC vs.
Revision 1.13 by pcg, Wed Mar 23 21:55:39 2005 UTC

127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "GVPE.CONF 5" 131.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2005-03-17" "1.8" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2005-03-23" "1.9" "GNU Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 134gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 3 137.Vb 3
202(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 202(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
203.IP "dns-forw-port = port-number" 4 203.IP "dns-forw-port = port-number" 4
204.IX Item "dns-forw-port = port-number" 204.IX Item "dns-forw-port = port-number"
205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
206which is fine in most cases). 206which is fine in most cases).
207.IP "dns-max-outstanding = integer-number-of-requests" 4
208.IX Item "dns-max-outstanding = integer-number-of-requests"
209The maximum number of outstanding \s-1DNS\s0 transport requests
210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
211limit without receiving replies. In heavily overloaded situations it might
212help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
213number of parallel requests.
214.Sp
215The default should be working ok for most links.
216.IP "dns-overlap-factor = float" 4
217.IX Item "dns-overlap-factor = float"
218The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
219during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
220must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
221rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
222request might be generated every \fBmin_latency\fR seconds, which means on
223average there should only ever be one outstanding request. A factor of
224\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
225latency measured.
226.Sp
227For congested or picky dns forwarders you could use a value nearer to or
228exceeding \f(CW1\fR.
229.Sp
230The default should be working ok for most links.
231.IP "dns-send-interval = send-interval-in-seconds" 4
232.IX Item "dns-send-interval = send-interval-in-seconds"
233The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
234use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
235the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
236not send more than 100 \s-1DNS\s0 requests per connection per second. For
237high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
238congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
239\&\f(CW0.2\fR or even higher.
240.Sp
241The default should be working ok for most links.
242.IP "dns-timeout-factor = float" 4
243.IX Item "dns-timeout-factor = float"
244Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
246will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or
248reply has been lost.
249.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the
251link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values
252near or below \f(CW1\fR makes no sense whatsoever.
253.Sp
254The default should be working ok for most links.
207.IP "if-up = relative-or-absolute-path" 4 255.IP "if-up = relative-or-absolute-path" 4
208.IX Item "if-up = relative-or-absolute-path" 256.IX Item "if-up = relative-or-absolute-path"
209Sets the path of a script that should be called immediately after the 257Sets the path of a script that should be called immediately after the
210network interface is initialized (but not neccessarily up). The following 258network interface is initialized (but not neccessarily up). The following
211environment variables are passed to it (the values are just examples): 259environment variables are passed to it (the values are just examples):
491protocol is enabled automatically). 539protocol is enabled automatically).
492.Sp 540.Sp
493\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 541\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
494it might get switched on automatically, as some future version might 542it might get switched on automatically, as some future version might
495default to another default protocol. 543default to another default protocol.
544.IP "icmp-type = integer" 4
545.IX Item "icmp-type = integer"
546Sets the type value to be used for outgoing (and incoming) packets sent
547via the \s-1ICMP\s0 transport.
548.Sp
549The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
550\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
551\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
496.IP "inherit-tos = yes|true|on | no|false|off" 4 552.IP "inherit-tos = yes|true|on | no|false|off" 4
497.IX Item "inherit-tos = yes|true|on | no|false|off" 553.IX Item "inherit-tos = yes|true|on | no|false|off"
498Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 554Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
499sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 555sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
500outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 556outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines