home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / qbbsetc / dirt0729.lzh / DIRT.DOC next >
Text File  |  1990-07-29  |  13KB  |  397 lines
  1.  
  2.  
  3.  
  4.      
  5.                         DIRT Program and Documentation
  6.                      Copyright 1988,89,90 by Thomas H Baker
  7.      
  8.      
  9.                        Section 1 -- General Information
  10.      
  11.     DIRT is a program that will compile a list of files available on your
  12.     system.  It is very easy to setup since most of the commands are
  13.     optional.  You will only need to use two commands to make this program
  14.     work, but since every SysOp likes to have a nifty file listing, there
  15.     are commands to customize and colorize the output (if so desired).
  16.      
  17.     DIRT reads the commands from a config file.  The default config file is
  18.     DIRT.CFG.  However, you may call it whatever you want.  Just tell DIRT
  19.     the name of the config file to use on the DOS command line.  For
  20.     example, "DIRT FOO.CFG" will instruct DIRT to use FOO.CFG as the config
  21.     file.  You may have as many config files as your heart desires, just
  22.     remember to tell which one DIRT should use.  For example, for normal
  23.     users, you may only one to list some file areas and thus you could use
  24.     a config file called "NORMAL.CFG".  For extra special people with
  25.     access to more file areas, you could use another config file called
  26.     "SPECIAL.CFG".  A friend of mine does this on his system.  He has one
  27.     list for normal users, and one list for SysOps.
  28.      
  29.     The config file itself is a normal ASCII file that can be created with
  30.     your favorite text editor.  Just make sure tabs are converted to spaces
  31.     because I've never tested tabs myself and I'm not sure if tabs will
  32.     hose up DIRT or not.  When entering your commands, pay attention to the
  33.     quotes and commas because they are important to DIRT.
  34.      
  35.     Now for DIRT's commands.  NOTICE THE USE OF QUOTES AND COMMAS!
  36.      
  37.      
  38.      
  39.      
  40.      
  41.      
  42.      
  43.      
  44.      
  45.      
  46.      
  47.      
  48.      
  49.      
  50.      
  51.      
  52.      
  53.      
  54.      
  55.      
  56.      
  57.      
  58.      
  59.      
  60.      
  61.      
  62.      
  63.      
  64.  
  65.                                      Page 1
  66.  
  67.  
  68.  
  69.  
  70.                           Section 2 -- DIRT Commands
  71.      
  72.     This is the ONLY required command.  Although it is a good idea to use
  73.     AVAIL or AVAILANSI (or both) so you have some output.
  74.      
  75.     -----------------------------------------------------------------------
  76.     Area, "title", "path", "options"
  77.     -----------------------------------------------------------------------
  78.     This command defines a file area for DIRT to process.  "title" is the
  79.     name of the file area and "path" is the path to the FILES.BBS and the
  80.     files themselves.  Maximum 500 areas, 1000 files each.  Each area can
  81.     have it's own set of options.  They are:
  82.      
  83.     /U = include orphan files (files not in FILES.BBS) and update FILES.BBS
  84.     /M = include missing files in DIRT output
  85.     /K = removes missing files from FILES.BBS
  86.     /S = sort entries in FILES.BBS
  87.     /W = rewrite FILES.BBS (if you wish to save the /K and /S version)
  88.      
  89.     The following commands are OPTIONAL!
  90.      
  91.     -----------------------------------------------------------------------
  92.     Avail, "pathname"
  93.     -----------------------------------------------------------------------
  94.     Tells DIRT to generate a standard ASCII file listing.  "pathname" is
  95.     the name of the file to write to.
  96.      
  97.     -----------------------------------------------------------------------
  98.     AvailANSI, "pathname"
  99.     -----------------------------------------------------------------------
  100.     Tells DIRT to generate an ANSI file listing.  "pathname" is the name of
  101.     the file to write to.  If you use AvailANSI, then you must define the
  102.     colors for the contents of FILES.BBS (see next command)
  103.      
  104.     -----------------------------------------------------------------------
  105.     Color "filename", "size", "date", "description", "missing", "text"
  106.     -----------------------------------------------------------------------
  107.     "filename" is the ANSI sequence used for file names.
  108.     "size" is the ANSI sequence used for file sizes.
  109.     "date" is the ANSI sequence used for file dates.
  110.     "description" is the ANSI sequence used for file descriptions.
  111.     "missing" is the ANSI sequence used for non-existing file names.
  112.     "text" is the ANSI sequence used for anything else in FILES.BBS
  113.      
  114.     For each of the above, use the ANSI sequence you desire.
  115.     DIRT will prefix "^[[0;" and suffix "m" to each sequence automatically.
  116.     Here are some ANSI commands:
  117.      
  118.     0 = all attributes off (default)    5 = blinking
  119.     1 = boldface (high intensity)       7 = reverse video
  120.     4 = underscore on (MDA only)        8 = invisible
  121.      
  122.     Foreground      Color           Background
  123.      
  124.     30              black           40
  125.     31              red             41
  126.     32              green           42
  127.     33              yellow          43
  128.     34              blue            44
  129.     35              magenta         45
  130.  
  131.                                      Page 2
  132.  
  133.  
  134.  
  135.  
  136.     36              cyan            46
  137.     37              white           47
  138.     -----------------------------------------------------------------------
  139.     REM, comment
  140.     -----------------------------------------------------------------------
  141.     This allows you to place REMarks or comments within the config file.
  142.     DIRT will happily ignore everything from the REM, to the end of line.
  143.     Some sysops used to use ; to make a comment.  DON'T DO THIS.  DIRT
  144.     doesn't use the ; to mark a comment.  If you used ;'s in your config
  145.     file, just change them to REM, (notice the comma) and you'll be ok.
  146.      
  147.     -----------------------------------------------------------------------
  148.     NoFile, "wildcard"
  149.     -----------------------------------------------------------------------
  150.     DIRT will not show files matching the wildcard.  This will also cause
  151.     the matching files not to be added to FILES.BBS if /U is in effect.
  152.     For example, "*.BBS" would tell DIRT not to include any file with an
  153.     extension of ".BBS".  Maximum 100 wildcards, with 100 matches per area.
  154.      
  155.     -----------------------------------------------------------------------
  156.     ListAreas
  157.     -----------------------------------------------------------------------
  158.     DIRT will place a list of the file areas between the main header and
  159.     the first file area's header.
  160.      
  161.     -----------------------------------------------------------------------
  162.     NoDate
  163.     -----------------------------------------------------------------------
  164.     DIRT will not show file dates in the output.
  165.      
  166.     -----------------------------------------------------------------------
  167.     NoSize
  168.     -----------------------------------------------------------------------
  169.     DIRT will not show file sizes in the output.
  170.      
  171.     -----------------------------------------------------------------------
  172.     Missing, "string"
  173.     -----------------------------------------------------------------------
  174.     If a file is missing, the "string" will be placed between the file name
  175.     and the file description.
  176.      
  177.     -----------------------------------------------------------------------
  178.     Update, "string"
  179.     -----------------------------------------------------------------------
  180.     If a file exists, but not in FILES.BBS, DIRT will add the file to
  181.     FILES.BBS and use "string" as the description.
  182.      
  183.     The "!" commands are available in the following commands.  "color"
  184.     statements will only be used in conjunction with the AvailANSI command.
  185.     If you do not use AvailANSI, leave "color" blank (two quotes, no
  186.     spaces. "").
  187.      
  188.     -----------------------------------------------------------------------
  189.     ExtDesc, "string"
  190.     -----------------------------------------------------------------------
  191.     This one is tricky, so you may not wish to use it.  It seems some
  192.     sysops like to use multiple line descriptions for their files.  Without
  193.     this option, the descriptions would be 'rearranged' improperly when a
  194.     sort was done.  By setting "string" equal to the lead-in you use with
  195.     your description, DIRT will keep the multiple line descriptions
  196.  
  197.                                      Page 3
  198.  
  199.  
  200.  
  201.  
  202.     together during the sort.  For example, if your descriptions began with
  203.     fourteen spaces, then place fourteen spaces between the quotes.  Keep
  204.     in mind that DIRT will assume this throughout all "files.bbs" files.
  205.      
  206.     -----------------------------------------------------------------------
  207.     Header, "color", "string"
  208.     -----------------------------------------------------------------------
  209.     Line of text to place before entire listing.
  210.      
  211.     -----------------------------------------------------------------------
  212.     Footer, "color", "string"
  213.     -----------------------------------------------------------------------
  214.     Line of text to place at end of listing.
  215.      
  216.     -----------------------------------------------------------------------
  217.     DirHeader, "color", "string"
  218.     -----------------------------------------------------------------------
  219.     Line of text to place before directory.
  220.      
  221.     -----------------------------------------------------------------------
  222.     DirFooter, "color", "string"
  223.     -----------------------------------------------------------------------
  224.     Line of text to place at end of directory.
  225.      
  226.     If DIRT finds one of the ! sequences below in "string", then DIRT will
  227.     replace the following sequence with the indicated output.
  228.      
  229.     Sequence  Actual output
  230.      
  231.     !A        Current date (MM-DD-YYYY)
  232.     !B        Current time (HH:MM:SS)
  233.     !C        Number of areas
  234.     !D        Current area number
  235.     !E        Current area name
  236.     !F        Current area path
  237.     !G        <not used anymore>
  238.     !H        Running total of files in current area
  239.     !I        Running total of bytes in current area
  240.     !J        Running total of all files
  241.     !K        Running total of all bytes
  242.      
  243.      
  244.      
  245.      
  246.      
  247.      
  248.      
  249.      
  250.      
  251.      
  252.      
  253.      
  254.      
  255.      
  256.      
  257.      
  258.      
  259.      
  260.      
  261.      
  262.  
  263.                                      Page 4
  264.  
  265.  
  266.  
  267.  
  268.                 Section 3 -- Program History, Blah, Blah, Blah
  269.      
  270.     I first wrote DIRT back in 1988.  At that time I ran a BBS called
  271.     Baker's Board.  Since I was not really impressed with any other utility
  272.     that did the same -and- since I always enjoy programming challenges, I
  273.     began work on DIRT.  Since then, I have dumped the BBS (my system is
  274.     now mail only and was renamed Tom's PC) but I continue work on DIRT.
  275.     The latest version may be file requested as DIRT (yes, this is a magic
  276.     filename so no extension is required).  My system is 2400bps, 24hrs.
  277.     The version you receive is the latest version I have.  Every version is
  278.     a beta version.  Updates are made as bugs are fixed or features are
  279.     added by user request.  But since a number of local nodes use it, I
  280.     usually find out about bugs before they get far, in fact they are
  281.     usually fixed within 24 hrs.  In other words, the software usually
  282.     works A.O.K.
  283.      
  284.     You can reach me via Netmail, or US Mail.
  285.      
  286.     Thomas Baker                       Thomas Baker
  287.     FidoNet 1:363/12                   113 Brantley Harbor Drive
  288.                                        Longwood, FL  32779
  289.      
  290.     If you send Netmail, wait a few days before polling for a response.
  291.      
  292.     Although there is NO CHARGE for the use of DIRT, you are welcome to
  293.     make a donation.  Simply send me what you think it is worth.  Please
  294.     send checks only, payable to Thomas Baker.  Keep in mind the author is
  295.     attending college full time and could use any spare bucks you have.
  296.     Send to US Mail address above.  (hint hint)
  297.      
  298.     Special thanks to the following folks for their suggestions and more!
  299.      
  300.     Max Vonderhorst       1:363/32       ThunderDome
  301.     Steve Gabrilowitz     1:363/1701     NCC-1701
  302.     John Hicks            1:363/29       Gourmet Delight
  303.     Jim Ray               1:388/14       File Quest
  304.     Dale Malone           1:363/10       Midas Touch
  305.     Darrell Cadwallader   1:363/363      Orlando Super System
  306.      
  307.     Y O U R   N A M E   H E R E   ? ? ?
  308.      
  309.      
  310.      
  311.      
  312.      
  313.      
  314.      
  315.      
  316.      
  317.      
  318.      
  319.      
  320.      
  321.      
  322.      
  323.      
  324.      
  325.      
  326.      
  327.      
  328.  
  329.                                      Page 5
  330.  
  331.  
  332.  
  333.  
  334.                    Section 4 -- The Deal (License Agreement)
  335.      
  336.     Here's the deal:
  337.      
  338.     1. You may not modify DIRT in any form.  This includes the EXE file,
  339.     documentation file, or any other files in the ZIP file.  You may not
  340.     modify the ZIP file in any form.
  341.      
  342.     2. DIRT must be distributed for FREE.
  343.      
  344.     3. DIRT may not be distributed in any way other than 'official'
  345.     distribution file.  It may not be included as part of another package.
  346.      
  347.     4. DIRT has no warranty.
  348.      
  349.     5. You use DIRT completely at your own risk.
  350.      
  351.     You may only use DIRT after agreeing to these terms.
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.                                      Page 6
  396.  
  397.