| blob | e9add2c732718f3c979469a82fccdf129f2c53fe |
1 .\" $NetBSD: isdnd.rc.5,v 1.17 2003/09/25 09:37:32 wiz Exp $
2 .\"
3 .\" Copyright (c) 1997, 2000 Hellmuth Michaelis. All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $Id: isdnd.rc.5,v 1.18 2009/04/09 02:30:51 joerg Exp $
27 .\"
28 .\" $FreeBSD$
29 .\"
30 .\" last edit-date: [Mon Oct 9 13:12:29 2000]
31 .\"
32 .Dd September 25, 2003
33 .Dt ISDND.RC 5
34 .Os
35 .Sh NAME
36 .Nm isdnd.rc
37 .Nd isdn4bsd ISDN connection management daemon config file format
38 .Sh DESCRIPTION
39 The file
40 .Pa /etc/isdn/isdnd.rc
41 contains (if not otherwise specified on the command line) the runtime
42 configuration for the
43 .Xr isdnd 8
44 ISDN connection management daemon which is part of the isdn4bsd package.
45 .Pp
46 The configuration file consists of keywords which start in column 1 followed by
47 one or more spaces or tabs, an equal sign, one or more spaces or tabs
48 and a keyword dependent parameter value.
49 .Pp
50 A line beginning with '#' is treated as a comment line.
51 .Pp
52 For keywords requiring the specification of a boolean value, the truth
53 value can be either
54 .Em yes
55 or
56 .Em on
57 while the false value can be either
58 .Em no
59 or
60 .Em off .
61 .Pp
62 The configuration file consists of one
63 .Em system
64 section, one or more optional
65 .Em controller
66 sections and one or more
67 .Em entry
68 sections.
69 In the
70 .Em system
71 section parameters regarding the daemon operation or parameters
72 not associated with a single remote connection can be set.
73 In the
74 .Em controller
75 section parameters regarding a particular controller can be set.
76 In the
77 .Em entry
78 section(s) parameters directly associated with a single remote
79 connection can be set.
80 .Pp
81 The following keywords are recognized by
82 .Nm isdnd :
83 .Pp
84 .Bl -tag -width system -compact
85 .It Li system
86 This keyword starts the system configuration section.
87 It must not have a parameter and may be used only once.
88 The keyword is mandatory.
89 The following keywords are valid in the system configuration section:
90 .Bl -tag -width useacctfile -compact
91 .It Li acctall
92 If this parameter is set to
93 .Em on ,
94 accounting information is written even if the local site was not charged
95 or no charging information is available or is not subscribed.
96 (optional)
97 .It Li acctfile
98 Specifies the name of the accounting file which is used when the keyword
99 .Em useacctfile
100 (see below) is set to
101 .Em on .
102 See also system keyword
103 .Em rotatesuffix .
104 If this keyword is omitted the system default is used.
105 (optional)
106 .It Li aliasing
107 If this parameter is set to
108 .Em on ,
109 alias processing of telephone-number to name is enabled (see also the
110 .Em aliasfile
111 keyword below).
112 The default is off.
113 (optional)
114 .It Li aliasfile
115 Specifies the name of the telephone number-to-name alias database file shared
116 with the
117 .Xr isdntel 8
118 utility when alias processing is enabled via the
119 .Em aliasing
120 keyword.
121 (optional)
122 .It Li beepconnect
123 In full-screen mode, if this parameter is set to
124 .Em on ,
125 ring the bell when connecting or disconnecting a call.
126 .It Li extcallattr
127 If this parameter is set to
128 .Em on ,
129 the extended caller attributes "screening indicator" and "presentation
130 indicator" are written to the log-file.
131 The default is off.
132 (optional)
133 .It Li holidayfile
134 Specifies the name of the holiday file containing the dates of holidays.
135 This file is used in conjunction with the
136 .Em valid
137 keyword to lookup the dates of holidays.
138 (optional)
139 .It Li isdntime
140 If this parameter is set to
141 .Em on ,
142 date/time information from the exchange (if provided) is written to the
143 log-file.
144 The default is off.
145 (optional)
146 .It Li mailer
147 This keyword is used to specify the path/name of a mail program which
148 which is able to use the "-s" flag to specify a subject on its
149 command line.
150 In case of a fatal error exit of
151 .Nm
152 this program is used to send mail to an administrator specified by
153 the keyword
154 .Em mailto .
155 (optional)
156 .It Li mailto
157 This keyword is used to specify the email address of someone to notify
158 in case of a fatal error exit of
159 .Nm .
160 (See also keyword
161 .Em mailer ) .
162 (optional)
163 .It Li monitor-allowed
164 If this parameter is set to
165 .Em on
166 or
167 .Em yes ,
168 monitoring via a local or remote machine is enabled.
169 This parameter is optional and is set to
170 .Em off
171 by default.
172 .It Li monitor-port
173 sets the TCP port number for remote monitoring.
174 This integer parameter is optional and is set to port 451 by default.
175 .It Li monitor
176 This keyword specifies a local socket name or a host or network for remote
177 monitoring.
178 The
179 .Em monitor
180 specification may either be:
181 .Pp
182 .Bl -tag -width Ds -compact
183 .It Ar the name of a local (UNIX-domain) socket
184 this MUST start with a "/", example: /var/run/isdn-monitor
185 .It Ar a dotted-quad host specification
186 example: 192.168.1.2
187 .It Ar a dotted-quad network address with netmask
188 example: 192.168.1.0/24
189 .It Ar a resolvable host name
190 example: localhost
191 .It Ar a resolvable network name with netmask
192 example: up-vision-net/24
193 .El
194 .It Li monitor-access
195 This keyword specifies the access rights for a previously used
196 .Em monitor
197 keyword.
198 The supported access rights are:
199 .Pp
200 .Bl -tag -width Ds -compact
201 .It Ar fullcmd
202 .It Ar restrictedcmd
203 .It Ar channelstate
204 .It Ar logevents
205 .It Ar callin
206 .It Ar callout
207 .El
208 .It Li ratesfile
209 Specifies the name of the ratesfile.
210 If this keyword is omitted the system default is used.
211 (optional)
212 .It Li regexpr
213 This keyword is used to specify regular expressions.
214 It can be specified
215 more than once up to a compile time dependent value (currently set to 5 by
216 the MAX_RE definition in the source).
217 .Pp
218 All specified regular expressions are compared to the log strings at runtime
219 and if a match is found, a program is run with the log text as a parameter
220 (see also the keyword
221 .Em regprog
222 below).
223 .Pp
224 For an explanation how regular expressions are specified, please have a
225 look at
226 .Xr re_format 7
227 and
228 .Xr regex 3 .
229 The
230 .Em extended
231 regular expression syntax is supported here.
232 .Pp
233 Hint: it might be necessary to properly quote the expression to avoid
234 improper interpretation by the configuration file parser.
235 (optional)
236 .It Li regprog
237 This keyword is used to specify the name of a program which is run in
238 case a corresponding regular expression is matched by a logging string.
239 .Nm Isdnd
240 expects to find the program below the path
241 .Pa /etc/isdn
242 which is prepended to the string specified as a parameter to this keyword.
243 (optional)
244 .It Li rotatesuffix
245 Specifies a suffix for renaming the log- and the accounting-filename.
246 In case
247 rotatesuffix is used and a USR1 signal is sent to isdnd, the log-file and the
248 accounting file is not only closed and reopened but the old log-file is also
249 renamed to the former filename with the rotatesuffix string appended.
250 If this keyword is omitted, the log-files are just closed and reopened; this
251 is also the default behavior.
252 (optional)
253 .\" .It Li rtprio
254 .\" Specifies the real-time priority
255 .\" .Nm isdnd
256 .\" runs at as an integer value in the range 0...31 with 0 being the highest
257 .\" priority.
258 .\" This keyword is optional; if not specified the process priority of
259 .\" .Nm isdnd
260 .\" is not touched in any way.
261 .\" ( See also
262 .\" .Xr rtprio 1
263 .\" ).
264 .\" This keyword is only available if.
265 .\" Nm
266 .\" was compiled with -DUSE_RTPRIO.
267 .\"
268 .It Li useacctfile
269 If this parameter is set to
270 .Em on
271 charging (if available) and accounting information is written to the
272 accounting file.
273 (optional)
274 .El
275 .It Li controller
276 This keyword starts the controller configuration section.
277 It must not have a parameter and may be used once for every controller.
278 The keyword is optional.
279 The following keywords are valid in a controller configuration section:
280 .Bl -tag -width useacctfile -compact
281 .It Li firmware
282 This keyword is used to specify the path of the firmware file that
283 will be loaded to the card once
284 .Nm isdnd
285 is started.
286 This keyword is useful with active ISDN cards.
287 .It Li protocol
288 This keyword is used to set the D-channel protocol for the S0-bus a
289 controller is connected to.
290 The following parameters are currently supported:
291 .Pp
292 .Bl -tag -width calledback -compact -offset xxxx
293 .It Ar dss1
294 The DSS1 or so-called "Euro-ISDN" D-channel protocol according to
295 ITU Recommendations Q.921 and Q.931.
296 .It Ar d64s
297 An ISDN leased line with a single B-channel (called D64S in Germany).
298 .El
299 .El
300 .It Li entry
301 This keyword starts one configuration entry.
302 It must not have a parameter.
303 This keyword must be used at least once.
304 The following keywords are valid in an entry section:
305 .Bl -tag -width downtime
306 .It Li answerprog
307 This keyword is used to specify the name of a program which is run in
308 case an incoming telephone connection specified
309 .Em answer
310 in its configuration entry.
311 The default name is
312 .Em answer .
313 .Nm Isdnd
314 expects to find this program beneath the path
315 .Pa /etc/isdn
316 which is prepended to the string specified as a parameter to this keyword.
317 (optional)
318 .It Li alert
319 is used to specify a time in seconds to wait before accepting a call.
320 This
321 keyword is only usable for incoming telephone calls (dialin-reaction = answer).
322 It is used to have a chance to accept an incoming call on the phone before
323 the answering machine starts to run.
324 The minimum value for the alert parameter
325 is 5 seconds and the maximum parameter allowed is 180 seconds.
326 (optional)
327 .It Li autoupdown
328 For network interfaces using ISDN as a transport medium it does not make
329 sense to mark the interfaces UP before running
330 .Nm isdnd .
331 Typically these interfaces are configured, but marked down, in the respective
332 .Pa ifconfig.*
333 file.
334 When starting,
335 .Nm isdnd
336 recognizes these interfaces (configured with some address, marked down, and
337 having a matching config entry) and marks them up.
338 On shutdown,
339 .Nm isdnd
340 marks all interfaces changed at startup DOWN again.
341 .Pp
342 In rare circumstances you might not want this automatic handling.
343 In this cases add an
344 .Em autoupdown=no
345 line to the config file entry.
346 .It Li b1protocol
347 The B channel layer 1 protocol used for this connection.
348 The keyword is mandatory.
349 The currently configurable values are:
350 .Pp
351 .Bl -tag -width Ds -compact
352 .It Ar hdlc
353 HDLC framing.
354 .It Ar raw
355 No framing at all (used for telephony).
356 .El
357 .It Li budget-calloutperiod
358 is used to specify a time period in seconds.
359 Within this period, the number of calls specified by
360 .Em budget-calloutncalls
361 are allowed to succeed, any further attempt to call out will be blocked for the rest
362 of the time left in the time period.
363 (optional)
364 .It Li budget-calloutncalls
365 The number of outgoing calls allowed within the time period specified by
366 .Em budget-calloutperiod .
367 (optional)
368 .It Li budget-calloutsfile
369 A path/filename to which the number of successful callouts are written.
370 The contents of the file is preserved when it exists during startup of isdnd.
371 The format of this file is: start time, last update time, number of calls.
372 (optional)
373 .It Li budget-calloutsfile-rotate
374 If set to
375 .Em on
376 rotate budget-calloutsfile every night when an attempt is made to update
377 the file on a new day.
378 The statistics for the previous day are written to
379 a file with the filename specified by budget-calloutsfile to which a hyphen
380 and the new day's (!) day of month number is appended.
381 (optional)
382 .It Li budget-callbackperiod
383 .It Li budget-callbackncalls
384 .It Li budget-callbacksfile
385 .It Li budget-calloutsfile-rotate
386 See
387 .Em budget-calloutperiod ,
388 .Em budget-calloutncalls and
389 .Em budget-calloutsfile
390 .Em budget-calloutsfile-rotate
391 above.
392 These are used to specify the budgets for calling back a remote site.
393 .It Li callbackwait
394 The time in seconds to wait between hanging up the call from a remote site
395 and calling back the remote site.
396 (optional)
397 .It Li calledbackwait
398 The time in seconds to wait for a remote site calling back the local site
399 after a call from the local site to the remote site has been made.
400 (optional)
401 .It Li connectprog
402 specifies a program run every time after a connection is established and
403 address negotiation is complete (i.e.: the connection is usable).
404 .Nm Isdnd
405 expects to find the program below the path
406 .Pa /etc/isdn
407 which is prepended to the string specified as a parameter to this keyword.
408 The programs specified by connect and disconnect will get the following
409 command line arguments: -d (device) -f (flag) [ -a (addr) ] where
410 .Em device
411 is the name of device, e.g. "ippp0",
412 .Em flag
413 will be "up" if connection just got up, or "down" if interface changed to down
414 state and
415 .Em addr
416 the address that got assigned to the interface as a dotted-quad IP address
417 (optional, only if it can be figured out by isdnd).
418 (optional)
419 .It Li dialin-reaction
420 Used to specify what to do when an incoming connection request is received.
421 The keyword is mandatory.
422 The currently supported parameters are:
423 .Pp
424 .Bl -tag -width calledback -compact -offset xxxx
425 .It Ar accept
426 Accept an incoming call.
427 .It Ar reject
428 Reject an incoming call.
429 .It Ar ignore
430 Ignore an incoming call.
431 .It Ar answer
432 Start telephone answering for an incoming voice call.
433 .It Ar callback
434 When a remote site calls, hang up and call back the remote site.
435 .El
436 .It Li dialout-type
437 This keyword is used to configure what type of dialout mode is used.
438 The keyword is mandatory.
439 The currently supported parameters are:
440 .Pp
441 .Bl -tag -width Ds -compact
442 .It Ar normal
443 Normal behavior, call the remote site which is supposed to accept the call.
444 .It Ar calledback
445 Callback behavior, call the remote side which rejects the call and calls
446 us back.
447 .El
448 .It Li dialrandincr
449 When dialing or re-dialing and this parameter is set to
450 .Em on ,
451 the dial retry time is added with a random value (currently 0...3 seconds)
452 to minimize the chance of two sites dialing synchronously so each gets a busy
453 each time it dials because the other side is also dialing.
454 .It Li dialretries
455 The number of dialing retries before giving up.
456 Setting this to
457 .Em -1
458 gives an unlimited number of retries! (optional)
459 .It Li direction
460 This keyword is used to configure if incoming and outgoing, incoming-only or
461 outgoing only connections are possible.
462 The keyword is optional, the default is
463 .Em inout .
464 .Pp
465 The currently supported parameters are:
466 .Pp
467 .Bl -tag -width Ds -compact
468 .It Ar inout
469 Normal behavior, connection establishment is possible from remote and local.
470 .It Ar in
471 Only incoming connections are possible.
472 .It Ar out
473 Only outgoing connections are possible.
474 .El
475 .It Li disconnectprog
476 specifies a program run every time after a connection was shut down.
477 .Nm Isdnd
478 expects to find the program below the path
479 .Pa /etc/isdn
480 which is prepended to the string specified as a parameter to this keyword.
481 (optional)
482 .It Li downtries
483 is used to configure the number of unsuccessful tries (= retry cycles!) before
484 the interface is disabled (for
485 .Em downtime
486 seconds).
487 (see also the keyword
488 .Em usedown
489 further up).
490 This keyword is optional.
491 .It Li downtime
492 is used to configure the time in seconds an interface is disabled
493 after the configured number of
494 .Em downtries .
495 (see also the keyword
496 .Em usedown
497 further up).
498 This keyword is optional and is set to 60 seconds by default.
499 .It Li earlyhangup
500 A (safety) time in seconds which specifies the time to hang up before an
501 expected next charging unit will occur.
502 (optional)
503 .It Li idle-algorithm-outgoing
504 The algorithm used to determine when to hang up an outgoing call when the
505 line becomes idle.
506 The current algorithms are:
507 .Pp
508 .Bl -tag -width calledback -compact -offset xxxx
509 .It Ar fix-unit-size
510 idle algorithm which assumes fixed sized changing units during the whole call.
511 .It Ar var-unit-size
512 idle algorithm which assumes that the charging is time based after the first
513 units time has expired.
514 .El
515 .It Li idletime-outgoing
516 The time in seconds an outgoing connection must be idle before hanging up.
517 An idle timeout of zero disables this functionality.
518 (optional)
519 .It Li idletime-incoming
520 The time in seconds an incoming connection must be idle before hanging up.
521 An idle timeout of zero disables this functionality.
522 (optional)
523 .It Li isdncontroller
524 The ISDN controller number to be used for connections for this entry.
525 (mandatory)
526 .It Li isdnchannel
527 The ISDN controller channel number to be used for connections for this entry.
528 In case a channel is explicitly selected here, the SETUP message will request
529 this channel but mark the request as
530 .Em preferred
531 (the indicated channel is preferred) instead of exclusive (only the indicated
532 channel is acceptable).
533 Thus the exchange is still free to select another
534 than the requested channel!
535 (mandatory)
536 .It Li isdntxdel-incoming
537 How long to delay the transmission of the first packet after a
538 successful connection is made for
539 .Em incoming
540 ISDN connections.
541 The specification unit is 1/100 second.
542 A zero (0) disables this feature and is the default value.
543 This feature is implemented (and makes
544 sense only) for the
545 .Xr irip 4
546 IP over raw HDLC ISDN driver.
547 (optional)
548 .It Li isdntxdel-outgoing
549 How long to delay the transmission of the first packet after a
550 successful connection is made for
551 .Em outgoing
552 ISDN connections.
553 The specification unit is 1/100 second.
554 A zero (0) disables this feature and is the default value.
555 This feature is implemented (and makes sense only) for the
556 .Xr irip 4
557 IP over raw HDLC ISDN driver.
558 (optional)
559 .It Li local-phone-dialout
560 The local telephone number used when the local site dials out.
561 When dialing
562 out to a remote site, the number specified here is put into the
563 .Em "Calling Party Number Information Element" .
564 .Pp
565 This keyword is mandatory for the
566 .Em irip
567 user-land interfaces.
568 .It Li local-phone-incoming
569 The local telephone number used for verifying the destination of incoming
570 calls.
571 When a remote site dials in, this number is used to verify that it
572 is the local site which the remote site wants to connect to.
573 It is compared
574 with the
575 .Em "Called Party Number Information Element"
576 got from the telephone exchange.
577 .Pp
578 This keyword is mandatory for the
579 .Em irip
580 interfaces.
581 .It Li name
582 Defines a symbolic name for this configuration entry.
583 Its purpose is to
584 use this name in the full-screen display for easy identification of a link
585 to a remote site and for accounting purposes.
586 (mandatory)
587 .It Li ppp-auth-paranoid
588 If set to
589 .Em no ,
590 the remote site is not required to prove its authenticity for connections
591 that are initiated by the local site.
592 The default is
593 .Em yes
594 and requires the remote site to always authenticate.
595 .Pp
596 This keyword is only used if
597 .Em ppp-send-auth
598 has been set to pap or chap for an
599 .Em ippp
600 PPP interface.
601 (optional)
602 .It Li ppp-auth-rechallenge
603 Set to
604 .Em no ,
605 if the other side does not support re-challenging for chap.
606 The default is
607 .Em yes ,
608 which causes verification of the remote site's authenticity once in a while.
609 .Pp
610 This keyword is only used if
611 .Em ppp-expect-auth
612 has been set to chap for an
613 .Em ippp
614 PPP interface.
615 (optional)
616 .It Li ppp-expect-auth
617 The local site expects the authenticity of the remote site to be proved by
618 the specified method.
619 The supported methods are:
620 .Pp
621 .Bl -tag -width Ds -compact
622 .It Ar none
623 Do not require the other side to authenticate.
624 Typical uses are dial-out to an ISP
625 (many ISPs do not authenticate themselves to clients)
626 or offering anonymous dial-in at the local site.
627 .It Ar chap
628 The preferred authentication method, which does not require a password to be sent
629 in the clear.
630 .It Ar pap
631 The unprotected authentication method, which allows anybody watching the wire
632 to grab name and password.
633 .El
634 .Pp
635 If
636 .Em ppp-auth-paranoid
637 is set to
638 .Em no
639 (the default is
640 .Em yes )
641 outgoing connections will not require the remote site to authenticate itself.
642 .Pp
643 This keyword is only used for the
644 .Em ippp
645 PPP interfaces.
646 (optional)
647 .It Li ppp-expect-name
648 The name that has to be provided by the remote site to prove its authenticity.
649 .Pp
650 This keyword is only used if
651 .Em ppp-expect-auth
652 has been set to pap or chap for an
653 .Em ippp
654 PPP interface.
655 (optional)
656 .It Li ppp-expect-password
657 The secret that has to be provided by the remote site to prove its authenticity.
658 .Pp
659 This keyword is only used if
660 .Em ppp-expect-auth
661 has been set to pap or chap for an
662 .Em ippp
663 PPP interface.
664 (optional)
665 .It Li ppp-send-auth
666 The authentication method required by the remote site.
667 The currently supported parameters are:
668 .Pp
669 .Bl -tag -width Ds -compact
670 .It Ar none
671 The remote site does not expect or support authentication.
672 .It Ar chap
673 The preferred authentication method, which does not require a password to be sent
674 in the clear.
675 .It Ar pap
676 The unprotected authentication method, which allows anybody watching the wire
677 to grab name and password.
678 .El
679 .Pp
680 This keyword is only used for the
681 .Em ippp
682 PPP interfaces.
683 (optional)
684 .It Li ppp-send-name
685 The authentication name sent to the remote site.
686 .Pp
687 This keyword is only used if
688 .Em ppp-send-auth
689 has been set to pap or chap for an
690 .Em ippp
691 PPP interface.
692 (optional)
693 .It Li ppp-send-password
694 The secret used to prove the local site's authenticity to the remote site.
695 .Pp
696 This keyword is only used if
697 .Em ppp-send-auth
698 has been set to pap or chap for an
699 .Em ippp
700 PPP interface.
701 (optional)
702 .It Li ratetype
703 The rate entry used from the rates file.
704 (optional)
705 .Pp
706 For example, ratetype=0 selects lines beginning "ra0" in /etc/isdn/isdnd.rates;
707 (typically ra0 lines are a set of tables for local call rates on different
708 days of the week \*[Am] times per day).
709 .It Li recoverytime
710 The time in seconds to wait between dial retries.
711 (optional)
712 .It Li remdial-handling
713 is used to specify the dialout behavior in case more than one outgoing
714 number is specified.
715 The currently supported parameters are:
716 .Pp
717 .Bl -tag -width Ds -compact
718 .It Ar first
719 For every new (non-retry) call setup, start with the first number.
720 .It Ar last
721 For every new (non-retry) call setup, start with the last number with
722 which a successful connection was made.
723 .It Ar next
724 For every new (non-retry) call setup, start with the next number which
725 follows the last one used.
726 .El
727 .It Li remote-phone-dialout
728 The remote telephone number used when the local site dials out.
729 When dialing
730 out to a remote site, the number specified here is put into the
731 .Em "Called Party Number Information Element" .
732 .Pp
733 This keyword is mandatory for the
734 .Em irip
735 interfaces.
736 It may be specified more than once to try to dial to several
737 numbers until one succeeds.
738 .It Li remote-phone-incoming
739 The remote telephone number used to verify an incoming call.
740 When a remote site
741 dials in, this number is used to verify that it is the correct remote site
742 which is herewith authorized to connect into the local system.
743 This parameter
744 is compared against the
745 .Em "Calling Party Number Information Element"
746 got from the telephone exchange.
747 .Pp
748 This keyword is mandatory for the irip interfaces.
749 .Pp
750 This keyword may have a wildcard parameter '*' to permit anyone dialing in.
751 .It Li unitlength
752 The length of a charging unit in seconds.
753 This is used in conjunction with
754 the idletime to decide when to hang up a connection.
755 (optional)
756 .It Li unitlengthsrc
757 This keyword is used to specify from which source
758 .Xr isdnd 8
759 takes the unitlength for short-hold mode.
760 The currently configurable values are:
761 .Pp
762 .Bl -tag -width Ds -compact
763 .It Ar none
764 Then unitlength is not specified anywhere.
765 .It Ar cmdl
766 Use the unitlength specified on the command line.
767 .It Ar conf
768 Use the unitlength specified in the configuration file with the keyword
769 .Em unitlength .
770 .It Ar rate
771 Use the unitlength from the ratesfile specified in the configuration
772 file with the keyword
773 .Em ratetype .
774 .It Ar aocd
775 Use a dynamically calculated unitlength in case AOCD is subscribed on
776 the ISDN line.
777 (AOCD is an acronym for ``Advice Of Charge During the call''
778 which is a service provided by the telecommunications (ie phone) provider,
779 to indicate billable units).
780 .El
781 .It Li usrdevicename
782 Specifies the user-land interface which is used for interfacing ISDN B channel
783 data to the user-land.
784 The keyword is mandatory.
785 This keyword accepts the following parameters:
786 .Pp
787 .Bl -tag -width Ds -compact
788 .It Ar irip
789 This parameter configures a raw HDLC IP over ISDN interface.
790 .It Ar ippp
791 This parameter configures a synchronous PPP over ISDN interface.
792 .It Ar rbch
793 This specifies a Raw B Channel access interface.
794 .It Ar isdntel
795 ISDN telephony.
796 .It Ar ing
797 configures a ISDN B-channel to NetGraph interface.
798 .El
799 .It Li usrdeviceunit
800 Specifies the unit number for the device which is specified with
801 usrdevicename.
802 .It Li usedown
803 is used to enable the use of the keywords
804 .Em downtries
805 and
806 .Em downtime
807 in the entries section(s).
808 It is used in the
809 .Nm isdnd
810 daemon to dynamically enable and disable the IP interfaces to avoid excessive
811 dialing activities in case of transient failures (such as busy lines).
812 This parameter is optional and is set to
813 .Em off
814 by default.
815 .It Li valid
816 .Em Note :
817 this feature is considered experimental!
818 The parameter to this keyword is a string specifying a time range within
819 which this entry is valid.
820 The time specification consists of a list of weekdays and/or a holiday
821 indicator ( see also the
822 .Em holidayfile
823 keyword in the system section ) separated by commas followed by an optional
824 daytime range specification in the form hh:mm-hh:mm.
825 The weekdays are specified as numbers from 0 to 6 and the number 7 for
826 holidays:
827 .Pp
828 .Bl -tag -width Ds -compact
829 .It Ar 0
830 Sunday
831 .It Ar 1
832 Monday
833 .It Ar 2
834 Tuesday
835 .It Ar 3
836 Wednesday
837 .It Ar 4
838 Thursday
839 .It Ar 5
840 Friday
841 .It Ar 6
842 Saturday
843 .It Ar 7
844 a Holiday
845 .El
846 .Pp
847 The following examples describe the "T-ISDN xxl" tariff of the german Telekom:
848 .Bl -tag -width Ds -compact
849 .It Ar 1,2,3,4,5,6,09:00-18:00
850 Monday through Saturday, daytime 9:00 to 18:00
851 .It Ar 1,2,3,4,5,6,18:00-9:00
852 Monday through Saturday, nighttime 18:00 to 9:00
853 .It Ar 0,7
854 Sunday and on holidays, all 24 hours
855 .El
856 .Pp
857 The use of this keyword is optional.
858 .El
859 .El
860 .Sh IDLETIME CALCULATION AND SHORT-HOLD MODE
861 .Bl -tag -width indent -compact
862 .It Li incoming calls
863 It is assumed that the calling side knows most about charging structures and
864 such and as a consequence only the keyword
865 .Em idletime-incoming
866 has a function for incoming calls.
867 .Pp
868 For incoming calls the line is constantly monitored, and in case there was
869 not traffic taking place for the time in seconds specified by
870 .Em idletime-incoming
871 the call is closed.
872 .Pp
873 Typically,
874 .Em idletime-incoming
875 is used as a last resort and is therefore set much higher than a charging
876 unit time: typical values are one to five minutes.
877 .It Li outgoing calls
878 Outgoing call disconnect time can be set up in one of three ways:
879 .Bl -tag -width indent -compact
880 .It Li simple mode
881 For simple mode, the
882 .Em idle-algorithm-outgoing
883 must be
884 .Em fix-unit-size
885 and the selected
886 .Em unitlength
887 must be 0 (zero) and
888 .Em idletime-outgoing
889 greater zero.
890 .Pp
891 The outgoing traffic is constantly monitored, and in case there was
892 not traffic taking place for the time in seconds specified by
893 .Em idletime-outgoing
894 the call is closed.
895 .Pp
896 Typical values in simple mode are 10 to 30 seconds.
897 .It Li shorthold mode for fixed unit charging
898 For shorthold mode, the
899 .Em idle-algorithm-outgoing
900 must be
901 .Em fix-unit-size
902 and the selected
903 .Em unitlength
904 and
905 .Em idletime-outgoing
906 must be greater than 0 (zero);
907 .Em earlyhangup
908 must be \*[Ge] 0 (zero).
909 .Bd -literal
910 |\*[Lt]unchecked-window\*[Gt]|\*[Lt]checkwindow\*[Gt]|\*[Lt]safetywindow\*[Gt]|
911 | | | |
912 +------------------+-------------+--------------+
913 | | | |
914 | |\*[Lt]-idle-time-\*[Gt]|\*[Lt]earlyhangup-\*[Gt]|
915 |\*[Lt]--------------unitlength---------------------\*[Gt]|
916 .Ed
917 .Pp
918 During the unchecked window which is (unitlength - (idle-time+earlyhangup))
919 in length, no idle check is done.
920 After the unchecked window has ended,
921 the line is checked for idle-time length if no traffic takes place.
922 In case
923 there was traffic detected in the check-window, the same procedure is restarted
924 at the beginning of the next unit.
925 In case no traffic was detected during
926 the check-window, the line is closed at the end of the check window.
927 .Pp
928 Notice:
929 .Em unitlength
930 must (!) be greater than the sum of
931 .Em idletime-outgoing
932 and
933 .Em earlyhangup !
934 .It Li shorthold mode for variable unit charging
935 For shorthold mode, the
936 .Em idle-algorithm-outgoing
937 must be
938 .Em var-unit-size
939 and the selected
940 .Em unitlength
941 and
942 .Em idletime-outgoing
943 must be greater than 0 (zero);
944 .Pp
945 This shorthold mode is suitable when your calls are billed on
946 the elapse time of the call plus a fixed connection charge.
947 For example British Telecom bill this way.
948 .Pp
949 Each call is divided into two periods, the first is the
950 .Em unchecked
951 period and the second is the
952 .Em checked .
953 The
954 .Em checked
955 period starts 1 second before the first units time expires.
956 .Pp
957 During the
958 .Em checked
959 period if there is no traffic for
960 .Em idle-time
961 seconds the call is disconnected.
962 .Pp
963 .Bd -literal
964 |\*[Lt]---unchecked------------------\*[Gt]|\*[Lt]------checked------\*[Gt]
965 +------------------+-------------+
966 | |\*[Lt]-idle-time-\*[Gt]|
967 |\*[Lt]--------------unitlength-------\*[Gt]|
968 .Ed
969 .Pp
970 Experience shows that useful values for idle-time are from 15 to 30 seconds.
971 .Pp
972 If idle-time is too short an application that is not yet finished with the
973 network will cause a new call to be placed.
974 .Pp
975 .El
976 .El
977 .Sh FILES
978 .Bl -tag -width /etc/isdn/isdnd.rc -compact
979 .It Pa /etc/isdn/isdnd.rc
980 The default configuration file for the
981 .Nm isdnd
982 ISDN daemon.
983 .El
984 .Sh SEE ALSO
985 .Xr regex 3 ,
986 .Xr re_format 7 ,
987 .Xr isdnd 8 ,
988 .Xr isdnmonitor 8
989 .Sh AUTHORS
990 The
991 .Xr isdnd 8
992 daemon and this manual page were written by
993 .An Hellmuth Michaelis Aq hm@kts.org .
994 .Pp
995 Additions to this manual page by
996 .An Barry Scott Aq barry@scottb.demon.co.uk .