home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 2 / CDPD_II_2352.bin / scope / 051-075 / scopedisk71 / syslog / syslog.doc < prev    next >
Text File  |  1992-10-27  |  11KB  |  330 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                                                           1
  8.      July 5, 1989      SysLog V1.4 - Amiga System Log Program
  9.  
  10.  
  11.      Overview
  12.      --------
  13.  
  14.           SysLog provides a system logging function that can be common
  15.           to all aspects of your Amiga system.  It simply appends a
  16.           timestamped, user-supplied comment to the SYSTEM.LOG, an
  17.           ascii text file located in the S: directory.  Thus, the
  18.           S:SYSTEM.LOG can collect any information you wish to record,
  19.           keeping entries in chronological order and making them
  20.           easily available for subsequent searching, editing or
  21.           archiving.  SysLog may be executed from the Workbench or the
  22.           CLI.  It may be used from an Execute script to record the
  23.           execution or progress of your scripts or used in "requester"
  24.           mode to request log information from a user.  If SYSTEM.LOG
  25.           is not already in your S: directory, it will be created the
  26.           first time you log a message.
  27.  
  28.  
  29.      Written by
  30.      ----------
  31.  
  32.           Don Nafis
  33.                Nazlo Associates Ltd.
  34.                P.O. Box 1515
  35.                Laurel Springs, NJ  08021
  36.  
  37.                (609) 228-8088 Voice
  38.  
  39.                (609) 227-8278 BBS -
  40.                           Viva! Amiga!
  41.                     3/12/24 - 8/N/1 - 24 hours
  42.                          130 Megabytes
  43.  
  44.                Compuserve 70656, 133
  45.  
  46.           Copyright 1989, by Don Nafis & Nazlo Associates Ltd. All rights
  47.           reserved.  May be copied and freely distributed for personal use.
  48.           If you find SysLog useful and you wish to contribute to future
  49.           versions, send your suggestions to one of the above.
  50.  
  51.           If you wish to be a registered user, send $5.00 to the mailing
  52.           address above.  This will help defray the expense of sending you
  53.           the next version of SysLog if, in fact, I do produce another
  54.           version.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.    Copyright 1989 by Don Nafis and Nazlo Associates Ltd.  All rights reserved.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.                                                                           2
  73.      July 5, 1989      SysLog V1.4 - Amiga System Log Program
  74.  
  75.  
  76.  
  77.  
  78.      Usage
  79.      -----
  80.  
  81.           From the CLI:
  82.  
  83.                SysLog [ [-r[ user prompt]] | [message to log] ]
  84.  
  85.  
  86.           In its simplest form, SysLog appends the characters following
  87.           "SysLog" on the command line to a date and time stamp and appends
  88.           the resulting text string to the file S:SYSTEM.LOG.  No quotes
  89.           are needed to contain the message; if quotes are used, they will
  90.           be logged with the message.
  91.  
  92.           Examples:
  93.  
  94.                SysLog System startup from BOOT:
  95.                SysLog Check out BBS.  Viva! Amiga! (609)227-8278.
  96.                SysLog Jan had her baby.  Named Michael - 8lbs 2oz.
  97.                SysLog Finished Version 1.4 of the SysLog program.
  98.  
  99.  
  100.           The format "SysLog -r" will pop a window on the screen requesting
  101.           "Make System Log Entry:".  You can begin typing the message
  102.           immediately.  If you mouse click anywhere else, the requester
  103.           will be de-selected so you will have to re-select it to enter
  104.           your message.  When your message is complete, type <return> and
  105.           the message will be appended to S:SYSTEM.LOG.  If you type
  106.           <return> without entering any text, the program terminates
  107.           without making an entry in S:SYSTEM.LOG.  You may use normal
  108.           Intuition string editing features when typing your text entry.
  109.           The format "SysLog -r user prompt" (note the space between the
  110.           -r and the user prompt) will operate the same as SysLog -r but
  111.           place up to 50 characters of the text following "-r" into the
  112.           requester border to prompt for text entry.  This form can be
  113.           useful if you wish to customize log information requests in
  114.           EXECUTE scripts.
  115.  
  116.           Examples:
  117.                SysLog -r
  118.                SysLog -r Enter the latest news!
  119.                SysLog -r What is the weather like today?
  120.  
  121.           Note that the message format and the -r format are mutually
  122.           exclusive.
  123.  
  124.  
  125.    Copyright 1989 by Don Nafis and Nazlo Associates Ltd.  All rights reserved.
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.                                                                           3
  139.      July 5, 1989      SysLog V1.4 - Amiga System Log Program
  140.  
  141.           From the Workbench:
  142.  
  143.           To execute from the Workbench, click on the SysLog icon.  To make
  144.           it available, copy the files SysLog and SysLog.INFO to the drawer
  145.           you wish to use when you execute it.
  146.  
  147.           Execution from the Workbench operates the same as the simple
  148.           "SysLog -r" format.  You may not change the requester prompt as
  149.           you can from the CLI.
  150.  
  151.  
  152.      Some suggestions
  153.      ----------------
  154.  
  155.           Of course, you can log any event you care to, any comments that
  156.           you suspect may be interesting to review at some later time, but
  157.           these suggestions should give you some ideas.
  158.  
  159.           -Place a syslog command in your startup-sequence to record when
  160.           you boot up and which startup-sequence or floppy you use to boot.
  161.  
  162.           -Create a shutdown sequence to log the time that you quit, also
  163.           include the "Park" command for your hard disk if your hard disk
  164.           needs one.  Thus you can record how much time you are spending on
  165.           your system each day.  A good log of computer usage could help
  166.           substantiate a business expense claim on your income tax.
  167.  
  168.           - Log a description or the progress of your more important
  169.           Execute scripts as they are executing.  For instance, I boot
  170.           Viva! Amiga! from an Execute script, determining in the script if
  171.           the recovery program needs to be run.  If so, the recovery script
  172.           is executed automatically.  By logging both the startup and
  173.           recovery, I can capture a history of BBS problems.
  174.  
  175.           - Keep a record of steps you take in developing a program.  Make
  176.           an entry on those days you make major progress or those days when
  177.           you feel stumped.
  178.  
  179.           - Log little tidbits of useless information when you really have
  180.           no place else to save them. A joke you heard, a phone number you
  181.           may never need but for some reason feel you must save, an
  182.           unforgettable quote that you may forget, the first time you heard
  183.           that the product you want to buy will be available "real soon
  184.           now", each time you hear it will be available "real soon now".
  185.  
  186.           - Make a record of phone calls; on customer service type calls,
  187.           record who you called, why, who you talked to and what they said
  188.           they would do next.  Use multiple entries if you need to record a
  189.           lot of information.
  190.  
  191.    Copyright 1989 by Don Nafis and Nazlo Associates Ltd.  All rights reserved.
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.                                                                           4
  205.      July 5, 1989      SysLog V1.4 - Amiga System Log Program
  206.  
  207.           - Log your system anomalies such as a disk read error, a program
  208.           GURU (after you re-boot).  You can analyze the data over a period
  209.           of time to determine if things are getting worse, better or if
  210.           there is no pattern to any of your problems.
  211.  
  212.           - Log the installation of all new software.  This information may
  213.           be very useful if combined with system anomaly information.
  214.  
  215.           By keeping all of this information in one place, in S:SYSTEM.LOG,
  216.           you will have no need to search through stacks of disks or papers
  217.           or scan hundreds of files looking for a piece of information you
  218.           knew you had recorded at some time in the past.
  219.  
  220.           As you add more and more information to the SYSTEM.LOG, it could
  221.           grow pretty large.  Each month, using an editor, I remove all
  222.           items logged for the previous month, create a separate file with
  223.           just these log entries, and ARC it into my running archive.  In
  224.           this way, I can maintain a complete "diary" of system usage,
  225.           problems etc., without cluttering up my S: directory.
  226.  
  227.  
  228.      Sample Log Entries
  229.      ------------------
  230.  
  231.      June 23, 1989   08:28:47   System startup from BOOT:
  232.      June 23, 1989   19:06:29   Check out BBS.  Viva! Amiga! (609) 227-8278.
  233.      June 23, 1989   20:10:30   Jan had her baby.  Named Michael -  8lbs 2oz.
  234.      June 23, 1989   21:03:39   System shutdown.
  235.      June 24, 1989   11:53:02   System startup from BOOT:
  236.      June 24, 1989   12:10:06   The A2000 has arrived.
  237.      June 24, 1989   18:22:16   Finished Version 1.4 of the SysLog program.
  238.      June 24, 1989   19:02:51   System shutdown.
  239.  
  240.  
  241.      The Future of SysLog
  242.      --------------------
  243.  
  244.           The following items are in the job jar for future versions of
  245.           SysLog:
  246.  
  247.                - Residency.  If enough people use SysLog enough of the
  248.                time, I may be convinced to make the code PURE so that it
  249.                may be used in resident mode.  Assuming that multiple copies
  250.                could then be executing at the same time -
  251.  
  252.                - Background execution.  This means that one copy would be
  253.                running while additional invocations would pass the log
  254.                message to the background version for logging through a
  255.                message port.  If this gets rolled in, the next logical step
  256.  
  257.    Copyright 1989 by Don Nafis and Nazlo Associates Ltd.  All rights reserved.
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.                                                                           5
  271.      July 5, 1989      SysLog V1.4 - Amiga System Log Program
  272.  
  273.                is -
  274.  
  275.                - ARexx support.  SysLog would be a resident ARexx host
  276.                process.
  277.  
  278.                I'm not convinced that there is any advantage to ARexx
  279.                support though.  Considering the following comparison:
  280.  
  281.                Current use of SysLog in an ARexx script -
  282.  
  283.                     command 'syslog this will be logged in S:SYSTEM.LOG'
  284.                      - or -
  285.                     command 'syslog -r Enter something here:'
  286.  
  287.                With SysLog as an ARexx host -
  288.  
  289.                     address 'SYSLOG'
  290.                     'LOG this will be logged in S:SYSTEM.LOG'
  291.                     - or -
  292.                     address 'SYSLOG'
  293.                     'REQUEST Enter something here:'
  294.  
  295.                it seems like a toss-up.  If I'm missing something, I'd
  296.                appreciate someone letting me know.
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.    Copyright 1989 by Don Nafis and Nazlo Associates Ltd.  All rights reserved.
  326.  
  327.  
  328.  
  329.  
  330.