DIRT Program and Documentation
Copyright 1988,89,90 by Thomas H Baker


Section 1 -- General Information

DIRT is a program that will compile a list of files available on your
system. It is very easy to setup since most of the commands are
optional. You will only need to use two commands to make this program
work, but since every SysOp likes to have a nifty file listing, there
are commands to customize and colorize the output (if so desired).

DIRT reads the commands from a config file. The default config file is
DIRT.CFG. However, you may call it whatever you want. Just tell DIRT
the name of the config file to use on the DOS command line. For
example, "DIRT FOO.CFG" will instruct DIRT to use FOO.CFG as the config
file. You may have as many config files as your heart desires, just
remember to tell which one DIRT should use. For example, for normal
users, you may only one to list some file areas and thus you could use
a config file called "NORMAL.CFG". For extra special people with
access to more file areas, you could use another config file called
"SPECIAL.CFG". A friend of mine does this on his system. He has one
list for normal users, and one list for SysOps.

The config file itself is a normal ASCII file that can be created with
your favorite text editor. Just make sure tabs are converted to spaces
because I've never tested tabs myself and I'm not sure if tabs will
hose up DIRT or not. When entering your commands, pay attention to the
quotes and commas because they are important to DIRT.

Now for DIRT's commands. NOTICE THE USE OF QUOTES AND COMMAS!





























Page 1




Section 2 -- DIRT Commands

This is the ONLY required command. Although it is a good idea to use
AVAIL or AVAILANSI (or both) so you have some output.

-----------------------------------------------------------------------
Area, "title", "path", "options"
-----------------------------------------------------------------------
This command defines a file area for DIRT to process. "title" is the
name of the file area and "path" is the path to the FILES.BBS and the
files themselves. Maximum 500 areas, 1000 files each. Each area can
have it's own set of options. They are:

/U = include orphan files (files not in FILES.BBS) and update FILES.BBS
/M = include missing files in DIRT output
/K = removes missing files from FILES.BBS
/S = sort entries in FILES.BBS
/W = rewrite FILES.BBS (if you wish to save the /K and /S version)

The following commands are OPTIONAL!

-----------------------------------------------------------------------
Avail, "pathname"
-----------------------------------------------------------------------
Tells DIRT to generate a standard ASCII file listing. "pathname" is
the name of the file to write to.

-----------------------------------------------------------------------
AvailANSI, "pathname"
-----------------------------------------------------------------------
Tells DIRT to generate an ANSI file listing. "pathname" is the name of
the file to write to. If you use AvailANSI, then you must define the
colors for the contents of FILES.BBS (see next command)

-----------------------------------------------------------------------
Color "filename", "size", "date", "description", "missing", "text"
-----------------------------------------------------------------------
"filename" is the ANSI sequence used for file names.
"size" is the ANSI sequence used for file sizes.
"date" is the ANSI sequence used for file dates.
"description" is the ANSI sequence used for file descriptions.
"missing" is the ANSI sequence used for non-existing file names.
"text" is the ANSI sequence used for anything else in FILES.BBS

For each of the above, use the ANSI sequence you desire.
DIRT will prefix "^[[0;" and suffix "m" to each sequence automatically.
Here are some ANSI commands:

0 = all attributes off (default) 5 = blinking
1 = boldface (high intensity) 7 = reverse video
4 = underscore on (MDA only) 8 = invisible

Foreground Color Background

30 black 40
31 red 41
32 green 42
33 yellow 43
34 blue 44
35 magenta 45

Page 2




36 cyan 46
37 white 47
-----------------------------------------------------------------------
REM, comment
-----------------------------------------------------------------------
This allows you to place REMarks or comments within the config file.
DIRT will happily ignore everything from the REM, to the end of line.
Some sysops used to use ; to make a comment. DON'T DO THIS. DIRT
doesn't use the ; to mark a comment. If you used ;'s in your config
file, just change them to REM, (notice the comma) and you'll be ok.

-----------------------------------------------------------------------
NoFile, "wildcard"
-----------------------------------------------------------------------
DIRT will not show files matching the wildcard. This will also cause
the matching files not to be added to FILES.BBS if /U is in effect.
For example, "*.BBS" would tell DIRT not to include any file with an
extension of ".BBS". Maximum 100 wildcards, with 100 matches per area.

-----------------------------------------------------------------------
ListAreas
-----------------------------------------------------------------------
DIRT will place a list of the file areas between the main header and
the first file area's header.

-----------------------------------------------------------------------
NoDate
-----------------------------------------------------------------------
DIRT will not show file dates in the output.

-----------------------------------------------------------------------
NoSize
-----------------------------------------------------------------------
DIRT will not show file sizes in the output.

-----------------------------------------------------------------------
Missing, "string"
-----------------------------------------------------------------------
If a file is missing, the "string" will be placed between the file name
and the file description.

-----------------------------------------------------------------------
Update, "string"
-----------------------------------------------------------------------
If a file exists, but not in FILES.BBS, DIRT will add the file to
FILES.BBS and use "string" as the description.

The "!" commands are available in the following commands. "color"
statements will only be used in conjunction with the AvailANSI command.
If you do not use AvailANSI, leave "color" blank (two quotes, no
spaces. "").

-----------------------------------------------------------------------
ExtDesc, "string"
-----------------------------------------------------------------------
This one is tricky, so you may not wish to use it. It seems some
sysops like to use multiple line descriptions for their files. Without
this option, the descriptions would be 'rearranged' improperly when a
sort was done. By setting "string" equal to the lead-in you use with
your description, DIRT will keep the multiple line descriptions

Page 3




together during the sort. For example, if your descriptions began with
fourteen spaces, then place fourteen spaces between the quotes. Keep
in mind that DIRT will assume this throughout all "files.bbs" files.

-----------------------------------------------------------------------
Header, "color", "string"
-----------------------------------------------------------------------
Line of text to place before entire listing.

-----------------------------------------------------------------------
Footer, "color", "string"
-----------------------------------------------------------------------
Line of text to place at end of listing.

-----------------------------------------------------------------------
DirHeader, "color", "string"
-----------------------------------------------------------------------
Line of text to place before directory.

-----------------------------------------------------------------------
DirFooter, "color", "string"
-----------------------------------------------------------------------
Line of text to place at end of directory.

If DIRT finds one of the ! sequences below in "string", then DIRT will
replace the following sequence with the indicated output.

Sequence Actual output

!A Current date (MM-DD-YYYY)
!B Current time (HH:MM:SS)
!C Number of areas
!D Current area number
!E Current area name
!F Current area path
!G
!H Running total of files in current area
!I Running total of bytes in current area
!J Running total of all files
!K Running total of all bytes






















Page 4




Section 3 -- Program History, Blah, Blah, Blah

I first wrote DIRT back in 1988. At that time I ran a BBS called
Baker's Board. Since I was not really impressed with any other utility
that did the same -and- since I always enjoy programming challenges, I
began work on DIRT. Since then, I have dumped the BBS (my system is
now mail only and was renamed Tom's PC) but I continue work on DIRT.
The latest version may be file requested as DIRT (yes, this is a magic
filename so no extension is required). My system is 2400bps, 24hrs.
The version you receive is the latest version I have. Every version is
a beta version. Updates are made as bugs are fixed or features are
added by user request. But since a number of local nodes use it, I
usually find out about bugs before they get far, in fact they are
usually fixed within 24 hrs. In other words, the software usually
works A.O.K.

You can reach me via Netmail, or US Mail.

Thomas Baker Thomas Baker
FidoNet 1:363/12 113 Brantley Harbor Drive
Longwood, FL 32779

If you send Netmail, wait a few days before polling for a response.

Although there is NO CHARGE for the use of DIRT, you are welcome to
make a donation. Simply send me what you think it is worth. Please
send checks only, payable to Thomas Baker. Keep in mind the author is
attending college full time and could use any spare bucks you have.
Send to US Mail address above. (hint hint)

Special thanks to the following folks for their suggestions and more!

Max Vonderhorst 1:363/32 ThunderDome
Steve Gabrilowitz 1:363/1701 NCC-1701
John Hicks 1:363/29 Gourmet Delight
Jim Ray 1:388/14 File Quest
Dale Malone 1:363/10 Midas Touch
Darrell Cadwallader 1:363/363 Orlando Super System

Y O U R N A M E H E R E ? ? ?





















Page 5




Section 4 -- The Deal (License Agreement)

Here's the deal:

1. You may not modify DIRT in any form. This includes the EXE file,
documentation file, or any other files in the ZIP file. You may not
modify the ZIP file in any form.

2. DIRT must be distributed for FREE.

3. DIRT may not be distributed in any way other than 'official'
distribution file. It may not be included as part of another package.

4. DIRT has no warranty.

5. You use DIRT completely at your own risk.

You may only use DIRT after agreeing to these terms.











































Page 6