d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mdoc(7) police: Once again, remove single-space hard sentence breaks.

Browse Source
This commit is contained in:
ru 2000-12-08 12:42:24 +00:00
parent 7aeae74656
commit d9cd6875a8
1 changed files with 142 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

211
usr.sbin/i4b/isdnd/isdnd.rc.5
View File

@ -82,15 +82,18 @@ The following keywords are recognized by
.Pp
.Bl -tag -width system
.It Li system
This keyword starts the system configuration section. It must not
have a parameter and may be used only once. The keyword is mandatory.
This keyword starts the system configuration section.
It must not
have a parameter and may be used only once.
The keyword is mandatory.
The following keywords are valid in the system configuration section:
.Bl -tag -width useacctfile
.It Li acctall
If this parameter is set to
.Em on ,
accounting information is written even if the local site was not charged
or no charging information is available or is not subscribed. (optional)
or no charging information is available or is not subscribed.
(optional)
.It Li acctfile
Specifies the name of the accounting file which is used when the keyword
.Em useacctfile
@ -98,20 +101,24 @@ Specifies the name of the accounting file which is used when the keyword
.Em on .
See also system keyword
.Em rotatesuffix .
If this keyword is omitted the system default is used. (optional)
If this keyword is omitted the system default is used.
(optional)
.It Li aliasing
If this parameter is set to
.Em on ,
alias processing of telephone-number to name is enabled (see also the
.Em aliasfile
keyword below). The default is off. (optional)
keyword below).
The default is off.
(optional)
.It Li aliasfile
Specifies the name of the telephone number-to-name alias database file shared
with the
.Xr isdntel 1
utility when alias processing is enabled via the
.Em aliasing
keyword. (optional)
keyword.
(optional)
.It Li beepconnect
In full-screen mode, if this parameter is set to
.Em on ,
@ -121,21 +128,26 @@ If this parameter is set to
.Em on ,
the extended caller attributes "screening indicator" and "presentation
indicator" are written to the log-file.
The default is off. (optional)
The default is off.
(optional)
.It Li holidayfile
Specifies the name of the holiday file containing the dates of holidays.
This file is used in conjunction with the
.Em valid
keyword to lookup the dates of holidays. (optional)
keyword to lookup the dates of holidays.
(optional)
.It Li isdntime
If this parameter is set to
.Em on ,
date/time information from the exchange (if provided) is written to the
log-file. The default is off. (optional)
log-file.
The default is off.
(optional)
.It Li mailer
This keyword is used to specify the path/name of a mail program which
which is able to use the "-s" flag to specify a subject on its
command line. In case of a fatal error exit of
command line.
In case of a fatal error exit of
.Nm
this program is used to send mail to an administrator specified by
the keyword
@ -163,7 +175,8 @@ sets the TCP port number for remote monitoring.
This integer parameter is optional and is set to port 451 by default.
.It Li monitor
This keyword specifies a local socket name or a host or network for remote
monitoring. The
monitoring.
The
.Em monitor
specification may either be:
.Pp
@ -182,7 +195,8 @@ example: up-vision-net/24
.It Li monitor-access
This keyword specifies the access rights for a previously used
.Em monitor
keyword. The supported access rights are:
keyword.
The supported access rights are:
.Pp
.Bl -tag -width Ds -compact -offset
.It Ar fullcmd
@ -193,10 +207,13 @@ keyword. The supported access rights are:
.It Ar callout
.El
.It Li ratesfile
Specifies the name of the ratesfile. If this keyword is omitted the system
default is used. (optional)
Specifies the name of the ratesfile.
If this keyword is omitted the system
default is used.
(optional)
.It Li regexpr
This keyword is used to specify regular expressions. It can be specified
This keyword is used to specify regular expressions.
It can be specified
more than once up to a compile time dependent value (currently set to 5 by
the MAX_RE definition in the source).
.Pp
@ -227,17 +244,20 @@ expects to find the program below the path
which is prepended to the string specified as a parameter to this keyword.
(optional)
.It Li rotatesuffix
Specifies a suffix for renaming the log- and the accounting-filename. In case
Specifies a suffix for renaming the log- and the accounting-filename.
In case
rotatesuffix is used and a USR1 signal is sent to isdnd, the log-file and the
accounting file is not only closed and reopened but the old log-file is also
renamed to the former filename with the rotatesuffix string appended.
If this keyword is omitted, the log-files are just closed and reopened; this
is also the default behavior. (optional)
is also the default behavior.
(optional)
.It Li rtprio
Specifies the real-time priority
.Nm isdnd
runs at as an integer value in the range 0...31 with 0 being the highest
priority. This keyword is optional; if not specified the process priority of
priority.
This keyword is optional; if not specified the process priority of
.Nm isdnd
is not touched in any way.
( See also
@ -250,17 +270,22 @@ was compiled with -DUSE_RTPRIO.
If this parameter is set to
.Em on
charging (if available) and accounting information is written to the
accounting file. (optional)
accounting file.
(optional)
.El
.It Li controller
This keyword starts the controller configuration section. It must not
have a parameter and may be used once for every controller. The keyword
is optional. The following keywords are valid in a controller
This keyword starts the controller configuration section.
It must not
have a parameter and may be used once for every controller.
The keyword
is optional.
The following keywords are valid in a controller
configuration section:
.Bl -tag -width useacctfile
.It Li protocol
This keyword is used to set the D-channel protocol for the S0-bus a
controller is connected to. The following parameters are currently
controller is connected to.
The following parameters are currently
supported:
.Pp
.Bl -tag -width calledback -compact -offset
@ -272,7 +297,8 @@ An ISDN leased line with a single B-channel (called D64S in Germany).
.El
.El
.It Li entry
This keyword starts one configuration entry. It must not have a parameter.
This keyword starts one configuration entry.
It must not have a parameter.
This keyword must be used at least once.
The following keywords are valid in an entry section:
.Bl -tag -width unitlengthsrc
@ -280,7 +306,8 @@ The following keywords are valid in an entry section:
This keyword is used to specify the name of a program which is run in
case an incoming telephone connection specified
.Em answer
in its configuration entry. The default name is
in its configuration entry.
The default name is
.Em answer .
.Nm Isdnd
expects to find this program beneath the path
@ -288,14 +315,17 @@ expects to find this program beneath the path
which is prepended to the string specified as a parameter to this keyword.
(optional)
.It Li alert
is used to specify a time in seconds to wait before accepting a call. This
is used to specify a time in seconds to wait before accepting a call.
This
keyword is only usable for incoming telephone calls (dialin-reaction = answer).
It is used to have a chance to accept an incoming call on the phone before
the answering machine starts to run. The minimum value for the alert parameter
the answering machine starts to run.
The minimum value for the alert parameter
is 5 seconds and the maximum parameter allowed is 180 seconds.
(optional)
.It Li b1protocol
The B channel layer 1 protocol used for this connection. The keyword is mandatory.
The B channel layer 1 protocol used for this connection.
The keyword is mandatory.
The currently configurable values are:
.Pp
.Bl -tag -width Ds -compact -offset
@ -305,14 +335,17 @@ HDLC framing.
No framing at all (used for telephony).
.El
.It Li budget-calloutperiod
is used to specify a time period in seconds. Within this period, the number of calls
is used to specify a time period in seconds.
Within this period, the number of calls
specified by
.Em budget-calloutncalls
are allowed to succeed, any further attempt to call out will be blocked for the rest
of the time left in the time period. (optional)
of the time left in the time period.
(optional)
.It Li budget-calloutncalls
The number of outgoing calls allowed within the time period specified by
.Em budget-calloutperiod. (optional)
.Em budget-calloutperiod.
(optional)
.It Li budget-calloutsfile
A path/filename to which the number of successfull callouts are written.
The contents of the file is preserved when it exists during startup of isdnd.
@ -322,9 +355,11 @@ The format of this file is: start time, last update time, number of calls.
If set to
.Em on
rotate budget-calloutsfile every night when an attempt is made to update
the file on a new day. The statistics for the previous day are witten to
the file on a new day.
The statistics for the previous day are witten to
a file with the filename specified by budget-calloutsfile to which a hyphen
and the new day's (!) day of month number is appended. (optional)
and the new day's (!) day of month number is appended.
(optional)
.It Li budget-callbackperiod
.It Li budget-callbackncalls
.It Li budget-callbacksfile
@ -334,13 +369,16 @@ See
.Em budget-calloutncalls and
.Em budget-calloutsfile
.Em budget-calloutsfile-rotate
above. These are used to specify the budgets for calling back a remote site.
above.
These are used to specify the budgets for calling back a remote site.
.It Li callbackwait
The time in seconds to wait between hanging up the call from a remote site
and calling back the remote site. (optional)
and calling back the remote site.
(optional)
.It Li calledbackwait
The time in seconds to wait for a remote site calling back the local site
after a call from the local site to the remote site has been made. (optional)
after a call from the local site to the remote site has been made.
(optional)
.It Li connectprog
specifies a program run every time after a connection is established and
address negotiation is complete (i.e.: the connection is usable).
@ -357,7 +395,8 @@ will be "up" if connection just got up, or "down" if interface changed to down
state and
.Em addr
the address that got assigned to the interface as a dotted-quad ip address
(optional, only if it can be figured out by isdnd). (optional)
(optional, only if it can be figured out by isdnd).
(optional)
.It Li dialin-reaction
Used to specify what to do when an incoming connection request is received.
The keyword is mandatory.
@ -397,7 +436,8 @@ each time it dials because the other side is also dialing.
The number of dialing retries before giving up.
Setting this to
.Em -1
gives an unlimited number of retries! (optional)
gives an unlimited number of retries!
(optional)
.It Li direction
This keyword is used to configure if incoming and outgoing, incoming-only or
outgoing only connections are possible.
@ -428,7 +468,8 @@ the interface is disabled (for
seconds).
(see also the keyword
.Em usedown
further up). This keyword is optional.
further up).
This keyword is optional.
.It Li downtime
is used to configure the time in seconds an interface is disabled
after the configured number of
@ -439,10 +480,12 @@ further up).
This keyword is optional and is set to 60 seconds by default.
.It Li earlyhangup
A (safety) time in seconds which specifies the time to hang up before an
expected next charging unit will occur. (optional)
expected next charging unit will occur.
(optional)
.It Li idle-algorithm-outgoing
The algorithm used to determine when to hang up an outgoing call when the
line becomes idle. The current algorithms are:
line becomes idle.
The current algorithms are:
.Pp
.Bl -tag -width calledback -compact -offset
.It Ar fix-unit-size
@ -468,7 +511,8 @@ In case a channel is explicitly selected here, the SETUP message will request
this channel but mark the request as
.Em preferred
(the indicated channel is preferred) instead of exclusive (only the indicated
channel is acceptable). Thus the exchange is still free to select another
channel is acceptable).
Thus the exchange is still free to select another
than the requested channel!
(mandatory)
.It Li isdntxdel-incoming
@ -477,24 +521,33 @@ A delay value suitable for the
kernel subroutine to delay the transmission of the first packet after a
successful connection is made by this value for
.Em incoming
ISDN connections. The specification unit is 1/100 second. A zero (0) disables
this feature and is the default value. This feature is implemented (and makes
ISDN connections.
The specification unit is 1/100 second.
A zero (0) disables
this feature and is the default value.
This feature is implemented (and makes
sense only) for the
.Xr i4bipr 4
IP over raw HDLC ISDN driver. (optional)
IP over raw HDLC ISDN driver.
(optional)
.It Li isdntxdel-outgoing
A delay value suitable for the
.Em timeout()
kernel subroutine to delay the transmission of the first packet after a
successful connection is made by this value for
.Em outgoing
ISDN connections. The specification unit is 1/100 second. A zero (0) disables
this feature and is the default value. This feature is implemented (and makes
ISDN connections.
The specification unit is 1/100 second.
A zero (0) disables
this feature and is the default value.
This feature is implemented (and makes
sense only) for the
.Xr i4bipr 4
IP over raw HDLC ISDN driver. (optional)
IP over raw HDLC ISDN driver.
(optional)
.It Li local-phone-dialout
The local telephone number used when the local site dials out. When dialing
The local telephone number used when the local site dials out.
When dialing
out to a remote site, the number specified here is put into the
.Em "Calling Party Number Information Element" .
.Pp
@ -503,8 +556,10 @@ This keyword is mandatory for the
user-land interfaces.
.It Li local-phone-incoming
The local telephone number used for verifying the destination of incoming
calls. When a remote site dials in, this number is used to verify that it
is the local site which the remote site wants to connect to. It is compared
calls.
When a remote site dials in, this number is used to verify that it
is the local site which the remote site wants to connect to.
It is compared
with the
.Em "Called Party Number Information Element"
got from the telephone exchange.
@ -513,9 +568,11 @@ This keyword is mandatory for the
.Em ipr
interfaces.
.It Li name
Defines a symbolic name for this configuration entry. Its purpose is to
Defines a symbolic name for this configuration entry.
Its purpose is to
use this name in the full-screen display for easy identification of a link
to a remote site and for accounting purposes. (mandatory)
to a remote site and for accounting purposes.
(mandatory)
.It Li ppp-auth-paranoid
If set to
.Em no ,
@ -552,7 +609,8 @@ The supported methods are:
.Pp
.Bl -tag -width Ds -compact -offset
.It Ar none
Do not require the other side to authenticate. Typical uses are dial-out to an ISP
Do not require the other side to authenticate.
Typical uses are dial-out to an ISP
(many ISPs do not authenticate themselves to clients)
or offering anonymous dial-in at the local site.
.It Ar chap
@ -631,13 +689,15 @@ has been set to pap or chap for an
PPP interface.
(optional)
.It Li ratetype
The rate entry used from the rates file. (optional)
The rate entry used from the rates file.
(optional)
.Pp
For example, ratetype=0 selects lines beginning "ra0" in /etc/isdn/isdnd.rates;
(typically ra0 lines are a set of tables for local call rates on different
days of the week & times per day).
.It Li recoverytime
The time in seconds to wait between dial retries. (optional)
The time in seconds to wait between dial retries.
(optional)
.It Li remdial-handling
is used to specify the dialout behavior in case more than one outgoing
number is specified.
@ -654,18 +714,22 @@ For every new (non-retry) call setup, start with the next number which
follows the last one used.
.El
.It Li remote-phone-dialout
The remote telephone number used when the local site dials out. When dialing
The remote telephone number used when the local site dials out.
When dialing
out to a remote site, the number specified here is put into the
.Em "Called Party Number Information Element" .
.Pp
This keyword is mandatory for the
.Em ipr
interfaces. It may be specified more than once to try to dial to several
interfaces.
It may be specified more than once to try to dial to several
numbers until one succeeds.
.It Li remote-phone-incoming
The remote telephone number used to verify an incoming call. When a remote site
The remote telephone number used to verify an incoming call.
When a remote site
dials in, this number is used to verify that it is the correct remote site
which is herewith authorized to connect into the local system. This parameter
which is herewith authorized to connect into the local system.
This parameter
is compared against the
.Em "Calling Party Number Information Element"
got from the telephone exchange.
@ -674,12 +738,15 @@ This keyword is mandatory for the ipr interfaces.
.Pp
This keyword may have a wildcard parameter '*' to permit anyone dialing in.
.It Li unitlength
The length of a charging unit in seconds. This is used in conjunction with
the idletime to decide when to hang up a connection. (optional)
The length of a charging unit in seconds.
This is used in conjunction with
the idletime to decide when to hang up a connection.
(optional)
.It Li unitlengthsrc
This keyword is used to specify from which source
.Xr isdnd 8
takes the unitlength for short-hold mode. The currently configurable values are:
takes the unitlength for short-hold mode.
The currently configurable values are:
.Pp
.Bl -tag -width Ds -compact -offset
.It Ar none
@ -695,13 +762,15 @@ file with the keyword
.Em ratetype .
.It Ar aocd
Use a dynamically calculated unitlength in case AOCD is subscribed on
the ISDN line. (AOCD is an acronym for ``Advice Of Charge During the call''
the ISDN line.
(AOCD is an acronym for ``Advice Of Charge During the call''
which is a service provided by the telecommunications (ie phone) provider,
to indicate billable units).
.El
.It Li usrdevicename
Specifies the user-land interface which is used for interfacing ISDN B channel
data to the user-land. The keyword is mandatory.
data to the user-land.
The keyword is mandatory.
This keyword accepts the following parameters:
.Pp
.Bl -tag -width Ds -compact -offset
@ -724,7 +793,8 @@ is used to enable the use of the keywords
.Em downtries
and
.Em downtime
in the entries section(s). It is used in the
in the entries section(s).
It is used in the
.Nm isdnd
daemon to dynamically enable and disable the IP interfaces to avoid excessive
dialing activities in case of transient failures (such as busy lines).
@ -834,10 +904,13 @@ must be greater than 0 (zero);
.Ed
.Pp
During the unchecked window which is (unitlength - (idle-time+earlyhangup))
in length, no idle check is done. After the unchecked window has ended,
the line is checked for idle-time length if no traffic takes place. In case
in length, no idle check is done.
After the unchecked window has ended,
the line is checked for idle-time length if no traffic takes place.
In case
there was traffic detected in the check-window, the same procedure is restarted
at the beginning of the next unit. In case no traffic was detected during
at the beginning of the next unit.
In case no traffic was detected during
the check-window, the line is closed at the end of the check window.
.Pp
Notice: