
                            RVAlf VERSION 1.01

                     THE WILDCAT ALLFILES LIST CREATOR

                           WRITTEN BY P. DINGLEY

 COPYRIGHT (C) ALL RIGHTS RESERVED P. DINGLEY AND RIVENDELL BBS (UK) 1995-1997

 The latest version of this program can be downloaded from Rivendell BBS.
-----------------------------------------------------------------------------
License and Disclaimer
----------------------

     "RvAlf" refers to all executables and documentation as distributed
     in the compressed file in which the program was released.

     * All mentioned program names or trademarks are the properties of the
       respective owner(s).

     * RvAlf is copyrighted by Paul Dingley.
       It may only be used in agreement with the conditions pointed out in 
       this license agreement.

     * RvAlf is released as shareware.
       You may use RvAlf for an evaluation period of thirty (30) days.
       After this period you must either register RvAlf or stop using it.

     * Registration is required for any use in a commercial environment.

     * RvAlf may be distributed freely in the original package provided
       no money or any other compensation is asked or accepted without prior
       written permission from Paul Dingley.

     * RvAlf is provided as is, without warranty or guarantee of any kind,
       the only warranty I can give is that RvAlf will use disk space.

     * In no event shall I Paul Dingley be liable to you or anyone
       else for any damages, cost or lost income which may be the result from 
       the use or inability to use RvAlf.

     * In no way is Paul Dingley obligated to you or anyone else to provide
       future versions of or support for RvAlf

     * Registered users are registered for this release and all future
       releases of RvAlf

-----------------------------------------------------------------------------
INTRODUCTION

    RvAlf was written to allow me to create an allfiles list for my own BBS
    as part of an overnight system event.  It was made configurable so that
    I wouldn't have to rewrite the code each time I wanted a slightly
    different output format.

    Some of RvAlf's features include:

    - Creates an allfiles list for all file areas on your BBS.
    - CD areas can be included or excluded en-masse.
    - Individual file areas can be excluded.
    - Individual file types can be excluded (ie FILES.BBS).
    - Optionally creates a bulletin listing file area utilisation.
    - Optionally posts the resulting list(s) into the Wildcat file database.
    - Fully configurable output format.


-----------------------------------------------------------------------------
INSTALLATION

 1. Place the following files into either the main Wildcat 5/WINS directory
    or into a directory called 'RVALF' below the main Wildcat directory.

    RVALF.WCX

 2. Assuming that you have Wildcat installed in the default C:\WC5 directory,
    place the following files into the C:\WC5\RVALF directory.

    RVALF.CFG
    nnnn.HDR

    If you have Wildcat installed in a different directory, or on a different
    drive, replace C:\WC5 with the structure that points to your Wildcat home
    directory.
   
    If this directory is network-sharable all nodes that will be used to 
    execute the program must have Read/Write/Create/Delete/Execute access 
    to this directory.

 3. Edit the RVALF.CFG file to reflect your own BBS configuration.
    Each configuration item is preceeded by a keyword.  Semicolon characters
    are comments.  The keywords are described later in this document:


 4. Edit or create the nnnn.HDR files.  These are the area Header files
    that will be included with the finished output to provide additional
    information about specific file areas.

-----------------------------------------------------------------------------
OPERATION

    Operation couldn't be simpler, since the program can be run via one
    of two methods.

    Initially I'd recommend that it's run manually by creating a menu
    option available only to the SysOp, which is used to run RvAlf.

    Key   R
    Desc  R...........RvAlf
    Type  Run WcCode Program
    Name  E:\WC5\RVALF.WCX     <- Change this to point to your path.

    The second option, once you are happy with it's operation is to run it
    as a scheduled event, either within Wildcat, or from the front-end mailer.

    If using the Front-End mailer option, setup a daily event which exits with
    an errorlevel, then in the controlling batch file trap the errorlevel,
    and execute the following command to run RvAlf.

    E:\WC5\WcRun -r E:\WC5\RVALF

    It can also be run from the command line, and the required configuration file
    specified on the command line, for environment where several different lists
    are created for different purposes:

    E:\WC5\WcRun -r E:\WC5\RVALF /C:E:\WC5\RVALF\CD-ONE.CFG


    RvAlf will compile a list of all files in each area, providing that neither
    the area, nor files within the area meet any of the exclude criteria.

-----------------------------------------------------------------------------
LIMITATIONS

    This EVALUATION version contains a startup delay, and has the 'Un-Registered
    banner stamed into the output files.
    The registered version is fully configurable and not limited in this way.
-----------------------------------------------------------------------------
REGISTRATION
------------

    If you find RvAlf useful, and/or wish to continue using it after the
    initial 30-day evaluation period, I ask you to please show some
    consideration for the time and effort I've put into the program by
    registering it.

    To Register RvAlf, complete the registration form below, and send it
    along with a cheque, bankers draft, money order, or Postal Order for the
    sum of 10.00 Sterling, or $15.00 USD made payable to 'Paul Dingley' to
    the address below:

    Mr Paul Dingley.
    RvAlf Registration
    20 Homewood Drive,
    Kirkby-In-Ashfield
    Nottingham
    NG17 8QB
    England.

-----------------------------------------------------------------------------
REGISTRATION FORM
-----------------

    Your Personal Details

    First Name        : _____________________________________________

    Last Name         : _____________________________________________

    Sex               : [Male / Female]

    Business Name     : _____________________________________________

    Email Address     : _____________________________________________

    Fidonet Netmail   : _____________________________________________

    Please include the full name below as you want it to appear on any
    registration information messages:

    Registered To     : _____________________________________________

    Your Postal Address Details

    Street Line 1     : _____________________________________________

    Street Line 2     : _____________________________________________

    Town              : _____________________________________________

    City              : _____________________________________________

    County / State    : _____________________________________________

    Postal / ZIP Code : _____________________________________________

    Country           : _____________________________________________

    Voice Phone Number: _____________________________________________

    Data Phone Number : _____________________________________________

    Registration Costs:  Personal or Non Commercial Use
                         1 License : 10.00 GBP or $15.00 USD

                         Business or Commercial Use
                         1 License : 10.00 GBP or $15.00 USD

    Your personalised registration key will be generated when this completed
    form is received along with payment.  The Key will be a case-sensitive
    string of alphanumeric characters, which will be shipped as a file along
    with your registered name.
    
    How do you wish to receive your key ?

    [ ] Sent to the above Fidonet address via Netmail.
    [ ] Sent to the above Internet Email address.
    [ ] Sent on disk via SnailMail to the above address.

    Please complete this form, and send it with the appropriate payment to:

    Mr Paul Dingley.
    RvAlf Registration
    20 Homewood Drive,
    Kirkby-In-Ashfield
    Nottingham
    NG17 8QB
    England.


-----------------------------------------------------------------------------
CONFIGURATION FILE KEYWORDS
---------------------------

    The following configuration verbs can appear anywhere within the configuration
    file.  Note that any line preceeded by a semi-colon (;) is considered to be a
    comment line and is hence ignored.

    ; - Comment
    Used to indicate that the line contains a comment, or some other statement that
    must not be acted upon by RvAlf.

    OUTPUTFILEPATH = C:\
    Used to point to a temporary area which will be used during the creation of the
    output files.  This directory can be any directory that can be written to by 
    the computer, but it *MUST* contain a trailing back-slash, and it *MUST NOT*
    be the same as the directory of the Wildcat file area to which the final output
    file(s) will optionally be added.

    OUTPUTFILENAME = 2503221.LST
    This is the name of the file that will be created by RvAlf.  It *MUST NOT*
    include any path information, and should be a valid legal filename.

    CREATEARCHIVEDRESULT = YES | NO
    This is a Yes/No setting.  If set to YES, RvAlf will create a .ZIP file 
    containing the output file list once processing has completed.
    NOTE:  PkZIP *MUST* be available on the DOS Search path, and it's Win95/NT 
           properties must be set to 'Close on Exit'.
    
    ADDTOWCFILEAREA = 2
    This will force RvAlf to add the resulting allfiles listing to the Wildcat files
    database in the specified area.  If a .ZIP archived file has been created by
    RvAlf, the .ZIP file will also be added to this file area.

    PROCESSCDAREAS = YES | NO
    This is another Yes/No setting.  If set to 'No' RvAlf will honour the 'No New Files'
    tag in WcConfig/File Area, and will not report for any file area with the tag enabled.
    If set to 'YES' it will override the No New Files setting, and will report all files
    in the area.

    CREATESUMMARYINFO = YES | NO
    Another Yes/No setting.
    If set to 'YES' RvAlf will include a summary of the file area utilisation at the end 
    of the allfiles list.  If set to 'NO' the summary report will be omitted.

    SUMMARYBULLETINFILENAME = Full path and filename.
    This setting will force RvAlf to create a nice colourful summary bulletin of the
    file database area utilisation, listing number of files, space used, and number of
    downloads for each file area.  If the setting is omitted or commented out, no such
    bulletin will be created.

    COUNTFILESPERAREA = YES | NO
    A Yes/No flag which governs whether RvAlf will list the number of files in each area.

    FILESIZEPERAREA = YES | NO
    A Yes/No flag which governs whether T=RvAlf will list the capacity of each area.

    DATAFORMAT = {%A %F %Sb %DT %SK %DL %DS %UL} or {%2D} or {%FD}
    Dataformat is used to completely customise the information written to the allfiles
    list for each file.
    Briefly it's settings mean:
         - %A  - Display File Area number
         - %F  - Display File name
         - %Sb - Display File Size in bytes
         - %SK - Display File Size in K
         - %DL - Display Download Counters
         - %DS - Display Short Description
         - %UL - Display name of Uploader
         - %DT - Display File Date
         - %2D - Display file description on second line    (*)
         - %FD - Full file description display mode         (*)

    Using the Dataformat command, along with a combination of the above macros, the
    information written to the output files list can be completely customised.
    NOTE that the two macros marked by the asterisk (*) character, are standalone,
         and should *NOT* be used in conjunction with any of the other macros.

    DOWNLOADOPENCHAR  = [
    DOWNLOADCLOSECHAR = ]
    The Downloadopenchar and Downloadclosechar commands are used to change the characters
    that surround the download counters in the output files.

    REPLACEMISSINGDESC = [File Description Not Yet Available]
    Used to replace any missing descriptions with a configurable message.

    EXCLUDEAREA = 1
    Using the ExcludeArea command, it is possible to individually exclude selected areas
    from all final reports, including bulletins.  Typically this is useful to hide the
    main system upload directories, or any private areas from prying eyes.  Any number
    of areas can be excluded, however only one area may be listed per line.

    EXCLUDEFILE = FILES.BBS
    Lists individual file-names that should be excluded from the output file lists.
    Up to 20 individual filenames can be excluded.  Wildcards are *NOT* supported.
    Note that the use of this option *WILL* slow down processing.

    REGISTERED_TO = Paul Dingley
    Name of the user to whom the program is licensed.  This name will appear on the
    system reports if a valid registration key is found.

    REGISTRATION_KEY = 0000000000
    The registration key issued upon registration of RvAlf.

    HEADERPATH = E:\WC5\RVALF\
    The headerpath command contains the path to the nnnn.HDR files.
    These files are appended into the file lists immediately after the file area banner
    and before the files themselves are listed, for each file area.
    Typically this may be used to insert an advertising message for the area to follow,
    or a disclaimer about files in a specific area, etc.
    Files of the format nnnn.HDR will be automatically inserted, where nnnn id the file 
    area number.

-----------------------------------------------------------------------------
HISTORY
-------

V1.00 - First Release Version

V1.01 - Bugfix release.
        - V1.00 incorrectly reported the contents of empty file areas,
          sometimes listing the last file located in the previous area.
          This is now fixed.

      
-----------------------------------------------------------------------------
THE FUTURE
----------

    A number of enhancements are planned to RvAlf for the future, including
    amongst other things more customisable options, and version 2.0 is already
    under development.  I reserve the right to alter the licensing price of
    any future versions of RvAlf, however future versions will be free to
    all registered users.


