home *** CD-ROM | disk | FTP | other *** search
/ Internet Access: To the Information Highway / InternetAccessToTheInformationHighway1994.disc1of1.iso / gcomm / f / ffg104a.lzh / FFG.DOC < prev    next >
Text File  |  1992-10-18  |  12KB  |  243 lines
  1.  
  2.    ┌──────────────────────┬───────────────────────────────────────┬────────┐
  3.    │ Fast File Gen 1.04.a │ A quick 'ALL FILES' generator for RA. │ M ▀▀▄  │
  4.    │  Copyright (C) 1992  ├───────────────────────────────────────┤   ▄▄ █ │
  5.    │          by          │ Maelstrom Online Services ■  1:106/63 │  ████  │
  6.    │      Kit Cragin      ├───────────────────────────────────────┤ █ ▀▀   │
  7.    │  Maelstrom Software  │ 713-334-1265 HST ■ -4- rotating Lines │  ▀▄▄ S │
  8.    └──────────────────────┴───────────────────────────────────────┴────────┘
  9.  
  10.    DESCRIPTION
  11.    ─────────────────────────────────────────────────────────────────────────
  12.    Fast File Gen (FFG)  is a simple, but quick and powerful `ALL FILES' list
  13.    generator for Remote Access BBSes  (v1.10 up).  Don't let the short docu-
  14.    mentation fool you: FFG has many useful features, and for $11 to register
  15.    it's an invaluable tool for the RA SysOp.
  16.  
  17.    FEATURES
  18.    ─────────────────────────────────────────────────────────────────────────
  19.    I created a variety of SysOp configurable features so the program will be
  20.    easy and flexible for you to use.
  21.  
  22.    ■ Generates lists of all file areas or just the ones you specify
  23.    ■ Handles read-only media, and creates index files of  file sizes so that
  24.        subsequent file listings do not need to access the CD-ROM at all
  25.    ■ MultiNode Aware (can be run while all users are online)
  26.    ■ Output is fully configurable with a number of replaceable codes
  27.    ■ Multiline descriptions are supported
  28.    ■ List format is: <filename> <size> <desciption> [<optional line>]
  29.    ■ Handles comments that have been imbedded into FILES.BBS listings
  30.  
  31.    Release 1.1  will have many, many more features.  Some you may have seen;
  32.    some  will  be surprisingly useful.  But register now for $11, and get in
  33.    cheap!
  34.  
  35.    RESTRICTIONS/REGISTRATION
  36.    ─────────────────────────────────────────────────────────────────────────
  37.    Feel free to pass this software on to others,  but make sure there are no
  38.    modifications of any kind. This software is shareware which means you can
  39.    use it for 30 days before you either register it, or discontinue use.
  40.  
  41.    To register, print REGISTER.ME and send a paltry $11. It ain't that much!
  42.  
  43.    CONFIGURATION
  44.    ─────────────────────────────────────────────────────────────────────────
  45.    I've designed FFG to be as simple and easy to set up as possible, because
  46.    I know many sysops hate to waste time writing batch files and testing new
  47.    programs. If you follow the steps below, FFG should run without a hitch.
  48.  
  49.    Configuration involves editing the included FFG.CFG file.  This file con-
  50.    tains several types of lines. Those that begin with a
  51.  
  52.       `;'  are comments and do not affect program operation.
  53.       `$'  are configuration parameters.
  54.       `!'  signal the end of a header or footer.
  55.  
  56.    Other lines are considered to be part of a header or footer.
  57.  
  58.    ┌─┐ Edit the configuration parameters.  Note that all parameters follow a
  59.    │1│ `$' in column 1, then a <space> then the parameter (0-38 characters).
  60.    └─┘ (**NOTE** The first 38 characters can ONLY contain the parameter, and
  61.        nothing else!)
  62.  
  63.          1   Path and filename of the output filelist (eg. ALLFILES.LST)
  64.  
  65.          2   Path to your CONFIG.RA file (Trailing \ is optional)
  66.              (**NOTE** cannot be the root directory!)
  67.  
  68.          3   Path to your FILES.RA  file (Trailing \ is optional)
  69.              (**NOTE** cannot be the root directory!)
  70.  
  71.          4   Template format of FileNames.  This is a combination of 8 upper
  72.              or lower case `X's, then a `.' or <space>, then 3 `X's.  Upper-
  73.              case X means the FileName's character will uppercase:
  74.  
  75.                         ┌──────────────┬────────────────┐
  76.                         │   TEMPLATE   │ EXAMPLE OUTPUT │
  77.                         ├──────────────┼────────────────┤
  78.                         │ XXXXXXXX.XXX │  FASTFILE.GEN  │
  79.                         │ Xxxxxxxx Xxx │  Fastfile Gen  │
  80.                         │ XxXxxxxx XXX │  FaStfile GEN  │
  81.                         └──────────────┴────────────────┘
  82.  
  83.          5   Format of the FileSize portion of the output.  This can be 1 of
  84.              these 4 types:
  85.                           ┌──────────┬────────────────┐
  86.                           │ TEMPLATE │ EXAMPLE OUTPUT │
  87.                           ├──────────┼────────────────┤
  88.                           │    k,    │ 2,331k         │
  89.                           │    b,    │ 2,312,456,889  │
  90.                           │    k     │ 2331k          │
  91.                           │    b     │ 2312456889     │
  92.                           └──────────┴────────────────┘
  93.  
  94.          6   The number of spaces between FileName and FileSize
  95.  
  96.          7   The number of spaces between FileSize and Description
  97.  
  98.          8   The number of spaces before FileName (usually 0)
  99.  
  100.          9   The number of spaces to indent multiline descriptions
  101.                                              ┌─┐
  102.         10   List of replaceable codes  (see │3│) with which to append  text
  103.              specified in #11 below.         └─┘
  104.  
  105.         11   The text that you want to append to certain  replaceable codes;
  106.              this is used to enhance the output.  For example in the FFG.CFG
  107.              file that came with this archive,  you'll see a `&&a' parameter
  108.              in the  area header and footer.  The next set of characters are
  109.              solidspace `▒'s. The &&a prints out the area name. So we get
  110.  
  111.                            ▒▒▒ New Uploads▒▒▒▒etc.
  112.  
  113.              Since the name `runs into'  the solid spaces,  I want to have a
  114.              <space> appended to the &&a. This will give me
  115.  
  116.                            ▒▒▒ New Uploads ▒▒▒etc.
  117.  
  118.              which looks a little nicer.  If you want 2 spaces, just specify
  119.              that. Simply put the text between `"'s (rabbit ears) eg: "  ".
  120.  
  121.         12   The list of areas that you want to add to your list.  If you're
  122.              doing all your file areas then put `ALL' on the line. If you're
  123.              doing a subset, separate the areas by spaces,  and sequences of
  124.              areas by a `-'. For example
  125.                                          1 4 7-10 12-15 18
  126.  
  127.         13   Do you want  imbedded comments to be generated with your list?
  128.              Enter  YES or NO here.  Comments  are lines  that begin with a
  129.              <space> inside of FILES.BBS's or FILES.nnn's.
  130.  
  131.         14   Scan mode.  Enter NOCHECK, OFFLINE or NOPUT.
  132.  
  133.              NOCHECK - Fastest scan.  If the filename is  in FILES.BBS then
  134.                        it appears on the list.   If the file is not on disk
  135.                        a size of 0k is indicated. (But if your list matches
  136.                        your directory exactly, I'd use this method.)
  137.  
  138.              OFFLINE - Checks to see if the file is on disk.  If it is not,
  139.                        then '[OFFLINE]' is placed in the  filesize  part of
  140.                        the output line. Slower than NOCHECK.
  141.  
  142.              NOPUT   - Checks to see if the file is on disk.  If it is not,
  143.                        then the  filename and description  are not put into
  144.                        the ouput listing at all.  Slower than NOCHECK.
  145.  
  146.    ┌─┐ Edit each of the 4 header/footer areas  to your taste.  Refer to sec-
  147.    │2│ tion -3- for any  replaceable codes  that you might want to use.  The
  148.    └─┘ first header is the `title' or main header to the file list.  The 2nd
  149.        is the header added to the beginning of each file area.  The third is
  150.        the footer added to the bottom  of each file area.  The fourth is the
  151.        'summary' page appended to the end of the list.
  152.  
  153.        All header/footers have a maximum of 50 lines.  The only exception is
  154.        the footer page when being expanded by a `&&A' code.
  155.  
  156.    ┌─┐ Add the Replaceable Codes  in the header/footer areas (see -2- above)
  157.    │3│ as needed. The codes are replaced in `overtype' mode.  So if you have
  158.    └─┘ &&D (date) in a section of text below with a `D' in Section -1-, #11:
  159.  
  160.                 │ =-= &&D -=-=-=-= │
  161.         you get
  162.                 │ =-= 03/07/92 =-= │
  163.  
  164.        The parameters are
  165.  
  166.        &&D - The current date in mm/dd/yy format
  167.        &&T - The current time in hh:mm:ss [am|pm] format
  168.  
  169.        &&a - The current file area's name   as specified in FILES.RA
  170.        &&n - The current file area's number as specified in FILES.RA
  171.        &&f - The number of files found in the area
  172.        &&s - The total size of files in the area (formatted as per Sec.1,#5)
  173.  
  174.        &&N - The total number of file areas processed
  175.        &&F - The total number of all the files in all areas
  176.        &&S - The total size   of all the files in all areas
  177.  
  178.        &&A - A special paramter which outputs 1 line for each file area. The
  179.              line contains the &&a &&f &&s sequences nicely formatted.  This
  180.              makes a nice summary for all your areas.
  181.  
  182.    RUNNING FFG
  183.    ─────────────────────────────────────────────────────────────────────────
  184.    Running FFG is simple.  Just switch to the FFG directory and type FFG, or
  185.    type the \full path\FFG on the commandline.  The FFG.CFG config file will
  186.    be loaded by default.  If you wish to use a different one, add that para-
  187.    meter to the commandline.  Here's a sample section of a nightly maintain-
  188.    ance batch file that generates 3 lists:
  189.  
  190.        REM #1 Generate list of ALL files on BBS
  191.        c:\ra\util\ffg\ffg
  192.        REM #2 Generate list of all adult files
  193.        c:\ra\util\ffg\ffg adult.cfg
  194.        REM #3 Generate list of #1-#2
  195.        c:\ra\util\ffg\ffg regular.cfg
  196.  
  197.    Note that each of the .CFGs contain the appropriate file areas to  gener-
  198.    ate and the appropriate  names of the output lists.  The .CFGs must be in
  199.    the same directory as FFG.EXE.
  200.  
  201.    If an area seems to come up with a list of 0b files, or invalid filesizes
  202.    then type FFG /FIX.  This will delete all invalid FILESIZE.nnn files that
  203.    FFG comes across.  You may then run FFG as normal (new FILESIZE's will be
  204.    created on the next run).
  205.  
  206.    REGISTERING FFG
  207.    ─────────────────────────────────────────────────────────────────────────
  208.    Registration is simple (not to mention appreciated).  There are 2 ways to
  209.    do it; you can choose the one that is easiest for you.
  210.  
  211.    ┌─┐ Call Maelstrom Online Services at 1:106/63 (4 lines)
  212.    │1│ 713-334-1265, & use the online registration feature (uses Visa/Master
  213.    └─┘ Card/Discover/JCB/DinersClub/Carte Blanc).   You will  receive  a key
  214.        immediately!  This is the fastest method.
  215.  
  216.    ┌─┐ Print REGISTER.ME, fill it out & send check/cash/money order  or your
  217.    │2│ credit card information. If you're in the FidoNet or DoorNet nodelist
  218.    └─┘ I'll send your key netmail.  Otherwise, US Mail.
  219.  
  220.    NOTES
  221.    ─────────────────────────────────────────────────────────────────────────
  222.    For those of you with a CD-ROM drive,  FFG will create FILESIZE.nnn files
  223.    in the listpath directory (where your FILES.nnn files are stored) accord-
  224.    ing to CONFIG.RA.   Subsequent  file listings will  run much faster since
  225.    file sizes won't need to be determined from the CD-ROM.   Should you ever
  226.    need to rescan  the filesizes  (say if you sorted  FILES.40 in descending
  227.    order) just delete the FILESIZE.nnn file associated with each area that's
  228.    changed and rerun FFG.
  229.  
  230.    SUPPORT
  231.    ─────────────────────────────────────────────────────────────────────────
  232.    Need help? Contact me in Fido's RA_UTIL echo, netmail, on the BBS (see #s
  233.    above), via US Mail or transporter beam.
  234.  
  235.    CREDITS
  236.    ─────────────────────────────────────────────────────────────────────────
  237.    ■ Special thanks to
  238.        ■ William Herrington - The SaddleBag BBS - 1:374/38
  239.        ■ Wai Wong - Wai's BBS - 1:153/754
  240.        ■ Bob Knowles - Beach Ribbs - 1:271/58
  241.    ─────────────────────────────────────────────────────────────────────────
  242.    Enjoy!
  243.