QBFBSTAT.DOC

11.7 KB 55ee543f1a85fb19…
------------------------------------------------------------------------------
                              QBFBStat v1.0

          QuickBBS File Areas Statistics Bulletin Generator

                 Copyright (C) 1990-91  Foxtrot Software
                           All Rights Reserved.

  This is a shareware program, this program is not to be sold or modified
in any way.  You are free to copy and distribute QBFBStat as long as:

  a.  No fee is charged for use of the program or the documentation.
      A fee may be charged for copying or distibution of this software
      and documentation for others not to exceed US$ 10.00.

  b.  It is not modified in any way.

  c.  You distribute this software along with all documentation and
      registration forms unmodified.


  The Author hereby disclaims all warranties relating to this software,
whether expressed or implied, including without limitation any implied
warranties of merchantability or fitness for a particular purpose.  The
author will not be liable for any special, incidental, consequenctial,
indirect or simular damages due to loss of data or any other reason.  The
user of this software bears all risk as to the quality  and performance
of this software.

-------------------Now that we have that out of the way-----------------------

  If you have any comments or suggestions for improvement of this software,
you can contact me at Info-Center BBS, data: (914 )567-1814, 24 hours a
day or leave Net-Mail @FIDO NET 1:272/26, @MagNet 100:900/39.

  If you like this software, and decide to keep it on your system and
to use it, then you must register it.  You are entitled to use QBFBStat
for a trial period of 30 days.   QBFBSTat Registration fee is US$8.00. 
New York residents please add 6.5% sales tax to the registration fee.

  When registered, you will receive an QBFBStat key for your system.
The KEY you receive will enable the -F option to allow multiple
bulletins to be created.

                       Thank you for your support!

------------------------------------------------------------------------------

1. Introduction.

   QBFBStat is a utility that will allow the Sysop of a QuickBBS BBS
   to produce a Files Area Statistic Report that features the following:

   a.  Total files in all selected areas.
   b.  Total bytes in all selected areas.
   c.  Total files for each area selected.
   d.  Total bytes for each area selected.
   e.  Percentage of the total files that each area contains.
   f.  Ascii and Ansi Bulletins.
   g.  Multiple bulletins.
   h.  Full File Area Security Level/Security Flag Checking.


   QBFBStat uses the environment variable QUICK to find the system files
for your QuickBBS BBS system.  If you don't have this variable set then 
QBFBStat will try to find the FILECFG.DAT, QUICKCFG.DAT files in the current 
directory.   Selected areas are determined by using Security and Flags settings
configured in the QBFBSTAT.CTL file.  The Security and Flags used are the
same as that are used in FILECFG.DAT.  Areas that don't match the criteria
specified will not be processed.

   QBFBStat allows you to create multiple bulletins by specifying the
-F option at startup.  You can have a different QBFBSTAT.CTL file
that may contain different file area specifications.


2.  Files needed by QBFBStat:

       INPUT:

         QUICKCFG.DAT   -   QuickBBS BBS Configuration File.
         FILECFG.DAT    -   File Areas Configuration.
         QBFBSTAT.CTL   -  Control file for QBFBSTAT.  Or any .CTL file
                           that is defined on the command line when executed.

       OUTPUT:

         BULLETIN.ANS
         BULLETIN.ASC -  A bulletin file that you will specify in
                         QBFBSTAT.CTL file.  Actually two files will
                         be created as output.  One is a plain ascii
                         file, the other will contain ansi screen
                         commands for color.  When specifying the
                         filenames, DO NOT append .ASC or .ANS.
                         QBFBSTAT will append an extension for you.

        

    3.  An Editor that will create text files, such as EDLIN, GALAXY,
        or any Editor that will allow CR/LF combinations at the end of each
        line has to be used.  Create the QBFBStat.Ctl file in your QuickBBS
        System directory with the following information:



        b.  The QBFBSTAT.CTL File:

        The QBFBStat.CTL file uses KEYWORDS to control how your File
        Areas Statistics are to be created.  The KEYWORDS require also
        one or more arguments to be used with it.  The KEYWORDS may
        appear in upper or lower case or mixed.

        1)  PATH    -  This KEYWORD is used to define the path and
                       bulletin name you want to create.

             Example:
                PATH C:\QuickBBS\TXTFILES\FILESTAT

        2)  TITLE   -  This Keyword is used to define the title you
                       wish to have in the bulletin.  Maximum length
                       for the title is 70 characters.

             Example:
                TITLE Anyname BBS - Anytown, USA

        3)   COLOR0  - The color you want the top and bottom lines of the
                       bulletin to be.

        4)   COLOR1  - The color you want the title to be.

        5)   COLOR2  - The color you want the Last update statement to be.
 
        6)   COLOR3  - The color you want the last update DATE to be.

        7)   COLOR4  - The color you want the file areas summary 
                       statement to be.

        8)   COLOR5  - The color you want the file areas summary
                       DATA to be.

        9)   COLOR6 -  The color you want the File Areas, Files, Bytes,
                       Percent heading to be.

        10)  COLOR7 -  The color you want the Area Names to be.

        11)  COLOR8 -  The color you want the File Area total files
                       column to be.

        12)  COLOR9 -  The color you want the total bytes column of each
                       File Area to be.

        13)  COLOR10 - The color you want the File Areas Percent column
                       to be.

        14)  BACKGROUND - The color you want the background of the
                          bulletin to be.

             Example:

               Color0  15
               Color1  14
               Color2  14
               Color3  2
               Color4  15
               Color5  2
               Color6  10
               Color7  14
               Color8  10
               Color9  5
               Color10 13
               Background 0

        
        15)  DOWNLOADSEC  - Use this KEYWORD if you want the DOWNLOAD
                            SECURITY level to be checked for each file
                            area.  If this KEYWORD is ommitted, then
                            the download security level will not be
                            checked.  Maximum download security level
                            is 64000.

             Example:
                DownloadSec 5

        16)  SEARCHSEC    - Use this KEYWORD if you want the SEARCH
                            SECURITY level to be checked for each file
                            area.  If this KEYWORD is ommitted, then
                            the list security level will not be checked.
                            Maximum Search security level is 64000.

             Example:
                SearchSec 5

        17)  TEMPLATESEC  - Use this KEYWORD if you want the TEMPLATE
                            SECURITY level to be checked for each file
                            area.  If this KEYWORD is ommitted, then
                            the template security level will not be 
                            checked.  Maximum template security level is
                            64000.

             Example:
                TemplateSec 5


        Note:  The follwing flags correspond to the A,B,C,D flag settings
               that you have set in each File Area.

        18)  DOWNLOADSECFLAGS  - Use this KEYWORD if you want the DOWNLOAD
                                 SECURITY flags to be checked for each
                                 file area.  If this keyword is ommitted,
                                 the the download security flags will not
                                 be checked.

             Example:
                DownloadSecFlags X------- X------- X------- X-------


        19)  SEARCHSECFLAGS   -  Use this KEYWORD if you want the SEARCH
                                 SECURITY flags to be checked for each
                                 file area.  If this keyword is ommitted,
                                 the search security flags will not be
                                 checked.

             Example:
                SearchSecFlags X------- X------- X------- X-------           

        20)  TEMPLATESECFLAGS -  Use this KEYWORD if you want the TEMPLATE
                                 SECURITY flags to be checked for each
                                 file area.  If this keyword is ommitted,
                                 the template security flags will not be
                                 checked.

             Example:
                TemplateSecFlags X------- X------ X------ X------


        21)  FILESPECS  - Use this KEYWORD to tell QBFBSTAT what files
                          to include in the bulletin.  Up to 30 FileSpec
                          arguments mat be given.

             Example:
                FileSpecs *.ZIP *.ARC NODEDIFF.A??
                

    c.  How to run QBFBStat:

        1) Usage:  QBFBStat [-?] [<-F Path>]

            -F Path   - Using this argument will allow you to specify
                        a different path for the .CTL file other than
                        the default QBFBSTAT.CTL.  This option is only
                        available to registered copies of QBFBStat.


            QBFBStat.Exe need not exist in the QuickBBS System directory to
            generate the bulletin(s).   The -F option allows you to
            execute QBFBStat from anywhere on your system.  By default
            QBFBStat will search the currently accessed directory for
            the QBFBStat.CTL file.  

    -----------------------------*-----------------------------

6.  Problem(s) History:

     11/29/91 - First Release.
     v1.0

     ----------------------------*-----------------------------

Other Quality Software Products from Foxtrot Software are:

Magic name    Description

RaTop         Top Users bulletin maker for RemoteAccess 1.1.

QuikTop       Top Users bulletin maker for QuickBBS 2.75+            
                   
OpusTop       Top Users bulletin maker for OPUS CBCS 1.1x.

RaFbStat      File Area Statistics bulletin generator for QuickBBS 2.75+

Coming Soon:

    Magic name

    SuperTop     - Top Users bulletin maker for SuperBBS bulletin boards.
    
    
PROBLEMS:

   Please notify me immediately if you have any problems or
suggestions about this program.  Enhancements are being incorporated
all the time and your input is more vital to this process than you
think.  You may write me, send Net-Mail or logon at the following address:

For Registration or reports:

Foxtrot Software        
c/o Byron Copeland                   Info-Center BBS
11 Y Street                          (914) 567-1814 @Fidonet 1:272/26
New Windsor, Ny.                     24 hours a day!
12553



                  Enjoy and thank you for your support!


                               - End -