****************************************************************************
*                                                                          *
*                   LogBook V1.6  By Bryce! and Ted 1991                   *
*                                                                          *
*                     Last Callers util for AmiExpress                     *
*                                                                          *
****************************************************************************
                                                                  1990-10-17
                    User's Manual for the LogBook utility.


1. Introduction

   Did you ever get tired of the look of the regular Last Callers utils?
   Or did you get tired of that they always takes longer to execute, the
   longer the UDLog file gets. Or have you wanted something more then
   just the persons name and location to be written on the Last Callers
   list. Or are you one of those guys, like myself, who have had problems
   running existing utils under KickStart 2.0 and/or with a 68030 CPU?
   Or have you just switched to the new AmiExpress Version, and have
   not found a util that still works with the new Callerslog format?
   Then I can guarantee that you'll be saticfied the the LogBook util.
   The LogBook util won't take longer to execute even if the UDLog file
   is hundreds of KiloBytes long. And it'll write not only the name and
   location of the caller, it'll write the time he was on, what speed
   he logged on with. It will also write down exactly how many uploads
   and downloads each user did. And of course it will also write total
   amount of calls today, and total amount of calls yesterday. Ok, that's
   all for what introduction concerns. So, let's get down to business.

   Features of LogBook:

   * Shows 10 Last Callers. (Name and Location)
   * Shows each users exact time of logon.
   * Shows exacly how many uploads and downloads each user on
     the list did. (Useful for a fast scan of file activity)
   * Informs you on how many calls have been recieved today and yesterday.
   * Displays the Sysops name.
   * Ability to include a textfile of any choice infront of the list.
   * Ability to put a randomly selected one-line comment in the list.
     (New one-liner selected each time the util is executed)
   * Posibility for the sysop to specify how many last callers that are
     to be displayed.
   * Shows number of uploads today, and yesterday.
   * All versions are tested on well know boards before release, to
     prevent all bugs.
   * All versions are fully compatible with all amiga models and OS's.
     (See below for a full description on the hardware and software
     setups used when testing this product)
   * Writes useful data to Environment Variables, for use with other
     tasks and utils.


   News in this Version:

   The only news in this version is that LogBook now writes 5
   Environment Variables to ENV:. You must therefor assign Env:
   somewhere. Preferably to ram:env. The name of the variables
   are:

   LastCaller
   CallsToday
   CallsYesterday
   UploadsToday
   UploadsYesterday

   If you are to use this function with the new ULog1.8, which has the
   ability to import these variables, make sure you execute LogBook
   before ULog.

   2. How to get started

   (Please note that the file UDLog is changed to Callerslog in the
   new version of AmiExpress, and is therefor also changed in the
   matching version of LogBook, thus version 1.5. So, if you use
   the new versions of both programs, please replace UDLog with
   Callerslog, at all places. If you on the other hand have the
   older version of AmiExpress, you must use the older version
   of LogBook, called LogBook 1.1, for maximum thruput.)

   The usage if the LogBook util looks like this:

   LogBook [Log] [-g/-n] [Include/-n] [OutPut] [OLFile/-n] [Dir/-n] {NumCall}

   The 'Log' argument is the complete path and filename for your Callerslog
   file. (Usually BBS:Node0/Callerslog). The -g/-n argument is for whether
   you want ANSI graphics or not. Select -g for ANSI, and -n for NO ANSI.
   The 'Include' file is a textfile that can be included before the actual
   last callers list. And the 'OutPut' file argument is, of course, where
   you want the last callers list to go. (Usually BBS:Elite/Bull20.txt).
   The OutPutFile can also be specified as a '*' and you will get the
   result printed onto the CLI/Shell window that it was started from.

   Ok, let's try an example: Let's say your Callerslog file is in the
   Node0 directory, which in its turn is in the BBS directory. You would
   like to have ANSI graphics, and you have previously created an Include-
   file which exists in the S: directory, and is called 'HEAD'. Your
   OutPutFile is set to BBS:Elite/Bull20.txt. The commandline would
   then look like this:

   LogBook BBS:Node0/Callerslog -g S:Head BBS:Elite/Bull20.txt -n -n

   If you, on the other hand, would like to run a simpler version of
   of the LogBook util, the commandline could look something like this:

   LogBook BBS:Node0/Callerslog -n -n BBS:Elite/Bull20.txt -n -n

   As you can see this would result in an outputfile with no ANSI, and
   no IncludeFile.

   Now, let's have a look on the OLFile feature. The purpose of this
   function is to let you write a textfile with small comments that
   will be put out in the last callers list. The textfile should be
   a regular textfile without any special characters, and cantain
   short comments or quotes written on each line. Each line can't be
   longer than the AmiExpress screen is wide, which means approximatly
   76 characters, and there should be no empty lines. You then simply
   give the name of this file to the LogBook util, and it will figure
   out how many lines it's got to choose from, by itself, and then
   randomly select one of them, and put it out in the actual list.
   Now, here's how to write: Let's use the info from the first
   example, and let's say that your One-line-commentfile is in the
   S: dirctory and is called "OLFile". Also, let's say that you also
   want to check out how many uploads there's been today and yesterday,
   and your path to the uploads Dir is like this: "BBS:Elite/Dir3".
   Then this would be the way way to execute it:

   LogBook BBS:Node0/Callerslog -g s:Head BBS:Elite/Bull20.txt S:OLFile 
   BBS:Elite/Dir3

   NumCall option:

   This is a number, from 1 and up, that you can write to specify that
   number of last callers that are to be shown in the last callers list.
   If no number is specified, LogBook will use the default of 10.
   Here's an example:

   LogBook BBS:Node0/Callerslog -g s:Head BBS:Elite/Bull20.txt S:OLFile 
   BBS:Elite/Dir3 15

3. Hints

   Not much to tell... Like in my other utils you have the option of 
   specifying the name of the main file, which in this case is the UDLog/
   Callerslog file, so that you can copy it to RAM: first and executing
   it from there. This will however have little effect on the LogBook
   util, since it was designed to load as the parts of the UDLog file
   that it need into ram first anyway. But, maybe you can win a few 
   microseconds by copying it to RAM:. 

   You must, of course, execute this util after every logoff, or there
   would be no meaning of having a Last Callers util.


4. Versions

   In this release I have included only one version of my util:

   LogBook1.5      - For the latest AmiExpress.

   I guess everybody have changed to the latest version of AmiExpress,
   so I guess you can consider the earlier versions of LogBook
   discontinued.

5. Aftertouch

   First of all I want to thank a couple of people:

   BamBam           - Let get the conference going!
   Ted/Defjam       - Thanx for all the debugging help!
   SpaZm/Fairlight  - A source of inspiration!
   Mogwai/Defjam    - How's that new BBS program comming?
   The Baron/Defjam - Hope you'll be able to take some time off soon.
   Jereon           - Nice to see that people still program!

   And then for some greetings: (in NO order at all)

   Prisoner of Wife, Bigfoot, In Decent, Cydric, Jabbah, Zin, BamBam,
   Damage, Porta, Capricorn, Strider, Conqueror, Jetaza, Judge Dredd,
   Raistlin, Winter Mute, Black Shadow, Blaizer, Irata, Spike,
   Highlander, Archangel, Zcandaler, Splatt, Mr.Trax, The UnderTaker...

   (Sorry, if I've forgotten someone.)

   And of course to all HORIZON members!


6. Credits and other Information

   Programmed in Manx Aztec 'C' for reliable and system-friendly code.

   Programming:            Bryce! - Horizon
   Additional Programming: Ted - Defjam

   This util has been tested, and works 100% on: KickStart 1.2, 1.3, 2.0.
   It has also been tested on various RAM set-ups, such as; 1 Mb chip, 
   0.5 Mb chip, 0.5 Mb chip & 0.5 Mb fast, 0.5 Mb chip & 4 Mb fast, 1 Mb 
   chip and 2 Mb fast, 1 Mb chip & 1 Mb fast, 2 Mb chip & 4 Mb 32 bit fast,
   and this worked 100%. Processors tested with this util includes: 68000 
   7.14 Mhz, 68030 25 MHz, and 68882 25 MHz, and no problems occured with 
   this either.

   You can reach me (Bryce!), or check out my utils at my beta-testers:

   The MainFrame   - Horizon EHQ   - +46-303-67301
   DownTown        - Classic HQ    - +31-575029313
   Marityrium      - Classic USHQ  -  713-666-4093
   The Graveyard   - Agile UKHQ    - +44-915160560
   West BBS        - Defjam SHQ    - +46-31-311879
   Total Eclipse   - Aurora HQ     - +46-31-572545

   Or try these util-making friends of mine's boards:

   Streets of Fire - Defjam SHQ    - +46-755-61537
   Spaztic BBS     - Fairlight PHQ -  407-639-9123

   Ok, I think that's just about it, I guess... So, I'll just let you
   carry on with installing this great util, and say goodbye. See you
   in the next production.

                                 ...Bryce! '91
