isdnlog-3.81

moved man's from doc to tools
This commit is contained in:
akool 1999-12-24 14:14:50 +00:00
parent 4a81ef4f16
commit 3dd0b9f2b5
3 changed files with 2 additions and 533 deletions

View File

@ -1,4 +1,4 @@
# $Id: Makefile.in,v 1.10 1999/10/25 18:30:33 akool Exp $
# $Id: Makefile.in,v 1.11 1999/12/24 14:14:50 akool Exp $
#
# Makefile for ISDN manpages
# (C) 1997 Fritz Elfert
@ -8,8 +8,7 @@ SHELL = /bin/sh
AWK = @AWK@
SED = @SED@
MANDIR = @CONFIG_MANDIR@
MANPAGES = ttyI.4 isdninfo.4 isdn_audio.4 isdnctrl.4 isdn_cause.7 \
isdnrate.1 rate-files.5
MANPAGES = ttyI.4 isdninfo.4 isdn_audio.4 isdnctrl.4 isdn_cause.7
INSTALL_MAN = @INSTALL@ -o 0 -g 0 -m 0644
prefix = @prefix@

View File

@ -1,285 +0,0 @@
.TH ISDNRATE 1 "29.Nov.1999" -lt-
.SH NAME
isdnrate \- Print telefon rates and various info from rate\-files(5).
.SH SYNOPSIS
.BI "isdnrate \-b" best " \-d" day " \-f" from " \-h" hour " \-l" len
.B \-o
.BI \-p provs
.B \-s
.BI "\-t" takt " \-v" verbose " \-x" exclude
.BI " \-C \-D" det " -\G" data " \-H \-L \-N \-O" socketfile " \-P" piddir
.BI " \-S" sort " \-T \-U \-V \-X" explain
.BI -Z
.B NUMBER ...
.P
All options are optional.
.SH DESCRIPTION
The
.B isdnrate
program prints various information from rate\-files(5). It's main purpose
is the calculation of telefon rates from your location to an arbitrary
destination at a certain time and of a certain length for all the providers in a rate-file.
.P
.SS
.B NUMBER
.P
A telefon number may be
.IP
.B 1234
a local area number
.IP
.B 01234
a different area in your country
.IP
.B +12345
a foreign country
.IP
.B China
text for a foreign country
.IP
.B Paris
a town
.IP
.B US
a code as defined in
.IR country-de.dat .
.IP
.B Internet
a Service name (if option
.B -s
is also given).
.P
Note that currently only city names in AT, DE, NL are supported plus some international capitals.
.SS
.B OPTIONS
.P
.BI \-b best
Print only \fIbest\fP providers. Default is all.
.P
.BI \-d day
Calc rates for \fIday\fP. \fIday\fP can be one of
.IP
.I dd
day of current month
.br
.I dd.mm
day month
.br
.I dd.mm.yy[yy]
day, month, year
.br
.I W
Weekday
.br
.I N
Weekday - night
.br
.I E
Weekend
.P
Default is now.
.P
.BI \-f from
Callers location. Default ist from isdn.conf.
.P
.BI \-h hour
Time \fIhh[:mm[:ss]]\fP of call. Default is now.
.P
.BI \-l len
Length of call in second. Default value is 153 secs.
.P
.B \-o
Show only booked providers. These are providers, which are listed in
.IR rate.conf .
.P
.BI \-p provider[,provider...]
Print only info for given \fIprovider\fP(s).
.I provider
is the provider number, without the leading VBN, or
.I provider_variant
if there are more variations, or
.I B
for business providers.
.P
.B \-s
Consider
.B NUMBER
as the name of a service and print all numbers / providers, which supply
this service.
.P
.BI \-t takt
Print only providers, which have calculation impulses smaller or equal to \fItakt\fP.
Default is 9999.
.P
.BI \-v verbose
Set \fIverbose\fP level.
.P
.BI \-x provider[,provider...]
Exclude these \fIprovider\fP(s).
.P
.SS
.B DISPLAY AND RUN OPTIONS
.P
.B \-C
Connect to a running isdnrate daemon. This avoids long startup times.
.P
.B \-D
Start as a daemon, waiting for connections from a client. The socket
.I /tmp/isdnrate
is created, which clients can connect to.
.P
.B \-D2
Start as a daemon and go background.
.P
.B \-CD3
Stop a running daemon.
.P
.BI \-G n
Print raw data for connection. \fIn\fP may be currently 97,98,99.
.P
.B \-H
Print a header.
.P
.B \-L
Print a semicolon separated list of
.IP
vbn ; providername ; zone ; day ; time ; currency ; charge ; basicprice ; price ;
duration ; charge/min ; takt ; minimum price
.P
.B \-N
Show info about following numbers. If no provider is given, the preselected
provider is used.
.P
.BI \-O socketfile
Write socket to given filename on start of daemon. Default is
.IR tmp/isdnrate .
.P
.BI \-P piddir
Write own PID to
.I piddir/isdnrate.pid
on start of daemon.
.P
.BI \-S sort
Sort output by \fIsort\fP, which may be
.IP
.B v
vbn or
.B n
provider name. Default is by charge.
.P
.B \-T
Print a table of charges for daytimes weekday/weekend.
.P
.B \-V
Print version info and exit.
.P
.BI \-X explain
Print additional information for charge or from rate-file.
.I explain
may be
.IP
.B 1
(zone)
.br
.B 2
(charge/min, zone, day, time)
.br
.B 50
International areas
.br
.B 51
National zones
.br
.B COMMENT
Print C:COMMENT: info from rate files.
.br
If
.I \-s
is given, the number is also listed with
.I \-X1
or
.IR \-X2 .
.P
.B \-Z
Print info for LCR
.br
e.g. isdnrate -p1 -ZX 19430
.br
shows the rate for provider 1 and the cheapest rate to this service.
.P
Note: Various output options may not be used together. If you gave conflicting
options you'll see a warning.
.br
Note also: Sort by name or providernumber and
.BI -b best
will bring you the first
.I best
providers in sorting order, not the cheapest.
.br
And finally: Some options like
.IR \-X50 ", " \-X51 ", " \-D ", " \-V
don't require a telefon
.IR Number .
.SH FILES
.IR rate-CC.dat ,
.IR holiday-CC.dat ,
.IR dest.gdbm ,
.IR zone-CC-PPP.gdbm ,
.IR isdn.conf ,
.I telrate.cgi
and more.
.SH EXAMPLES
.I isdnrate -D2
.br
Start the isdnrate daemon.
.P
.I isdnrate -D2 -P /var/run -O /tmp/isdnr_socket
.br
Start the isdnrate daemon, write
.I isdnrate.pid
to /var/run and create thew given socket.
.P
.I isdnrate -CH -b5 -f01 -l120 Attersee
.br
Connect to running daemon, print a header and the best 5 rates from Vienna
.RI ( 01 )
to destination
.I Attersee
for a connection length of 2 Minutes.
.P
.I isdnrate -CX -p1_2,24 +1
.br
Show rates and zones for destination USA for providers
.IR "1_2 " and " 24" .
.P
.I isdnrate -CX -H -dW -b5 US CA
.br
Show a header, rates and zones for destinations USA and Canada for best 5
providers during workday.
.P
.I isdnrate -CHoX US
.br
Show header, rate and zone for destination USA for booked providers only.
.P
.I isdnrate -CsX -l60 Internet
.br
Show rates and numbers for service for a 1 minutes call.
.IR Internet .
.P
.I isdnrate -CZ 19430
.br
Show rates and the best provider for this (service-)number.
.P
.I isdnrate -CD3
.br
Stop the running isdnrate daemon.
.SH "SEE ALSO"
.BR rate-files(5) ", " isdnlog(8)
.SH BUGS
Propably. Sometimes more then one daemon can be started.
.SH AUTHORS
Andreas Kool <akool@isdn4linux.de> started this program.
Leopold Toetsch <lt@toetsch.at> continued the work and brought this man
page to you. Michael Reinelt
<reinelt@eunet.at> did the calculation engine and various tools for it.

View File

@ -1,245 +0,0 @@
'\" t
'\" ** above should format a table **
.TH rate-files 5 "29.Nov.1999" -lt-
.SH NAME
rate-files \- Format of rate-files
.SH DESCRIPTION
The rate-files used by isdnlog(8) and by isdnrate(1) are textfiles with
the following overall layout:
.P
.I Header entries
.P
.I Provider entries
.P
Comments starting with a hash-sign '#'
and empty lines are ignored. The first letter (tag) followed by a colon
discerns the entries. Additional white space may be used after the tags
to group content more readably.
.SS Header entries
.B V:versionsstring
.IP
e.g.
V:1.0-Germany [18-Mar-1999]
.P
.B S:Servicename
.P
.B N:Servicenumber[,Servicenumber...]
.IP
This defines Services with special numbers. Special numbers are numbers which
a) start with no '0' or b) can not be dialed with every provider. A number
with a variable length should have the wildcard '*' at the end, eg.
.I 07189*
which matches all numbers startig with
.IR 07189 .
Numbers with wildcards should be placed after numbers which would match the
wildcard, because matching is done straight top down.
There may be multiple
.B N:
tags for one Service.
.IP
e.g.
.br
S:Internet
.br
N:07189*,19430
.br
N:19440
.P
.B U:currencyfmt currency
.IP
e.g.
U:%.3 DEM
.SS Provider entries
A new provider starts always with a
.B P:
tag and consists of a
.I Providerheader
followed by
.I Providerzones.
.SS Providerheader
.P
.B P:providernumber providername
.IP
e.g.
P:02 UTA
.P
.B B:vbn
.P
VBN-Number for provider
.IP
e.g.
B:1002
.P
.B C:COMMENT: comment
.P
.B COMMENT
may be an arbitrary string, but the following entries are used already:
.IP
.TS
tab (@);
l l.
\fBC:Name:\fP@Providername
\fBC:Maintainer:\fP@Who did the hard work
\fBC:TarifChanged:\fP@and when
\fBC:Address:\fP@Provideraddress
\fBC:Homepage:\fP@http:URL for provider
\fBC:TarifURL:\fP@URL for tarif info
\fBC:EMail:\fP@EMail-Address
\fBC:Telefon:\fP@Telefon number
\fBC:Telefax:\fP@Fax number
\fBC:Hotline:\fP@Telefon number
\fBC:Zone:\fP@Textual info about zones
\fBC:Special:\fP@Guess
\fBC:GT:\fP@Additional charge text
\fBC:GF:\fP@Additional charge formula
.TE
.P
.B D:zone
.P
Name of zone file (inserted for
.B %s
.RI "in ZONEFILE = /usr/lib/isdn/zone-" CC "-%s.dat from isdn.conf)"
.IP
e.g.
D:dtag # DTAG zone file
.P
Note: if the provider has no different domestic zones, you should not define a D:tag.
.P
.B G:[fromDate][-toDate]
.P
Set a time range for the validity of rates for this provider. Dates have to
be numeric in format
.BR dd.mm.yyyy .
Note: as time is assumed as 00:00, take for
.I toDate
the day+1.
.SS Providerzones
A Providerzone entry starts with a
.B Z:
tag followed by one or more
.B A:
and
.B T:
tags.
.P
A zone is a region of areas, for which the same rates apply. Interior and
foreign zones should not be mixed and all foreign zones should follow
domestic zones.
.P
.B Z:zonelist zonename
.P
where
.I zonelist
is
.BR zone [ -zone ][ ,... ]
.IP
e.g.
Z:1-2,4 Interior
.P
.BR A:area [ ,area... ]
.P
.I area
may be a telefonnumber (including +countrycode for numbers which may
be reached from everywhere, a telefonnumber without +countrycode for numbers only reachable
in the own country) or an area name or alias as defined in country-de.dat.
Country names have to be translated to their code by the rate-preprocessor
.IR pp_rate .
.IP
e.g.
A:19430,07189 # Online
.IP
e.g.
A:+31,Belgium # Int 1
.P
Note: There should always be exactly one zone with your countrycode
or countryname respectively:
.IP
Z:4
.br
A:+49
.br
T:...
.P
Countrynames like
.I Belgium
in the above example are replaced by their ISO-Code (or TLD) with the
rate preprocessor
.IR pp_rate .
.P
.BR T:daylist/timelist [ ! ] "=chargelist chargename"
.P
where
.I daylist
is
.BR day [ -day ][ ,... ]
and day is a daynumber (1=Mon, 2=Tue, ...) or W (weekday), E (weekend), H (holiday) or
* (everyday).
.P
.I timelist
is
.BR hour [ -hour ][ ,hour ]
where hour is a number 0..23 or * for everytime.
.P
After
.I daylist/timelist
follows
.B =
or
.B !=
which means, provider doesn't adjust rates on a rate boundary e.g. at 18h00.
.P
A
.I chargelist
consists of
.P
.RB [ MinCharge| ] Charge [ (Divider) ] /Duration [ :Delay ][ /Duration... ]
.P
where
.I MinCharge|
is an (optional) minimum charge,
.I Charge
the rate per
.I Duration
seconds or optional rate per
.I (Divider)
seconds,
.I Duration
is the length of one charge impuls in seconds. After
.I Delay
the next duration is taken. If delay ist not given it equals to the duration.
The last duration may not have a delay and may not be zero.
.IP
e.g.
T:1-4/8-18=1.5(60)/60/1 workday
.IP
Monday until Thursday, daytime the charge is 1.50 per minute, first charge is for one minute
after this charging is calculated in seconds interval.
.IP
e.g.
T:W/18-8=0.30|1.2(60)/1 night
.IP
On weekday, night, charge is the bigger of 1.20 per minute or 0.30
.IP
e.g.
T:*/*=0.50/0,1(60)/1 always
.IP
Everyday, everytime there is a connection fee of 0.50, then charge is 1 per minute.
.IP
e.g.
T:H/*=0.5/60:600,0.5/30 holidays
.IP
On holidays, everytime a charge of 0.5 per minute in a minutes interval, after
10 minutes 0.5 per half minute in half a minutes interval.
.IP
e.g.
T:*/*=1.3/0,0/1
.IP
Everyday, everytime the charge is 1.30 independent of duration, which could also
be written as T:*/*=1.3|0/1.
.P
.SH SEE ALSO
.IR isdnlog(8) ,
.IR isdnrate(1) ,
isdnlog/README, rate-at.dat, tools/NEWS
.SH AUTHOR
Leopold Toetsch <lt@toetsch.at> (of this man page of course).