home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / QUTIL100.ZIP / Q_UTIL.DOC < prev    next >
Text File  |  1991-06-05  |  9KB  |  224 lines
  1.  
  2.                 ┌────────────────────────────────────────┐
  3.                 │  Q_UTIL A RA/QBBS-messagebase utility  │
  4.                 │                                        │
  5.                 └────────────────────────────────────────┘
  6.                  Version 1.00  Public release 3 June 1991
  7.  
  8.      Written and (C) 1991 by Fons Cornelissens, @FidoNet 2:295/43.4302
  9.  
  10.  
  11. INTRO
  12.  
  13.     Q_UTIL is a utility designed to show you an overview of your RA/QBBS
  14.     (MSG*.BBS) message base.
  15.     Multiple command-line options make it possible to specify the exact
  16.     info you want to be displayed on the screen.
  17.  
  18.  
  19. REQUIREMENTS
  20.  
  21.     - An IBM PC compatible computer
  22.     - MS-DOS or PC-DOS 3.2 or above
  23.     - A Hercules/CGA/EGA/VGA compatible color/mono display
  24.     - A RemoteAccess/QuickBBS compatible messagebase
  25.  
  26.  
  27. FILES
  28.  
  29.     The QUTIL??? archive contains the following files:
  30.  
  31.     - Q_UTIL.EXE   : The executable program file
  32.     - Q_UTIL.CFG   : The example configuration file
  33.     - Q_UTIL.DOC   : This document
  34.     - Q_UTIL.REL   : Release-notes
  35.  
  36.     Q_UTIL reads information from from following files:
  37.  
  38.     - AREAS.BBS  : Echo-names and RA/QBBS-board numbers
  39.       or
  40.       FOLDER.SYS : FrontDoor folder definition file
  41.       or
  42.       AREAFILE.FD: TosScan Area definition file
  43.       (you have to define only 1 in Q_UTIL.CFG, is doesn't harm to define
  44.       them all three in Q_UTIL.CFG, but the one that is defined last, is
  45.       the one that will be used.)
  46.  
  47.     and
  48.  
  49.     - MSGINFO.BBS: RA/QBBS message info file
  50.  
  51.     These files can be placed in different directories or have other names,
  52.     it's up to you to define them in the Q_UTIL.CFG configuration file.
  53.  
  54.  
  55. INSTALLATION
  56.  
  57.     1. Choose or create a directory for Q_UTIL
  58.     2. Copy Q_UTIL*.* to this directory
  59.     3. Edit the Q_UTIL.CFG file for your specific setup
  60.     4. Run Q_UTIL
  61.  
  62.  
  63. COMMANDLINE OPTIONS
  64.  
  65.     Syntax Q_UTIL [options][switches]
  66.  
  67.     options : b  : sort areas on RA/QBBS board number
  68.               n  : sort areas on RA/QBBS board name
  69.               m  : sort areas on number of messages
  70.               f  : show free, defined and active boards
  71.               wn : wait for n-seconds before next screen
  72.  
  73.     switches: c  : disable color display
  74.               a  : show only active areas (areas containing messages)
  75.               d  : show only defined areas (to be used with b-option)
  76.               h  : displays the help screen
  77.  
  78.          Multiple options can and may be combined on the command-line.
  79.  
  80.   Running Q_UTIL with options H or ? will show you the following help-screen:
  81.  
  82.  
  83.   ╔══╡ Q_UTIL ╞══════════════════════════════════════════════╡ VER. 1.00 ╞══╗
  84.   ║                      RA/QBBS-messagebase utility                        ║
  85.   ╟─────────────────────────────────────────────────────────────────────────╢
  86.   ║                                 Usage : Q_UTIL [option(s)][switch(es)]  ║
  87.   ║                                                                         ║
  88.   ║ Options:                              Switches:                         ║
  89.   ║                                                                         ║
  90.   ║  B   sort on RA/QBBS-board number      A   show only active areas       ║
  91.   ║  F   display free board numbers        C   disable color display        ║
  92.   ║  M   sort on number of messages        D   show only defined areas      ║
  93.   ║  Wn  wait n seconds before next        H,? show this help screen        ║
  94.   ║      screen (default = 5 seconds)                                       ║
  95.   ║                                                                         ║
  96.   ╟                                                                         ╢
  97.   ║       You may copy or distribute this software free of charge.          ║
  98.   ║                Commercial use is strictly prohibited.                   ║
  99.   ║                                                                         ║
  100.   ║   For all your comments, bugreports, remarks as well as your moral      ║
  101.   ║   support you can contact me by netmail at:  Fidonet 2:295/43.4302      ║
  102.   ║                                                                         ║
  103.   ╚═══════════════╡ Copyright (c) Fons Cornelissens, 1991 ╞═════════════════╝
  104.  
  105.  
  106.  
  107. FUNCTION KEYS
  108.  
  109.    Running Q_UTIL without any option will bring up the following menu :
  110.  
  111.   ╔══╡ Q_UTIL ╞══════════════════════════════════════════════╡ VER. 1.00 ╞══╗
  112.   ║                      RA/QBBS-messagebase utility                        ║
  113.   ╟─────────────────────────────────────────────────────────────────────────╢
  114.   ║                                                                         ║
  115.   ║   Key  Function                          Key  Function                  ║
  116.   ║   ───  ───────────────────────           ───  ────────────────────────  ║
  117.   ║                                                                         ║
  118.   ║   F1   Free board numbers                F6   Active areas by number    ║
  119.   ║                                                                         ║
  120.   ║   F2   Areas by name                     F7   By number of messages     ║
  121.   ║                                                                         ║
  122.   ║   F3   Actif areas by name               F8   Active areas by messages  ║
  123.   ║                                                                         ║
  124.   ║   F4   Areas by number                   F9   Disable/enable color      ║
  125.   ║                                                                         ║
  126.   ║   F5   Defined areas by number           F10 or <ESC> Exit program      ║
  127.   ║                                                                         ║
  128.   ║   ────────────────────────────           ─────────────────────────────  ║
  129.   ║                                                                         ║
  130.   ║                                                                         ║
  131.   ╚═══════════════╡ Copyright (c) Fons Cornelissens, 1991 ╞═════════════════╝
  132.  
  133.  
  134.   Just choose the Function-key you need, and there you go ...
  135.  
  136.  
  137. ENVIRONMENT VARIABLE
  138.  
  139.     By using the DOS command "SET Q_UTIL=<path>", you can tell Q_UTIL to use
  140.     that path to find it's files.
  141.     If you intend to use Q_UTIL by hotkeying to it from another program,
  142.     it is very important to set this variable.
  143.  
  144.     Example: Suppose you have all the Q_UTIL files in the directory:
  145.  
  146.                                 C:\FD\Q_UTIL\
  147.  
  148.              Then, at the DOS-prompt, or within your batch-file, use the
  149.              following command:
  150.  
  151.                            SET Q_UTIL=C:\FD\Q_UTIL
  152.  
  153.  
  154. CONFIGURATION
  155.  
  156.     Q_UTIL is fully configurable from a single text configuration file
  157.     (Q_UTIL.CFG).
  158.  
  159.     In the CFG-file, a semicolon (;) first on the line makes it a comment,
  160.     resulting in the line being ignored by the CFG-reader.
  161.  
  162.     All other lines in the CFG-file read as "keywords", usually with one or
  163.     more parameters. See the example Q_UTIL.CFG file for specific info on
  164.     the various keywords.
  165.  
  166.  
  167. SAMPLE COMMANDLINES
  168.  
  169.     Next are a few of the possible commandlines :
  170.  
  171.   - Q_UTIL BNMFAW5 : - show the active RA/QBBS boards sorted on board number
  172.                      - show the active RA/QBBS boards sorted on areaname
  173.                      - show the active RA/QBBS boards sorted on nmb of msg
  174.                      - show the free, defined and active board numbers
  175.                      - wait 5 seconds between each screen
  176.  
  177.   - Q_UTIL MAW3    : - show the active RA/QBBS boards sorted on number of msg
  178.                      - wait 3 seconds between each screen
  179.  
  180.   - Q_UTIL NC     :  - show the RA/QBBS boards sorted on areaname
  181.                      - disable color display
  182.                      - wait for <ENTER> between each screen
  183.  
  184.   - Q_UTIL BD      : - show the defined boards sorted on board number
  185.                      - wait for <ENTER> between each screen
  186.  
  187.  
  188.   While the program waits for a keypress, the cursor keys can be used to
  189.   scroll through the areas :
  190.  
  191.                      - cursor up     : back 1 area
  192.                      - cursor down   : advance 1 area
  193.                      - cursor right  : advance 20 areas
  194.                      - cursor left   : back 20 areas
  195.                      - PageUp        : advance 20 areas (same as cursor left)
  196.                      - PageDn        : back 20 areas (same as cursor right)
  197.                      - Home          : start all over with first area
  198.                      - End           : show the last areas
  199.                      - <ENTER>       : shows next 40 areas
  200.                      - <ESC>         : leave this part and return to menu
  201.  
  202. ACKNOWLEDGEMENTS
  203.  
  204.     I would like to thank in special Tony Van den Bogaert of Aquarius
  205.     (2:295/43) for his inspiring suggestions and bugreports during the
  206.     pre 0.20-testing of this program.
  207.  
  208.     Also thanks to :
  209.  
  210.     - Flor Wauters (2:295/43.4301) for the idea of including the help-screen
  211.       and function-key file, and the screens he designed for this purpose.
  212.  
  213.     - Michel Everaert (2:295/43.4306) for his very usefull suggestions and
  214.       constructive bugreports.
  215.  
  216.  
  217. BUGREPORTS & REMARKS
  218.  
  219.     I would most welcome your suggestions and bugreports. Please write me
  220.     at FidoNet 2:295/43.4302.
  221.  
  222. -FC-------------------------------Q_UTIL---------------------------03/06/91-
  223.  
  224.