home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / ijpb014.zip / ReadMe.DOC < prev   
Text File  |  1998-07-28  |  10KB  |  232 lines
  1. *****************************************************************************
  2.  InjoyPB - Injoy Phone Bill
  3.  **************************
  4.  Calculation of online telephone cost using Injoy logfiles
  5.  
  6.  Version 0.14 : 27.07.98
  7.  Version 0.13 : 25.06.98
  8.  Version 0.12 : 23.06.98
  9.  Version 0.11 : 16.06.98
  10.  Version 0.1  : 23.04.98
  11.  Started      : 16.04.98
  12.  
  13.  Copyright (c) 1998 Cornelis Bockemuehl - All rights reserved
  14.  email: cbockem@datacomm.ch
  15. *****************************************************************************
  16.  
  17. Disclaimer
  18. ----------
  19.  
  20.  This program is "freeware", so everybody may use it freely "as is" and at
  21.  own risk. The author gives no warranty whatsoever, nor guarantees any
  22.  functionality. The program may be freely distributed, provided the whole
  23.  package is left intact including all the files listed below.
  24.  All rights remain with the author (Cornelis Bockemuehl).
  25.  Please send me an e-mail if you use the program (cbockem@datacomm.ch):
  26.  I'm just curious...
  27.  
  28. Purpose
  29. -------
  30.  
  31.  Gives you an overview of your monthly online phone bill, if you are
  32.  using InJoy as your internet dialin program (see http://www.fx.dk). The
  33.  tariff system is configurable per InJoy "host" definition. The InJoy
  34.  connection log files (<host>.log) are used for that purpose.
  35.  
  36. Known limitations
  37. -----------------
  38.  
  39.  - For configuration limitations see below in the "Configuration" section.
  40.  - There may be (small) rounding errors depending on how exactly your
  41.    telephone company counts the units. InjoyPB assumes they are rounded
  42.    up for every single phone call.
  43.    Note: You cannot calculate the total cost in one tariff level from
  44.    the total monthly online time in that level, because EACH TIME you
  45.    connect and disconnect the cost for that specific call is rounded up!
  46.    InjoyPB takes account of that fact.
  47.  - As you see from the version number, this program isn't yet very old,
  48.    and so it possibly contains unrecognized errors ("beta code", if you
  49.    want).
  50.  
  51. Unknown limitations (vulgo: bugs)
  52. ---------------------------------
  53.  
  54.  This program isn't tested thoroughly in all sorts of environmants and
  55.  with all kinds of configurations: it's a "beta" if you want. I cannot
  56.  guarantee for any functionality, BUT: If you run into any problems or
  57.  bugs, just send me a mail with everything I need to reproduce it: You
  58.  might be the first one to try out a new, corrected version of the
  59.  program!
  60.  
  61. Usage
  62. -----
  63.  
  64.    injoypb <host> {month{.year}}
  65.  
  66.  where
  67.  - <host> is the name of the host(s) to calculate a phone bill for, as
  68.    used in Injoy.
  69.    Remark: Injoy creates log files per host with the name <host>.LOG in
  70.    the Injoy folder. If the name of the host as it appears in the Injoy
  71.    window is longer than 8 characters, it is replaced by a shorter version:
  72.    You have to use this shortened version for InjoyPB (because it uses
  73.    the log files!).
  74.  - Wildcards (*,?) are allowed in the <host> specification, so you can
  75.    calculate the bill for several hosts at the same time.
  76.  - If you don't give a month, the program will ask.
  77.  - If you don't give the year, the current year is assumed.
  78.  
  79. Examples
  80. --------
  81.  
  82.    injoypb default
  83.    - asks user for month (and year)
  84.  
  85.    injoypb default 4
  86.    - calculates telephone cost for April of current year
  87.  
  88.    injoypb default 4.98
  89.    injoypb default 4.1998
  90.    - calculates telephone cost for April 1998
  91.  
  92.    injoypb def*
  93.    - asks for month
  94.    - calculates for all defined hostnames starting with 'def'
  95.  
  96. Installation
  97. ------------
  98.  
  99.  - Unzip or copy all the files in this package to a temporary directory.
  100.    (You probably did that already, since you are reading this text).
  101.  - Run 'Install' from the command line: You are asked to enter the
  102.    INJOY main directory, where a subdirectory is created for INJOYPB.
  103.    All the files are copied there and a folder is created on your
  104.    desktop containing objects for running and configuring the program.
  105.    At the end 'Config' starts automatically which configures a first
  106.    host definition. You can skip this last step and do the configuration
  107.    later (see "Configuration" section below).
  108.  - Now you can delete all the files from your temporary directory.
  109.  - That's all. You can open the "settings" of the "Injoy Phone Bill"
  110.    program object and change the parameters if you are using another
  111.    host name than "default", or make as many copies of the object
  112.    as you are using hosts and adapt them to your needs.
  113.    Note: 'Config' also creates adapted program objects for each host,
  114.    if you want.
  115.  
  116.  Hint: If you want to calculate the total phone bill for a number of
  117.  (or all your) hosts at the same time, you can enter the host name
  118.  using wildcards (*,?), but you will get the problem of not being
  119.  able to read the whole output as fast as it scrolls by. This is
  120.  ok if you only want to see the end result, but you can have the whole
  121.  list if you create a program object from the command file CalcMany.CMD
  122.  with "<host_with_wildcards> [month]" as parameter line and the
  123.  InjoyPB directory as the working directory. The installation procedure
  124.  automatically creates such a program object that calculates all your
  125.  host definitions (using * for the host).
  126.  
  127. Deinstallation
  128. --------------
  129.  
  130.  - Go to the 'Injoy' working directory, change to the 'InjoyPB'
  131.    subdirectory (cd IJPB) and run 'Deinst' from the command line: This
  132.    will try to delete the desktop objects and all files that belong to
  133.    the InjoyPB package.
  134.  - If you want, delete the files InjoyPB.CFG and Deinst.CMD, as well as
  135.    the IJPB subdirectory by hand: This step is not included in the
  136.    automatic deletion process because it contains YOUR configuration
  137.    data which cannot be restored by just reinstalling InjoyPB later on.
  138.  
  139. Configuration
  140. -------------
  141.  
  142.  You can configure the program in two ways, whichever you like more:
  143.  1. For an "semi-automatic" configuration use the configuration program
  144.     'Config'. Just start it from the Injoy working directory or
  145.     doubleclick on the desktop object. It will ask you all the questions
  146.     necessary to add or change one of the host definitions within the
  147.     InjoyPB configuration file.
  148.  2. Edit the InjoyPB.CFG file 'by hand'. It contains all the information
  149.     necessary (as comments) to adapt the different entries to your needs.
  150.     Just doubleclick on the 'Edit InjoyPB.CFG' object to start the OS/2
  151.     system editor.
  152.     Note: Don't change the comments in that file, as they are also used
  153.     for the 'semi-automatic' configuration!
  154.     Note: Changing of a given definition may be easier "by hand" than
  155.     "automatic", since "changing" that way actually means redefining,
  156.     i.e. re-entering the whole (changed) definition
  157.  If you want to call InjoyPB for other than the "default" host you will
  158.  have to copy the original program object and adapt the "parameters" line
  159.  in the "settings": Just replace "default" by the name of the host
  160.  definition you want to use. 'Config' does this step automatically for
  161.  newly defined hosts, if you want.
  162.  
  163. Configuration remarks
  164. ---------------------
  165.  
  166.  The configuration options of InjoyPB are such that they accomodate all the
  167.  strange tariff systems I know - but I do actually know only very few.
  168.  Anyway, configuration is rather flexible, so I hope that most systems will
  169.  fit into it somehow. If not: Just send me an email (cbockem@datacomm.ch)
  170.  giving all the necessary details of your tariff system, so I can possibly
  171.  adapt the program, but no promises of course: I wrote the program for my own
  172.  purposes in the first place and I MIGHT have to set other priorities at a
  173.  given moment. But asking doesn't cost you anything ;-)
  174.  
  175.  Features included in the actual configuration:
  176.  - Using different tariff systems depending on the "host" definition within
  177.    InJoy.
  178.  - Different "units" (smallest possible "step") and currencies.
  179.  - 26 different tariff levels.
  180.  - Definition of a custom holiday table, including "moving" holidays like
  181.    easter.
  182.  - Definition of a "special dates" table for dates where special rates
  183.    are applicable.
  184.  - Tables indicating which tariff level to use at which time of which
  185.    day of the week or holiday.
  186.  
  187.  Features NOT included:
  188.  - Using different tariff systems for one and the same "host" definition,
  189.    e.g. if you gave a whole list of phone numbers: This information is not
  190.    included in the log files produced by InJoy (and not applicable in my
  191.    own case :-)).
  192.  - Tariff systems depending on the duration of the actual call: This could
  193.    probably be included in another version of InjoyPB if it is really
  194.    nececcary, but I don't know if such a thing is needed by anybody.
  195.  - Many other things I haven't even dreamt of until now...
  196.  
  197.  Workarounds:
  198.  - If you are using different phone numbers or have several ways of calling
  199.    your provider using different tariff systems: Just define "hosts" for
  200.    each of them, so InJoy will produce several log files. Then you can run
  201.    InjoyPB once for each of your logs. Tip: Make copies of your program
  202.    object and adapt the "parameters" line in the "settings", if you don't
  203.    use 'Config' for that purpose.
  204.  
  205. Files included in this package
  206. ------------------------------
  207.  
  208.  InjoyPB.EXE      - The program file
  209.  InjoyPB.CFG      - The configuration file, containing all tariff definitions
  210.  ReadMe.DOC       - Documentation (this file)
  211.  Config.CMD       - Configuration of InjoyPB
  212.  Install.CMD      - Installation of InjoyPB
  213.  DeInst.CMD       - Deinstallation of InjoyPB
  214.  CalcMany.CMD     - Calculate phone bill for many hosts and view result with
  215.                     the system editor
  216.  Folder.ICO, InjoyPB.ICO, ConfigA.ICO, ConfigM.ICO, Docs.ICO
  217.                   - Icons
  218.  
  219. Contacting the author
  220. ---------------------
  221.  
  222.  Please send me an e-mail if
  223.  - you are using InjoyPB - I'm just curious how it makes it's way!
  224.  - you find any strange behaviour or errors: Please give an exact description
  225.    and append example log and cfg files!
  226.  - you have any suggestions or wishes for improving InjoyPB - asking costs
  227.    nothing!
  228.  - you find any errors or strange expressions within this documentation:
  229.    I am not a native english-speaker!
  230.  
  231.  My e-mail address: "Cornelis Bockemuehl" <cbockem@datacomm.ch>
  232.