home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / busi / irslog11.zip / IRSLOG.DOC < prev    next >
Text File  |  1990-11-19  |  17KB  |  330 lines

  1.               ┌────────────────────────────────────────┐
  2.               │                                        │
  3.               └┐        ┌──────────────┐      ┌────┐   │
  4.                │        │              │      │    └───┘ <tm>
  5.                │        │              │      │
  6.                │        │              │      │  Electronic Technologies
  7.                │        └──────┐       │      │  3985 S. Rochester Road Ste.H
  8.                │        ┌──────┘       │      │  Rochester, Michigan  48063
  9.                │        │              │      │
  10.                │        └────────────┐┌┘      └┐   CompuServe ID: 70337,1654
  11.                │                     ││        │   7 day 24 hr BBS SUPPORT:
  12.                └─────────────────────┘└────────┘    A/R BBS (313) 680-9154
  13. SHAREWARE & FEES:
  14.    The sole intention of shareware is to provide an inexpensive copy of the
  15.    program for evaluation purposes only.  Shareware is not free software. If
  16.    you find value in this software and if you intend to use this software on a
  17.    regular basis then you are morally obligated to pay for it.  An order form
  18.    has been included at the end of this documentation.
  19.  
  20.    The shareware version of this software may be distributed free of charge by
  21.    use of electronic bulletin board services. However, any other distribution
  22.    of this program must first be approved in writing by the author.  If you
  23.    are a software vendor, member of a user group or other organization then
  24.    you must read the file "DISTRIB.DOC" for information about the rules and
  25.    legalities which must be followed in the distribution of this software.
  26.  
  27. LICENSE:
  28.    Once a donation has been received, the program is officially registered and
  29.    licensed.   Registration permits a user the license to use this program
  30.    only on a single PC.  A registered user may use the program on a different
  31.    computer, but may not use the program on more than one computer at the same
  32.    time.  No user may modify this software in any way, including but not
  33.    limited to decompiling, disassembling or otherwise reverse engineering the
  34.    program.
  35.  
  36. WARRANTY:
  37.    The author makes no warranty of any kind express or implied, including
  38.    without limitation, any warranties of merchantability and/or fitness for a
  39.    particular purpose.
  40.  
  41.    IN NO EVENT WILL ELECTRONIC TECHNOLOGIES OR THE AUTHOR BE LIABLE FOR ANY
  42.    DAMAGES, WHETHER DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL INCLUDING ANY
  43.    LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
  44.    ARISING OUT OF YOUR USE OR INABILITY TO USE THIS PROGRAM, OR FOR ANY CLAIM
  45.    BY ANY OTHER PARTY.  THIS PROGRAM IS OPERATED ENTIRELY AT THE USER'S RISK.
  46.  
  47. TECH SUPPORT:
  48.    Tech support is limited to one year for registered users only, and is
  49.    available by mail, Compuserve "EasyPlex" or 24 hour Bulletin Board service.
  50.    Questions should be submitted to the attention of Charles Eglinton.
  51.  
  52.    When requesting technical support please report the following:
  53.       1) Memory before running the program (use the dos command "CHKDSK:)
  54.       2) Computer, modem and printer type (if applicable)
  55.       3) The names of any TSR memory resident programs (Sidekick, Prokey..)
  56.       4) A listing of both your AUTOEXEC.BAT and CONFIG.SYS files.
  57. -----------------------------------------------------------------------------
  58.  
  59.            IRS:Log & IRS:Report v1.00 - Copyright 1990 by Charles Eglinton
  60.                  Full documentation and License for only $30.00
  61.                   (+$2 for 3.5"-720K disks if needed/requested)
  62.  
  63.             Charles Eglinton                        Compuserve: 70337,1654
  64.             3985 S. Rochester Rd, Ste. H            A/R BBS: (313)680-9154
  65.             Rochester, Michigan 48063
  66.  
  67. ----------------------------------------------------------------------------
  68. WHAT IS IRS:Log?
  69.  
  70.   IRS:Log is a 1.5K TSR, memory-resident logging program that automatically
  71.   records start times, elapsed times and the complete command lines of
  72.   programs.  IRS:Log is quick, silent and automatic.
  73.  
  74.   The IRS:Report program evaluates and summarizes your log entries by
  75.   category.  Reports can be displayed or printed.  You can select the
  76.   beginning date, ending date and categories.  THE REGISTERED VERSION of
  77.   IRS:Log WILL MAKE SPREADSHEET IMPORT FILES for even more complete
  78.   analysis!.  The IRS:Report program can help answer the following questions:
  79.  
  80.   * Which types of computer programs are used most often, and for how long?
  81.   * At what time each day is your computer switched ON (and switched OFF)?
  82.   * How many hours is your computer used each day?
  83.   * How often is your computer switched on but not running programs?
  84.   * How much time has been spent on business and how much on entertainment?
  85.   * How much electricity has your computer consumed and what was the cost?
  86.  
  87.  MANAGERS: Discover how your workers are REALLY using their computers.
  88.  PROGRAMMERS: Create accurate records of specific projects quickly, easily.
  89.  HOME OFFICE PROFESSIONALS: Print an accurate IRS computer usage log.
  90.  BUSINESS OWNERS: Find the true cost and idle times of your computers:
  91.                                   (do you REALLY need another computer?)
  92. ----------------------------------------------------------------------------
  93. IRSLog FEATURES:
  94.  
  95.   Our goal was to make IRS:Log as simple as possible.  We don't enjoy
  96.   reading fifty-page manuals and don't expect you to, either.  We hope
  97.   you'll find IRS:Log an effortless, and useful, utility.
  98.  
  99.   * - EFFICIENT
  100.       - LESS RAM: The resident portion uses only about 1.5K
  101.       - SMALLER FILES: As little as 18 bytes per log file record.
  102.       - The IRS:Report program uses less than 50K and needs no work files.
  103.       - NON-ENCRYPTED: The log file can be viewed directly.
  104.  
  105.   * - EASY TO USE
  106.       - IRS:Log automatically records dates, starting times, elapsed times &
  107.         dos level and command lines. Completely transparent operation.
  108.       - No annoying sounds or hot-keys.
  109.       - IRS:Report program uses intuitive light-bar menus.
  110.  
  111.   * - EFFECTIVE
  112.       - Detailed reports can be sent to the screen, a file or a printer
  113.       - Produces comma delimited ASCII file for import to your
  114.         database or spreadsheet program for more detailed analysis.
  115.       - Summarizes your PC program usage by category.
  116. ----------------------------------------------------------------------------
  117.  
  118. USING IRS:Log:
  119.  
  120.   IRS:Log is probably the easiest log program to use since there are only two
  121.   options to remember:
  122.  
  123.   * To activate: Type IRSLOG followed by a drive letter, path and file name.
  124.  
  125.     Example: IRSLOG C:\IRSLOG.DAT   <---the log file will be 'C:\IRSLOG.DAT'
  126.  
  127.     Remember, IRS:Log automatically writes an 18+ byte record every time you
  128.     end a program.  Make sure that the directory that you choose to contain
  129.     the log file has enough space to allow the log file to grow.  Also, BE
  130.     SURE TO INCLUDE BOTH A DRIVE LETTER AND A COMPLETE PATH NAME OR LOG
  131.     FILES WILL BE WRITTEN IN MULTIPLE DIRECTORIES.
  132.  
  133.   * To uninstall IRS:Log type 'IRSLOG /U' at a DOS prompt.  A message will
  134.     confirm the de-installation.
  135.  
  136.     <<IMPORTANT>>: IRS:Log records the elapsed time when you exit a program
  137.     and return to DOS.  Therefore, if you just switch off the computer
  138.     without making an exit to DOS (or if the computer crashes) then IRS:Log
  139.     has no way to record the elapsed time of the last program.  IF POSSIBLE,
  140.     BE SURE THAT A DOS PROMPT (C:>) IS DISPLAYED WHEN SWITCHING OFF THE COMPUTER.
  141.  
  142. ----------------------------------------------------------------------------
  143. STARTING IRS:Log AUTOMATICALLY:
  144.  
  145.   An excellent way to use IRS:Log is to include it in your AUTOEXEC.BAT file.
  146.   IRS:Log will start automatically since the AUTOEXEC.BAT is the first file
  147.   executed whenever the computer is started.
  148.  
  149.   1) Copy the IRS:Log files to the same subdirectory as your DOS or utility
  150.      files.  This subdirectory must be listed in your "PATH" command in the
  151.      AUTOEXEC.BAT file.  (Example: PATH C:\;C:\DOS;C:\UTILS; etc...)
  152.  
  153.   2) Modify your AUTOEXEC.BAT file so that the IRS:Log command is included.
  154.      The IRS:Log command line must be after any 'DATE' or 'TIME' commands in
  155.      your AUTOEXEC.BAT file.
  156.  
  157.   3) When IRS:Log is invoked it will be loaded to RAM, and an IRS:Log copyright
  158.      message will be displayed.
  159.  
  160.   4) IRS:Log will begin automatically recording your computer activity.
  161. ----------------------------------------------------------------------------
  162.  
  163. READING THE LOG FILE DIRECTLY
  164.   IRS:Log creates a file that can be read directly by most programs that are
  165.   able to read a standard ASCII text file.  An ideal utility for reading the
  166.   log file is Vern Buerg's 'LIST.COM' which can read, and search, a file of
  167.   any size.  Many word processors such as Wordstar, MS Word, MS Works and IBM
  168.   Displaywrite can also read the log file.  Some word processors cannot read
  169.   large log files because of program limitations.
  170.  
  171. LOG RECORD FORMAT (character positions):
  172.   1-2 :YEAR         7-10 :TIME (24 hour clock)       19+ :THE COMMAND LINE
  173.   3-4 :MONTH       11-16 :ELAPSED TIME (HH:MM:SS)    Terminated by a LINE
  174.   5-6 :DAY         17-18 :DOS LEVEL                  FEED & CARRIAGE RETURN.
  175. ----------------------------------------------------------------------------
  176.  
  177. USING the IRS:Report PROGRAM
  178.  
  179.   IRS:Report creates a detailed report from the log file based on
  180.   CATEGORIES and KEYWORDS that you establish.
  181.  
  182.   1) You do not have to uninstall IRS:Log while you use IRS:Report.
  183.  
  184.   2) You must run the IRS:Report program from the directory in which it
  185.      is installed.  Use the 'change directory' command to move to the
  186.      necessary subdirectory.
  187.  
  188.      Example: CD \DOS  <--where \DOS is the directory which contains IRS:Log
  189.  
  190.   3) Type 'IRSREPT' (then press [ENTER]) to run the IRS:Report program.
  191.  
  192.   4) A light bar menu will be displayed at the top of the screen. To select:
  193.  
  194.      * You can press the key that corresponds to the first character of the
  195.        desired selection. (Example: Press 'S' for Settings)
  196.  
  197.      * You can use the arrow keys to move the highlight and then press the
  198.        [ENTER] key when the correct selection is highlighted.
  199.  
  200.      * You can use the [F9] key to move left, [F10] to move right and then
  201.        press the [ENTER] key when the correct selection is highlighted.
  202.  
  203. ----------------------------------------------------------------------------
  204.  
  205. IRS:Report MENU DESCRIPTIONS:
  206.  
  207.   SETTINGS:
  208.     The report configuration is defined by the SETTINGS screen.  After the
  209.     SETTINGS screen is displayed you can use the up and down arrow keys to
  210.     move the cursor within the screen.   Additional information about the
  211.     currently highlighted field will be described in a "Help sentence" on the
  212.     top line of the display. When you have finished, press the [ESC] key to
  213.     exit from the screen and automatically save the settings.
  214.  
  215.     The lower half of the SETTINGS screen contains fields which apply to
  216.     registered copies of IRS:Log, only.  The registered version of IRS:Report
  217.     will automatically create summarized, delimited files which can be
  218.     imported into database and spreadsheet programs.
  219.  
  220.   REPORT:
  221.     You should complete the the SETTINGS and CATEGORIES screens before
  222.     attempting to print or display a REPORT.
  223.  
  224.     After selecting "REPORT" you will be allowed to select the destination of
  225.     the report: DISPLAY, LPT1 or LPT2. The report will always be displayed on
  226.     the screen before it is printed.  You can interrupt the report at any
  227.     time by pressing the [ESC] key.
  228.  
  229.     The report is shown on two screens.  After the first screen is displayed
  230.     you can press any key to display the second screen.  If you are using a
  231.     registered copy of IRS:Log then a catagorized spreadsheet file will be
  232.     generated at the same time the report is displayed.
  233.  
  234. ----------------------------------------------------------------------------
  235.  
  236. CATEGORIES:
  237.  
  238.     This is probably the most important, and the most complicated, function
  239.     of the IRS:Report program.  The CATEGORIES screen is used establish the
  240.     KEYWORDS which IRS:Report will use to decide where to post the ELAPSED
  241.     time of each log file entry.
  242.  
  243.     1) Select CATEGORIES from the main menu.  A list of current CATEGORIES
  244.        will appear.
  245.  
  246.     2) Use the [up] and [down] arrow keys to select the CATEGORY you want to
  247.        change and then press the [ENTER] key.
  248.  
  249.        * The CATEGORIES may be broad.  For example, you may simply have only
  250.          two CATEGORIES: GAMES & BUSINESS with all of your game KEY WORDS
  251.          in the GAMES CATEGORY, and all BUSINESS KEY WORDS listed in the
  252.          BUSINESS CATEGORY.
  253.  
  254.        * The CATEGORIES may be narrow.  For example, to summarize the elapsed
  255.          time for 4 different database programs your CATEGORIES might be
  256.          DBASE, FOXBASE, RBASE, & REFLEX.  The KEYWORDS for each CATEGORY
  257.          would be the specific command line for each program.
  258.  
  259.        * IRS:Report only finds the FIRST occurence of a KEYWORD, posts the
  260.          ELAPSED TIME to the corresponing CATEGORY, and then goes on to the
  261.          next command line.  Therefore, the order of the CATEGORIES is
  262.          important and should be planned in advance. Consider the following
  263.          example:
  264.  
  265.          a) You want to know the elapsed time that BASIC was used.
  266.          b) You want to know the elapsed time of your accounting programs.
  267.          c) The command line for your checkbook program is "BASICA CHECKBOOK"
  268.          d) Assume that CATEGORY 1 is "BASIC" and a KEYWORD is also "BASIC".
  269.          e) Assume that CATEGORY 10 is "ACCOUNTING" and one of the KEYWORDS
  270.             is "CHECKBOOK".
  271.          f) When the command line is analyzed, the elapsed time will errantly
  272.             be posted to "BASIC" instead of "ACCOUNTING".
  273.          g) If you reverse the order of the CATEGORIES then the elapsed time
  274.             from the command line "BASICA CHECKBOOK" will be correctly posted
  275.             to the accounting category.  Any un-categorized basic programs
  276.             will be correctly posted to the "BASIC" CATEGORY.
  277.  
  278.     3) Use the [up] and [down] arrow keys to select the KEYWORD you want to
  279.        change.  Simply begin typing to make a change.
  280.  
  281.        * The KEYWORD is the group of characters that IRS:Report uses to
  282.          identify the category of a log file entry.  The KEYWORD should be
  283.          unique so that IRS:Report doesn't incorrectly identify a log file
  284.          record.
  285.  
  286.        * Do not use the same KEYWORD more than once and do not use the same
  287.          KEYWORD in different CATEGORIES.  IRS:Report will only find the
  288.          first occurence of the KEYWORD when it is evaluating a command line.
  289.  
  290.     4) Press the [ESC] key when you have finished making KEYWORD & CATEGORY
  291.        changes.  The information will be saved automatically.
  292.  
  293. ----------------------------------------------------------------------------
  294.  
  295.   PURGE:
  296.     The PURGE selection can help conserve fixed disk space.  The PURGE will
  297.     remove old, unneeded records from your current log file and move them to
  298.     a separate file which can be removed from the computer.  After selecting
  299.     PURGE from the main menu:
  300.  
  301.     1) You will be prompted to type a PURGE date.  All log records that were
  302.        created before this PURGE date will be removed from the log file.
  303.  
  304.     2) You will be prompted to type a PURGE FILE name.  All records that are
  305.        removed from the log file will be moved to this PURGE FILE. Note:
  306.        After you have quit from the IRS:Report program you can copy the
  307.        purge file to a floppy diskette for permanent storage.
  308.  
  309.     If your fixed disk capacity will allow it, you should only run the PURGE
  310.     function just once per year. Preferably, just after the new year.
  311.  
  312.     * Set the PURGE DATE to '01-01-YY', where 'YY' is the new year.
  313.  
  314.     * Name the PURGE FILE 'XX-LOG.DAT' (where 'XX' is the previous year).
  315.  
  316.     When the PURGE is complete, the log file will contin only records created
  317.     after the first of the current year.  Records from the previous year
  318.     will be moved to 'XX-LOG.DAT' which can be removed from the system.
  319.  
  320. ----------------------------------------------------------------------------
  321. IRS:Log INCOMPATIBILITIES:
  322.  
  323.   Problems which might occur when using IRS:Log with other TSR programs may
  324.   be resolved by experimenting with the order in which you load the memory
  325.   resident programs.
  326.  
  327.   IRS:Log is not recommended for use with multi-tasking software such as
  328.   MicroSoft Windows, DESQview and Software Carousel.
  329.  
  330.