usr.sbin/i4b/isdnd/isdnd.rates.5

   1 .\"
   2 .\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\"     $Id: isdnd.rates.5,v 1.10 1999/12/13 22:11:55 hm Exp $
  26 .\"
  27 .\" $FreeBSD: src/usr.sbin/i4b/isdnd/isdnd.rates.5,v 1.9.2.3 2001/08/01 17:45:03 obrien Exp $
  28 .\"
  29 .\"     last edit-date: [Mon Dec 13 22:59:31 1999]
  30 .\"
  31 .Dd September 11, 1998
  32 .Dt ISDND.RATES 5
  33 .Os
  34 .Sh NAME
  35 .Nm isdnd.rates
  36 .Nd isdn4bsd ISDN management daemon rates description file
  37 .Sh DESCRIPTION
  38 The file
  39 .Pa isdnd.rates
  40 contains descriptions how long charging units last at a given time of day,
  41 day of week and the distance to the destination. If this file is available,
  42 this information may be used by the
  43 .Xr isdnd 8
  44 ISDN connection management daemon to calculate the short hold time for a
  45 connection.
  46 .Pp
  47 The format of a rate entry line is as follows:
  48 .Pp
  49 The first field, the
  50 .Pq Fa rate-code
  51 defines a collection of rates (for each day of the week) which can be
  52 referenced in the
  53 .Xr isdnd 8
  54 configuration file
  55 .Xr isdnd.rc 5 .
  56 This field must start with the identifier
  57 .Dq ra
  58 followed by a digit in the range of zero to four.
  59 .Pp
  60 The second field, the
  61 .Pq Fa day-number
  62 selects the day of week for which this entry defines the rates, where 0 stands
  63 for Sunday, 1 for Monday and so on until the digit 6 which stands for Saturday.
  64 .Pp
  65 The rest of the line consists of one or more space separated fields which have
  66 the following syntax:
  67 .Bd -ragged -offset indent
  68 start_hour.start_minutes-end_hour.end_minutes:charge_unit_length
  69 .Ed
  70 .Pp
  71 Start_hour and start_minutes define the begin of a time section and end_hour
  72 and end_minutes define the end. Charge_unit_length define the length of a
  73 charging unit in the previously defined time section. No spaces or tabs are
  74 allowed inside this field. The hour and minutes specifications MUST have
  75 exactly 2 digits, in case just one digit is needed, a leading 0 must be used.
  76 .Pp
  77 For example,
  78 .Bd -ragged -offset indent
  79 14.00-18.00:90
  80 .Ed
  81 .Pp
  82 defines, that between 2:00 PM and 6:00 PM the length of one charging unit
  83 lasts 90 seconds.
  84 .Sh FILES
  85 .Bl -tag -width /etc/isdn/isdnd.rates -compact
  86 .It Pa /etc/isdn/isdnd.rates
  87 The default rates specification file for the
  88 .Nm isdnd
  89 ISDN daemon.
  90 .El
  91 .Sh EXAMPLES
  92 The line:
  93 .Bd -literal
  94 ra0 0 00.00-05.00:240 05.00-21.00:150 21.00-24.00:240
  95 .Ed
  96 .Pp
  97 defines the unit lengths for a Sunday.
  98 .Sh SEE ALSO
  99 .Xr isdnd.rc 5 ,
 100 .Xr isdnd 8
 101 .Sh AUTHORS
 102 .An -nosplit
 103 The rates subsystem for the
 104 .Xr isdnd 8
 105 daemon to which
 106 .Nm
 107 belongs was designed and written by
 108 .An Gary Jennejohn .
 109 .Pp
 110 The
 111 .Xr isdnd 8
 112 daemon and this manual page were written by
 113 .An Hellmuth Michaelis Aq hm@kts.org .