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$
  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.
  42 If this file is available,
  43 this information may be used by the
  44 .Xr isdnd 8
  45 ISDN connection management daemon to calculate the short hold time for a
  46 connection.
  47 .Pp
  48 The format of a rate entry line is as follows:
  49 .Pp
  50 The first field, the
  51 .Pq Fa rate-code
  52 defines a collection of rates (for each day of the week) which can be
  53 referenced in the
  54 .Xr isdnd 8
  55 configuration file
  56 .Xr isdnd.rc 5 .
  57 This field must start with the identifier
  58 .Dq ra
  59 followed by a digit in the range of zero to four.
  60 .Pp
  61 The second field, the
  62 .Pq Fa day-number
  63 selects the day of week for which this entry defines the rates, where 0 stands
  64 for Sunday, 1 for Monday and so on until the digit 6 which stands for Saturday.
  65 .Pp
  66 The rest of the line consists of one or more space separated fields which have
  67 the following syntax:
  68 .Bd -ragged -offset indent
  69 start_hour.start_minutes-end_hour.end_minutes:charge_unit_length
  70 .Ed
  71 .Pp
  72 Start_hour and start_minutes define the begin of a time section and end_hour
  73 and end_minutes define the end.
  74 Charge_unit_length define the length of a
  75 charging unit in the previously defined time section.
  76 No spaces or tabs are
  77 allowed inside this field.
  78 The hour and minutes specifications MUST have
  79 exactly 2 digits, in case just one digit is needed, a leading 0 must be used.
  80 .Pp
  81 For example,
  82 .Bd -ragged -offset indent
  83 14.00-18.00:90
  84 .Ed
  85 .Pp
  86 defines, that between 2:00 PM and 6:00 PM the length of one charging unit
  87 lasts 90 seconds.
  88 .Sh FILES
  89 .Bl -tag -width /etc/isdn/isdnd.rates -compact
  90 .It Pa /etc/isdn/isdnd.rates
  91 The default rates specification file for the
  92 .Nm isdnd
  93 ISDN daemon.
  94 .El
  95 .Sh EXAMPLES
  96 The line:
  97 .Bd -literal
  98 ra0 0 00.00-05.00:240 05.00-21.00:150 21.00-24.00:240
  99 .Ed
 100 .Pp
 101 defines the unit lengths for a Sunday.
 102 .Sh SEE ALSO
 103 .Xr isdnd.rc 5 ,
 104 .Xr isdnd 8
 105 .Sh AUTHORS
 106 .An -nosplit
 107 The rates subsystem for the
 108 .Xr isdnd 8
 109 daemon to which
 110 .Nm
 111 belongs was designed and written by
 112 .An Gary Jennejohn .
 113 .Pp
 114 The
 115 .Xr isdnd 8
 116 daemon and this manual page were written by
 117 .An Hellmuth Michaelis Aq hm@kts.org .