home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / util / time / olt / olt.autodoc < prev    next >
Encoding:
Text File  |  1995-06-24  |  3.4 KB  |  116 lines
  1. Olt/Documentation                                           Olt/Documentation
  2.  
  3.    PROGRAM
  4.      Olt
  5.      Version 1.2
  6.      Relase date: 24.6.95
  7.  
  8.    COPYRIGHT
  9.      © 1995 Paul Huxham
  10.      Bonusware, all rights reserved.
  11.  
  12.    DISTRIBUTION
  13.      Olt should be distributed at no charge to the end user. It may be
  14.      included on CDROMs with no restrictions.
  15.  
  16.    PURPOSE
  17.      Displays an incremental counter, ideally suited for displaying total
  18.      modem connect time.
  19.  
  20.    CONTENTS
  21.      Olt = This is the program.
  22.      Olt.autodoc = Documention you are reading now.
  23.  
  24.    USAGE
  25.      Olt can be called from the shell or Workbench.
  26.  
  27.      From the shell, Olt supports the following arguments:
  28.  
  29.      PUBSCREEN,REXXPORT,X/N,Y/N,UPDATE/N,TOFRONT/S
  30.  
  31.      PUBSCREEN is the public screen on which to open the Olt window. Case
  32.       sensitive. Defaults to the default public screen (usually Workbench).
  33.  
  34.      REXXPORT is the name of the ARexx port to create. It will be converted
  35.       to uppercase and no other application can be using an identical name.
  36.       If the name is already in use, Olt will fail with an error.
  37.  
  38.      X is the x position of the top left corner of the window.
  39.  
  40.      Y is the y position of the top left corner of the window. If you supply
  41.       -1 for this value, the window will be positioned just below the
  42.       screens' title bar.
  43.  
  44.      UPDATE is the number of seconds to wait between updates of the counter
  45.       display. If this is 0 (default), then the timer will be updated when
  46.       Olt is the active window. If you sepcify say 10, then timer will be
  47.       updated every ten seconds.
  48.  
  49.      TOFRONT when specified will bring the Olt window to the front whenever
  50.       the timer display is updated.
  51.  
  52.      From the Workbench, OkayDokey supports the following tooltypes:
  53.  
  54.      PUBSCREEN, REXXPORT, X, Y, UPDATE, TOFRONT
  55.  
  56.       These function the same as their shell equivalents.
  57.  
  58.    REQUIREMENTS
  59.      A minimum of Kickstart 2.x is required.
  60.  
  61.    NOTES
  62.      If Olt fails to open the ARexx port it will fail and return a value of
  63.      20 in the local environment variable RC.
  64.  
  65.    AREXX
  66.      The ARexx interface of Olt supports the following commands:
  67.  
  68.       CONNECT returns the time that the Olt timer was reset (or started if
  69.        never reset) in the ARexx 'result' variable. The string returned is
  70.        formatted as follows:
  71.  
  72.         16 12 47 12 4 1995
  73.  
  74.        Where the fields are: Hours Minutes Seconds Day Month Year
  75.  
  76.       ONLINE returns the total time from connect timer to now as a string in
  77.        'result'. The string returned is formatted as follows:
  78.  
  79.         16 13 00
  80.  
  81.        Where the fields are: Hours Minutes Seconds
  82.  
  83.       RESET resets the connect timer to the current time, meaning you can run
  84.        Olt in a startup and reset it later.
  85.  
  86.       SYSTIME returns the current system time and date in the same format as
  87.        CONNECT.
  88.  
  89.       SHUTDOWN quits and removes Olt.
  90.  
  91.    HISTORY
  92.      V1.0 Not released.
  93.      V1.1 Not released.
  94.            * Added UPDATE argument.
  95.      V1.2 First public release.
  96.            * Added TOFRONT argument.
  97.  
  98.    COMPLIER
  99.      Olt was written using CED V3.5 and compiled with SAS/C 6.55 on
  100.      an Amiga 4000/040. Enforcer was used to detect and correct programming
  101.      errors.
  102.  
  103.    BUGS
  104.      None known at present.
  105.  
  106.    AUTHOR
  107.      You can contact the author via:
  108.       Email:
  109.        paulh@Perth.DIALix.oz.au
  110.      or
  111.        P.O. Box 875
  112.        Morley,
  113.        Perth,
  114.        Western Australia 6943
  115.  
  116.