.TH IBOD.CF 4 \" -*- nroff -*-
.SH NAME
ibod.cf - configuration file for ibod (ISDN Bandwidth On Demand)

.SH DESCRIPTION
This file contains the initial configuration values for the
ibod daemon. Each line contains a keyword and a value.
.PP
Boolean attributes are set with 0 or 1 which corresponds to
false and true respectively. A boolean attribute not specified
at all is always false.
.PP
Lines beginning with # are treated as comments and will be ignored.
.PP
IMPORTANT RULES!
.br
1. Keywords are case sensitive.
.br
2. Kewords must begin at the first column.
.br
3. Keywords and values must be separated by exactly one (1)
space or tab character.
.PP
This file is re-read every time ibod receives SIGHUP (1) signal.

.SS OPTIONS

.TP
.I DEVICE <name>
Name of ISDN PPP device. Default is ippp0.

.TP
.I ENABLE 1|0
Enable/disable bandwidth-on-demand.  Default is enable (1).

.TP
.I INTERVAL <n>
Specify the sample time interval in ms.  Default is 500 ms.

.TP
.I FILTER <n>
Defines "filtering factor". A value of 10 means
that the average bytes/sec value measured over 10
intervals must pass the limit defined by LIMIT
to bring up or down the slave link.
Default is 5.

.TP
.I LIMIT <n%>
Specifies percentage loading of the channel at 
which it is necessary to up or down channels.
This sets both up and down limits to the same value.
Note that this has changed from version 1.4.

.TP
.I UPLIMIT <n%>
Specifies percentage loading of the channel at
which it is necessary to up channels.
Default is 90.

.TP
.I DOWNLIMIT <n%>
Specifies percentage loading of the channel at
which it is necessary to down channels.
Default is 80.

.TP
.I STAYUP 0|1
Enable/disable slave channel stay up function.
If enabled, the second channel (slave link) will stay
up even if the average bytes/sec decrease the value
defined by LIMIT. In this case the slave link will
stay up until hangup time is reached.
(Example: isdnctrl huptimeout ippp1 60)
If disabled the slave link will be brought down in
the same way it was brought up.
Default is 0.

.TP
.I STAYUP_TIME <n>
Defines the minimum time in seconds the second
channel will unconditionally stay up after it has
been brought up. Default value is 30.

.TP
.I STAYDOWN_TIME <n>
Defines the minimum time in seconds the second
channel will unconditionally stay down after it
has been brought up. Default value is 10.

.TP
.I FULL <n>
Defines the maximum throughput in bytes/sec one
channel can transmit. Default value is 7500.

.TP
.I MAX_CHANNELS <n>
Defines the maximum number of channels the
connection can run with. Default is 2. 


.SH SEE ALSO
ibod(1) and xibod(1)

.SH AUTHOR
Jan Obladen, obladen@datenwelt.net
.br
Bjoern Smith, Smith@Compound.SE
.br
Paul Martin <pm@debian.org>