home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / batutl / bat_time.arc / BAT-TIME.DOC next >
Text File  |  1988-05-11  |  6KB  |  153 lines
  1.                      Documentation for BAT-TIME.EXE
  2.  
  3.                                Version:Beta
  4.  
  5.                        Written by Brian Woodworth
  6.  
  7.                    Released for public domain 5/11/88
  8.  
  9.               Included files:BAT-TIME.EXE the executable file.
  10.                              BAT-TIME.DOC this documentation.
  11.                              DEMO*.BAT    demonstration batch files.
  12.                              Several more files will be created as you
  13.                              run the demo's.
  14.  
  15. Program purpose:This program is for users that need to keep track of time
  16.   that is spent on their computer system. BAT-TIME.EXE can keep records of
  17.   start times, finish times and elapsed time totals. BAT-TIME.EXE can also
  18.   send time information to a disk file or to the printer.
  19.  
  20. Usage:BAT-TIME s|f|v|p [c] [filename]
  21.  
  22. Where:s to (s)tart timing.
  23.       f to (f)inish timing.
  24.       v to (v)iew output file.
  25.       p to (p)rint output file.
  26.  
  27.       c to prompt for a Comment.
  28.  
  29.       filename denotes output filename.
  30.  
  31. Usage notes:The comment(c) command can only be used with the start(s) command.
  32.   Filename, when used with finish(f) command, denotes name of file to send
  33.   output to. Filename, when used with view(v) command or print(p) command,
  34.   denotes what file to use for output. Command line parameters must be
  35.   separated by spaces. Case is not important.
  36.  
  37. Explanation of commands.
  38.  
  39.   The 'S' command.
  40.   The s command is used when starting a timing cycle. When the command
  41.  
  42.   BAT-TIME S
  43.  
  44.   is issued BAT-TIME will display the starting time and date. Then a
  45.   small data file will be created name BAT-TIME.DAT. (This file must be
  46.   present on the default drive when the finish command is issued.) The
  47.   only other parameter valid with the start(s) command is the comment(c)
  48.   parameter.
  49.  
  50.   The 'C' parameter.
  51.   The c parameter will cause BAT-TIME to prompt the user for a comment to be
  52.   stored in the output file with respect to the current timing cycle. This
  53.   parameter may only be used with the start(s) command. When the command
  54.  
  55.   BAT-TIME S C
  56.  
  57.   is typed BAT-TIME will first prompt the user for a comment
  58.  
  59.   Enter comment>
  60.  
  61.   your comment can be up to 20 characters(eg. RENO OFFICE). Any comments
  62.   longer than 20 characters will be truncated to 20 characters. After this
  63.   point the time and date information will be displayed. This information is
  64.   stored in the data file (BAT-TIME.DAT) and will be transferred to the output
  65.   file following the finish(f) command. This parameter is only useful when the
  66.   command
  67.  
  68.   BAT-TIME F filename
  69.  
  70.   is used to finish the timing cycle.(See f command and filename parameter.)
  71.  
  72.   The 'F' command.
  73.   The finish(f) command is used to tell BAT-TIME to finish the timing cycle.
  74.   When the command
  75.  
  76.   BAT-TIME F
  77.  
  78.   is issued BAT-TIME will stop the timing cycle, display finish time, display
  79.   elapsed time and erase the data file (BAT-TIME.DAT). If output to an external
  80.   file is desired the filename parameter must be used.
  81.  
  82.   The FILENAME parameter.
  83.   The filename parameter is used for three different cases. The first case
  84.   is for sending output to an external file. This is done when the finish(f)
  85.   command is issued. To stop the timing cycle and send the output to a file
  86.   called PAYROLL.TME type the command
  87.  
  88.   BAT-TIME F PAYROLL.TME
  89.  
  90.   This will also causes any comments, specified with the c parameter, to be
  91.   written to the output file. If the file already exists the new information
  92.   will be appended to the current file (added on to). If the file does not
  93.   exist a new one will be created and the new information written to it.
  94.   For an example of the data format contained in output files see the view(v)
  95.   or the print(p) commands. The filename parameter is also used with the
  96.   view(v) or print(p) commands to specify the file to be viewed or printed.
  97.  
  98.   The 'V' command.
  99.   The view(v) command is used to view the contents of a file specified by
  100.   the command "BAT-TIME F Filename". The format of this command is
  101.  
  102.   BAT-TIME V Filename
  103.  
  104.   For example, if you want to view the contents of the file called PAYROLL.TME
  105.   type the command
  106.  
  107.   BAT-TIME V PAYROLL.TME
  108.  
  109.   The output will look similar to this.
  110.  _____________________________________________________________________________
  111.  |Start Time              Finish Time             Elapsed    Comments        |
  112.  |10:45:37 on 05/10/1988  14:51:42 on 05/10/1988   04:06:05  RENO OFFICE     |
  113.  |15:00:25 on 05/10/1988  17:12:59 on 05/10/1988   02:12:34  L.A. OFFICE      |
  114.  |                                                                           |
  115.  |Elapsed time total = 06:18:39                                              |
  116.  |___________________________________________________________________________|
  117.  
  118.   The 'P' command.
  119.   The print(p) command is used to send the contents of an output file to a
  120.   printer. The output is identical to the view(v) command. The command
  121.  
  122.   BAT-TIME P PAYROLL.TME
  123.  
  124.   will send the contents of the file PAYROLL.TME to a printer. BAT-TIME will
  125.   send a form feed (ascii character 12d) every 55 lines to make the print
  126.   easier to read.
  127.  
  128.   Limitations.
  129.  
  130.  -BAT-TIME will not accurately keep track of time across the change of months.
  131.   In other words if you start BAT-TIME at 11:55:00 on 07/31/1988 and finish
  132.   BAT-TIME at 01:32:30 on 08/01/1988 then output results will be unpredictable.
  133.   If for some reason the results are correct it will be by pure chance.
  134.  
  135.  -The data file BAT-TIME.DAT must be on the default drive when the finish
  136.   command is issued. If this file is not present BAT-TIME will assume that
  137.   it has never been started. BAT-TIME will recognize this situation and
  138.   issue an error message. The data file need not be present during any other
  139.   time after the start command has been given.
  140.  
  141.  -If you attempt to view(v) an output file that is not one created by
  142.   BAT-TIME the results will be unpredictable. BAT-TIME does not have any
  143.   resources for detecting this kind of error.
  144.  
  145.   Notes.
  146.  -BAT-TIME can (and will) be restarted if the start command is issued a second
  147.   time before the finish command has been used. BAT-TIME does not attempt to
  148.   prevent this situation.
  149.  
  150.   Have fun
  151.  
  152.   Brian Woodworth
  153.