diff --git a/doc/isdnrate.man b/doc/isdnrate.man index c37cb2f3..53706c93 100644 --- a/doc/isdnrate.man +++ b/doc/isdnrate.man @@ -1,11 +1,15 @@ -.TH ISDNRATE 1 "21.Sep.1999" -lt- +.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 -.BI " \-p" provs " \-t" takt " \-v" verbose " \-x" exclude +.B \-o +.BI \-p provs +.B \-s +.BI "\-t" takt " \-v" verbose " \-x" exclude .BI " \-C \-D" det " -\G" data " \-H \-L \-N \-S" sort " \-T \-U \-V \-X" explain -.B NUMBER +.BI -Z +.B NUMBER ... .P All options are optional. .SH DESCRIPTION @@ -33,16 +37,25 @@ a foreign country text for a foreign country .IP .B Paris -a town. +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 cities in AT, DE, NL are supported plus some international capitals. +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 +.BI \-d day Calc rates for \fIday\fP. \fIday\fP can be one of .IP .I dd @@ -74,8 +87,24 @@ Time \fIhh[:mm[:ss]]\fP of call. Default is now. .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) +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. @@ -104,7 +133,7 @@ Start as a daemon and go background. .B \-CD3 Stop a running daemon. .P -.B \-G n +.BI \-G n Print raw data for connection. \fIn\fP may be currently 97,98,99. .P .B \-H @@ -120,12 +149,12 @@ duration ; charge/min ; takt ; minimum price Show info about following numbers. If no provider is given, the preselected provider is used. .P -.B \-S sort -Sort output by \fIsort\fP, which may be +.BI \-S sort +Sort output by \fIsort\fP, which may be .IP -.B v +.B v vbn or -.B n +.B n provider name. Default is by charge. .P .B \-T @@ -134,12 +163,12 @@ Print a table of charges for daytimes weekday/weekend. .B \-V Print version info and exit. .P -.B \-X explain +.BI \-X explain Print additional information for charge or from rate-file. .I explain may be .IP -.B 1 +.B 1 (zone) .br .B 2 @@ -153,11 +182,25 @@ 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 +Note also: Sort by name or providernumber and .BI -b best will bring you the first .I best @@ -170,10 +213,51 @@ don't require a telefon .SH FILES .IR rate-CC.dat , .IR holiday-CC.dat , -.IR country-de.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 -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 diff --git a/doc/rate-files.man b/doc/rate-files.man index 18dcd78d..b8245351 100644 --- a/doc/rate-files.man +++ b/doc/rate-files.man @@ -1,10 +1,10 @@ '\" t '\" ** above should format a table ** -.TH rate-files 5 "21.Sep.1999" -lt- +.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 rate-files used by isdnlog(8) and by isdnrate(1) are textfiles with the following overall layout: .P .I Header entries @@ -16,22 +16,46 @@ 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 +.B V:versionsstring .IP -e.g. +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 +A new provider starts always with a .B P: -tag and consists of a -.I Providerheader -followed by -.I Providerzones. +tag and consists of a +.I Providerheader +followed by +.I Providerzones. .SS Providerheader .P .B P:providernumber providername @@ -46,9 +70,6 @@ VBN-Number for provider e.g. B:1002 .P -Note: Currently the vbn is calculated from the providernumber, but this may -change in the near future. The providernumber will be an arbitrary string then. -.P .B C:COMMENT: comment .P .B COMMENT @@ -75,31 +96,39 @@ l l. .P .B D:zone .P -Name of zone file (inserted for +Name of zone file (inserted for .B %s -in ZONEFILE=/usr/lib/isdn/zone-de-%s.dat from isdn.conf) +.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 +and .B T: -tags and optional -.B S: tags. .P A zone is a region of areas, for which the same rates apply. Interior and -foreign zones should not be mixed. +foreign zones should not be mixed and all foreign zones should follow +domestic zones. .P .B Z:zonelist zonename .P -where +where .I zonelist is .BR zone [ -zone ][ ,... ] @@ -111,8 +140,10 @@ Z:1-2,4 Interior .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 +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 @@ -120,7 +151,7 @@ A:19430,07189 # Online e.g. A:+31,Belgium # Int 1 .P -Note: There should always be exactly one zone with your countrycode +Note: There should always be exactly one zone with your countrycode or countryname respectively: .IP Z:4 @@ -129,12 +160,11 @@ A:+49 .br T:... .P -.BR N:area [ ,area... ] -.P -.I area -as above, but numbers can not be dialed, because provider doesn't support it. -.P -Note: N/Y +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 @@ -142,15 +172,15 @@ where .I daylist is .BR day [ -day ][ ,... ] -and day is a daynumber (1=Mon, 2=Tue, ...) or W (weekday), E (weekend), H (holiday) or +and day is a daynumber (1=Mon, 2=Tue, ...) or W (weekday), E (weekend), H (holiday) or * (everyday). .P -.I timelist -is +.I timelist +is .BR hour [ -hour ][ ,hour ] where hour is a number 0..23 or * for everytime. .P -After +After .I daylist/timelist follows .B = @@ -168,11 +198,11 @@ where .I MinCharge| is an (optional) minimum charge, .I Charge -the rate per +the rate per .I Duration seconds or optional rate per .I (Divider) -seconds, +seconds, .I Duration is the length of one charge impuls in seconds. After .I Delay @@ -196,10 +226,10 @@ T:*/*=0.50/0,1(60)/1 always Everyday, everytime there is a connection fee of 0.50, then charge is 1 per minute. .IP e.g. -T:H/*=0.05/60:600,0.05/30 holidays +T:H/*=0.5/60:600,0.5/30 holidays .IP -On holidays, everytime a charge of 0.05 per second in a minutes interval, after -10 minutes in half a minutes interval. +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 @@ -207,14 +237,6 @@ T:*/*=1.3/0,0/1 Everyday, everytime the charge is 1.30 independent of duration, which could also be written as T:*/*=1.3|0/1. .P -.B S:servicename -.P -.I servicename -is currently under construction. -.IP -e.g. -S:Internet by call -.P .SH SEE ALSO .IR isdnlog(8) , .IR isdnrate(1) ,