home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / qbbsetc / readlog.lzh / READLOG.DOC next >
Encoding:
Text File  |  1991-03-10  |  5.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                         ┌─────────────────────────────┐
  11.                         │      -*-  ReadLog -*-       │
  12.                         └─────────────────────────────┘
  13.  
  14.                                     v1.00
  15.  
  16.                            For RemoteAccess v1.00+
  17.  
  18.                                       by
  19.  
  20.                                   Bob Ransom
  21.  
  22.                               Copyright (c) 1991
  23.                              All Rights Reserved
  24.  
  25.  
  26.           ReadLog - What It Is -
  27.           --------------------
  28.  
  29.           ReadLog is a little utility that takes advantage of a new
  30.           feature in registered versions of RemoteAccess BBS v1.00.
  31.           If you have registered your copy of RA, you'll notice that
  32.           when a user reads messages on your BBS, RA now takes note
  33.           of that in the system log.  ReadLog was designed to use
  34.           those log entries to compile a list of all the message
  35.           areas that are read, how many times they're read, and what
  36.           the percentage of the total is.
  37.  
  38.           "So what?" you ask.  Well, if your system is anything like
  39.           mine, you carry a pile of echomail areas -- of which you
  40.           read very few (I carry something like 50 echoes and have
  41.           time to read 4 or 5 - sometimes.)  Unless you sit and
  42.           stare at your monitor day in and day out, you have no idea
  43.           whether anybody actually reads any of the messages in the
  44.           different messages areas.  That's where ReadLog comes in.
  45.  
  46.  
  47.           ReadLog - How To Use It -
  48.           -----------------------
  49.  
  50.           ReadLog can be run from anyplace on your hard drive(s) and
  51.           requires one command line parameter.  A second command
  52.           line parameter is optional.  Syntax:
  53.  
  54.           READLOG <system log filename> [<-Opus>]
  55.  
  56.           The first parameter is your RA system log name (most often
  57.           RA.LOG).  You may optionally include a full path here or,
  58.           if you use the logfile name only, ReadLog defaults to the
  59.           current director.  No checking of the RA environment
  60.           variable is done.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.           ReadLog v1.00 Docs                                Page 1
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.           The second parameter is "-Opus" (case is unimportant).
  75.           This denotes that you're using Opus-style system logs.
  76.           ReadLog defaults to using FrontDoor-style logs and will do
  77.           so unless it finds "-Opus" as the *second* command line
  78.           parameter.
  79.  
  80.           Here are a couple of working examples:
  81.  
  82.           READLOG ra.log               ;ra.log in current dir and
  83.                                        ;FD logs.
  84.  
  85.           READLOG c:\ra\ra.log -opus   ;ra.log in c:\ra.  Opus logs.
  86.  
  87.  
  88.           ReadLog - What's Written To Disk -
  89.           --------------------------------
  90.  
  91.           When run, ReadLog does it's stuff and shows the results on
  92.           the screen.  It also writes two files to disk:
  93.           READLOG.ASC, a text file suitable for BBS display showing
  94.           the same info as shown on screen, and READLOG.CTL, a
  95.           control file used internally by ReadLog to keep track of
  96.           things as time goes by.  You may want to put READLOG.ASC
  97.           into your BBS textfiles area to be displayed as a bulletin
  98.           on your system.
  99.  
  100.  
  101.           ReadLog - Misc. -
  102.           ---------------
  103.  
  104.           You can run ReadLog on the same log over and over again if
  105.           you wish.  It uses a sort of "last processed" pointer in
  106.           the .CTL file to determine which lines of a log have been
  107.           processed and which haven't.
  108.  
  109.           When a user executes a message Scan or QuickScan (menu
  110.           type 24 or 25), RA puts the same notice in the system log
  111.           as it does when a user actually reads messages.  So
  112.           ReadLog counts these along with any real message reads,
  113.           throwing the totals slightly out of whack.  There's
  114.           nothing that can be done about this until (or if) RA is
  115.           fixed to only say "read" when messages are actually read.
  116.           Besides, I figure the totals will all average out over
  117.           time.
  118.  
  119.           ReadLog will probably become confused if you switch log
  120.           types in mid-stream.  If you do want to switch, I'd
  121.           suggest at least deleting the existing system log before
  122.           running ReadLog again.  It may or may not be a bad idea to
  123.           kill the READLOG.CTL file, too.
  124.  
  125.           ReadLog will also become confused if run it with the wrong
  126.           type of log - i.e. set for FD logs but run on an Opus log,
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.           ReadLog v1.00 Docs                                Page 2
  134.  
  135.  
  136.  
  137.  
  138.  
  139.           and vice versa.  Your results will probably be extremely
  140.           weird.
  141.  
  142.  
  143.           ReadLog - Legal -
  144.           ---------------
  145.  
  146.           Very little to say here except that ReadLog is mine -- I
  147.           wrote it and I own it, but you may use it all you'd like
  148.           for free.  You may copy it and you may give it away, but
  149.           you may not sell it nor change it or its documentation
  150.           (this file).
  151.  
  152.  
  153.           ReadLog - Support -
  154.           -----------------
  155.  
  156.           I doubt there's much call for support given the extreme
  157.           complexity of the program.  <grin>
  158.  
  159.           Seriously, if you have problems with it, please let me
  160.           know.  I'm available via netmail (address below) or
  161.           through the RA_SUPPORT and RA_UTIL echoes.
  162.  
  163.  
  164.  
  165.           Hope you find it useful.
  166.  
  167.           -Bob Ransom
  168.            The Creative Connection BBS
  169.            Southfield, Michigan
  170.            (313) 559-9039
  171.            1:120/96.0
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.