LOGLIST.DOC

11 KB f5f33e8abf9ad616…
_________________________________________________________________________

                   LogList Program for QuickBBS
               Copyright (c) 1990 by Russell Taylor

                           P.O. Box 355
                        Oakridge, OR 97463

                BBS - Out In The Styx (1:152/20)
                      503-782-2209
                      2400/1200/300

                FAX - 503-782-4718

           Net Mail - LogList Headquarters (1:152/20.1)
_________________________________________________________________________

This program is designed so that you and other users of your QuickBBS
system can view the Log File in a variety of ways. 

This program is released as cheap GuiltWare. I display a message 
making you guilty (supposedly) when the program is unregistered.
You may freely distribute it as long as there is no fee or charge involved.
Please include this documentation file along with the program.

The only effect being unregistered has on the program is the message
"Unregistered" appearing on the screen while the program scans the log file.
If you like this program and would like to register it, send me $10
and I will tell you how to get rid of this message.  Be sure to include
the name of your BBS (exact spelling), a complete mailing address, and
your board's phone number.
If you send me $15, I'll automatically send you a free update disk of
the next major release of LogList (and will include LogInfo and LogUtil).

I realize that everybody wants something for their programs and it is
not possible to register everything; so if you really can't afford it,
drop me a line stating so, and I'll give you a registration number
to register your copy.  (Please include return postage.)
Anyone who can afford to run a BBS can surely afford a postcard to say
a few words of thanks, even if they can't afford the asking price.



==============================================================================
I. Command Line Options
==============================================================================
The following section describes how to control loglist. Each option listed
below can be placed on the command line to the program. In addition, you
can set a DOS environment variable (named "LOGLIST") to equal a string
listing any commands you want.
Generally, you should set the environment variable to equal those commands
that you always want to be true. For example, if you always wanted to
view the log in the Forward Direction using ANSI, you could enter:
         SET LOGLIST=-DF -A1
Note that the command line will OVERRIDE any environment variable setting.
Using the above example, if you entered:
         LOGLIST -DR
The log would be displayed in the REVERSED direction despite the setting
in the environment variable.

Some commands are overidden by values set in EXITINFO.BBS.
Where this is true, it is noted below.


 Option     Description
-----------------------------------------------------------------------------
<logname>   The name of the system log file. This is only needed if you
            have set the QuickBBS log file to some wierd name or disk.
            If you don't put in the name, the program looks for the
            SYSTEM.LOG file in the following order:
                1) If the QUICKBBS environment variable is set, it will
                   check the path you have set there.
                2) In the current directory.
                3) In the directory "\QUICKBBS\"
                4) In the directory "\QBBS\"
            If it can't find it anywhere, it aborts with an error and you
            must run the program again this time passing it the path and
            name of the log file.

COM<port>   Specifies the serial port to output the data.
            COM port 1 or 2 is allowed (i.e. "COM1" or "COM2").
            Note: If EXITINFO.BBS is present, Loglist will check to see if
                  BaudRate = 0 (for local echo), and ignore any COM option.

 -U<name>   User Select. Specifies a particular person to scan for
            in the log list. For example: -USTYX
            This would only display those entries having the name "STYX"
            in them. Case is ignored. Use the underline character to
            represent spaces.  (i.e. _Russell_Taylor_)
            Note that I included leading and trailing underlines.
            this insures against the unlikely occurance of finding a
            "name within a name".  An example:

                  -UMARY_SMITH
            would also display entries for ROSEMARY SMITHERS.
                                               ^^^^^^^^^^
                  -U_MARY_SMITH_
            would only display exact matches, as there will always be a
            space before and after the name as it is found in SYSTEM.LOG.

            
            Since the program scans the first line of each log entry, you
            can also use this option to detect all users who log on at
            a particular baud rate. For example; "-U2400" would display
            all users who have logged on at 2400 baud.

 -CU        Current User. Selects a certain user (like above) but gets
            the name from EXITINFO.BBS.

 -HT        Hides the Time from the display.
 -HD        Hides the Date from the display.
 -HS        Hides Security Level Line.
 -HP        Hides Invalid Passwords (not line, just the attempted password).
 -HX        Hides DOS System Shell Lines.

 -A0        ANSI Graphics Disabled (default).
 -A1        ANSI Graphics Enabled.
            If enabled, this can optionally be followed by a list of color
            codes representing the colors you want for each part of the log
            list. The color codes are defined as follows:
                      0 = Black        8 = Gray
                      1 = Red          9 = Lt Red
                      2 = Green       10 = Lt Green
                      3 = Brown       11 = Yellow
                      4 = Blue        12 = Lt Blue
                      5 = Magenta     13 = Lt Magenta
                      6 = Cyan        14 = Lt Cyan
                      7 = White       15 = Lt White
            When entering in the colors, specify them in the following order:
                 Background (default = BLACK      )
                 Title      (default = LIGHT RED  )
                 Date       (default = GREEN      )
                 Time       (default = BROWN      )
                 Name       (default = LIGHT CYAN )
                 General    (default = LIGHT WHITE)
                 Baud Rate  (default = YELLOW     )
            Separate each value with a comma. You can enter only the first
            few values, or all of the values.
            For example: -A1,2,4,4,4,4,4,4   (ANSI On, Background = Green,
                                              everything else is blue!).
            Note: If EXITINFO.BBS is present, the particular user's ANSI bit
            will set this mode regardless of what you put on the command
            line. You still can set the colors, however.

  -S0       Entry spacing OFF (no gap between entries).
  -S1       Entry spacing ON  (1 line between entries).

  -D        Show entries for today's date only.
  -D?       Ask for date to show (defaults to today's list)
  -D??      Ask for date to show and number of days from (today, last 7 days)
            Number of days can be a +/- number.
  -D?,?     Ask for start and end date to show.
  -D<x>     Show from today back <x> days (<x> must be a minus!).
  -D<dt>    Show a particular date.
  -D<dt>,x  Show a particular date and +/- that number of days from it.
  -D<s>,<e> Show date range where <s> = start date and <e> = ending date.
            NOTE: All date options default to displaying data in a forward
                  direction (see below to overide).

  -DF       Show in Forward Direction (overides default).
  -DR       Show in Reverse Direction (overides default).

  -QS       Enable Quick Scan (Shows names and baud rates only).

  -P0       Disable Pause at end of list.
  -P1       Enable Pause at end of list (default selection).
  -P<x>     (x > 1) Enable pause at end of list and pause every "x" lines.
  -PE       Pause after each entry (Not valid under -QS option).

Note: In any command shown with a parameter surrounded by "<>" do not
      put "<>" on the command line. For example, to pause every 20 lines
      you would put a "-P20" on the command line NOT "-P<20>".


===========================================================================
II. Keyboard controls:
===========================================================================
 SPACE  Hitting space anytime during the log display pauses the 
        program. Press it or any other key to resume display. 

  ESC   The escape key aborts the program at any time.

In addition, Control-S and Control-Q also work to pause/resume the program.

===========================================================================
III. Other Features:
===========================================================================

Loglist automatically displays the following information at the end
of displaying the data that matches your above settings:

    # Of occurances (total entries).
    Total Time Used (sum of on-line time for all entries displayed)

Loglist scans EXITINFO.BBS (if it exists) for the following information:

    BAUD RATE  - If zero, LogList ignores any COM numbers you give on
                 the command line. This prevents an error message when
                 testing from the LOCAL mode.
    ANSI       - Disables/Enables ANSI (overides command line).
    SCREEN CLR - Disables/Enables Clearing of the screen.


===========================================================================
IV. Revision History:
===========================================================================

Version   Date    Explanation
---------------------------------------------------------------------------
 1.00   01/31/90  Initial release of LogList.
 1.01   02/14/90  *Added -CU, -HT, -HD, -HS, -HX, and -HP options.
                  *Added support for defining options with an
                  environment variable LOGLIST=<options>.

===========================================================================
V. In the Future:
===========================================================================

I have been thinking of writing two more programs named LogUtil and 
LogInfo which would manage the logfile and display comprehensive 
information about it. If you have any ideas for programs or other
utilities, I would appreciate hearing from you.  I may be reached via
any of the methods outlined at the top of this listing.
Thanks for your support.  -Russell Taylor

     ****************************************************
     * To obtain the latest program update via NetMail: *
     *           FREQ LOGLIST from 1:152/20             *
     ****************************************************