TNTFLIST.DOC

21.8 KB e9da551a2e08c399…









                            TNTFLIST v1.05 Standard
                             (c) 1994 TNT Software
                              All Rights Reserved

                         ─═[ Complete Documentation ]═─









                               Table of Contents

                I. Boring, but important, stuff you should know first.
                    1. Legal Notice
                    2. Slamming the Shareware Concept
                    3. Warranty
                    4. What This Program Does
                    5. System Requirements

               II. Installation Instructions.
                    1. Upgrading from Previous Versions
                    2. First-time Installation
                    3. Multiple Lists/Configurations

              III. Troubleshooting.
                    1. Bugs in the Program
                    2. Known Problems With TNTFLIST

               IV. Other Stuff.
                    1. Technical info
                    2. Other products by TNT Software
                    3. About TNT Software
                    4. Contacting the Author
                    5. Acknowledgements

I. Boring, but important, stuff you should know first.
══════════════════════════════════════════════════════

1. Legal Notice
───────────────

This program is copyrighted software but you are free to distribute it as long
as all files remain in their original, unmodified state, and that the PKZIP -AV
(authenticity verification) remains in-tact as well.

You can this program as much as you want, as often as you want, provided that
you do not attempt to hack the software and re-distribute it.  You're permit-
ted to modify it with a HEX editor, debugger, etc as long as you don't re-dis-
tribute it after you have modified it (much like the T.A.G. BBS policy).

2. Slamming the Shareware Concept
─────────────────────────────────

This program is not, hasn't been, and never, EVER will be shareware. This
program (as well as all of my other T.A.G. BBS utilities) are absolutely FREE
to everyone.

No one in the world should have to pay ANYTHING to run my programs, especially
since they come with no guarantees, and I could simply run off with your money,
or quit writing the software.  If you ask me, a great deal of shareware is
nothing but worthless crap, why should you have to pay hard-earned cash for a
small TAG BBS utility (written for a freeware BBS program, I might add) to an
author that gets 100% profit from the money you send in? Seems like baloney to
me.

Think about this -- add up the total price of all the "registration fees" of
the demo versions of shareware programs that you've had. You would undoubtedly
be rich if you had that sum.  The simple joy and challenge of programming
should be more than a enough incentives for BBS utility authors to write their
programs.

You can count on TNT Software for creating free, non-crippled, highly-reliable,
often-updated software for T.A.G. BBS -- I didn't pay anything to make it, you
shouldn't have to pay anything to use it.

3. Warranty
───────────

This program comes with NO warranty of any kind.  Any loss of data, damage to
your system, or unexpected/unexplained/unwanted results are NOT the author's
fault and are NOT the author's responsibility.  This program is only guarant-
eed to take up hard disk space!

However, if you DO have a problem, I would be more than happy to help you
figure out a solution to what ever your problem might be and offer my services.

4. What This Program Does
─────────────────────────

TNTFLIST is yet-another complete/new file list generator for T.A.G. BBS.
However, it is feature-packed, and best of all -- FREE! Here's a brief over-
view of the features that this program offers:

   - Runs reasonably fast, special versions are included for 80286+ processors
     and systems with math co-processors.
   - Supports multiple configuration files for multiple lists - new files,
     adult files, complete listing, CD-ROM areas only, etc.
   - Can create a file list displaying the Size and/or the Date Uploaded in
     addition to the filename and file description.
   - Supports up to 500 files per area.
   - You can completely configure full path/filename to write the listing to.
   - Supports PKZIP and ARJ formats with configurable archive parameters!
   - Can create a "new files only" listing, a "complete" listing, or both!
   - Can define how many days old until a file is not considered new any more.
   - Can restrict file sections from being included via AR flags required,
     minimum and maximum DSL required, passworded-board status, and CD-ROM
     board status!
   - Can create FREQ-able directory list for FrontDoor/InterMail or Binkley
     formats (configurable path and filename to write OK file list).
   - Can update/create an entry for the actual list filename automatically,
     and you can define the description and the file point cost. Also, if the
     actual FILES.DIR file doesn't exist, it will create one on-the-fly.
   - You can configure what you want it to report the size as for "OFFLINE"
     files.
   - Comes with a fully-featured installation/setup program -- no messy config-
     uration files, colorful, FULL on-line help via the F1 key, etc.
   - You can include header and footer files before and after the listing, and
     they can be of unlimited length containing whatever you like (in ASCII)!
   - Internally can add an ASCII archive comment file with PKZIP or ARJ!
   - Reports number of files/file size totals in the listing for each area and
     for the whole file base (at the very end of the list)!
   - Can optionally exclude non-validated or offline files from the listing!

5. System Requirements
──────────────────────

There are five basic requirements for running TNTFLIST; they are:

        1. An IBM-compatible computer with at least an 8086 processor.
           (The faster the processor, the faster your list is made).

        2. A somewhat-fast hard disk with at least 100K or so free on it.
           (The faster the hard disk, the faster your list is made).

        3. A MS-DOS v2.1-compatible operating system, such as MS-DOS v6.2.
           (Anything that will run MS-DOS programs will suffice).

        4. A fairly-recent copy of T.A.G. BBS.
           (Any version that uses the FILES.DIR structure that v2.6f1 uses).

        5. At least one file section on your BBS, with at least one file.
           (If you have no files, this program is sort of useless).

II. Installation Instructions.
══════════════════════════════

1. Upgrading from Previous Versions
───────────────────────────────────

To upgrade from Version 1.00, all you need to do is copy over the TNTFLIST.EXE
and FLISTSET.EXE from Version 1.05 and you're all set. You may want to re-
generate a listing to see the enhancements and to take advantage of the bug
fix when you have files with short file extensions.

2. First-time Installation
──────────────────────────

Okay, I'll run this through step-by-step as simple as possibly. Of course, this
documentation file will end up huge, but I am going to make this sound very
simple even though it's a bit complicated.

─═[ Step One: Location of Files ]═─

        First off, place all TNTFLIST files in a directory. I use my Main BBS
directory. The only files that are necessary for execution are TNTFLIST.EXE,
and your configuration file that you will be creating with FLISTSET.EXE (so
don't erase either one of those files!).

NOTE: Three (3) copies of the TNTFLIST.EXE executable file are included in the
      archive. One is the 8086/8088-compatible version, another is the 80286-
      compatible version, and the last one is the 80287-compatible version.

Simply keep the original archive then copy the 80286/80287 version over the
current TNTFLIST.EXE.

TNTFLIST.EXE - 8086/8088-compatible version of TNTFLIST. Only use this one if
               you have an 8086/8088/XT processor (or if your processor is not
               recognized by FLST_286.EXE as being 80286-compatible).

FLST_286.EXE - 80286/80386/80486/Pentium-compatible version of TNTFLIST. Use
               this if you have an AT, 386, 486, or Pentium machine without a
               math co-processor

FLST_287.EXE - This version is the same as "FLST_286.EXE" except that you MUST
               have an 80x87-compatible math co-processor installed or it will
               not run and spit the error message "Math co-processor required"
               back at you when you try to run it. If you DO have a math-co
               installed, and FLST_287.EXE doesn't recognize it as being
               compatible, then use FLST_286.EXE instead.

─═[ Step Two: The TNTFLIST Setup Program ]═─

        Now, type this from the directory that FLISTSET.EXE is located in:

                         FLISTSET TNTFLIST.CFG [Enter]

        It will notify you that "TNTFLIST.CFG" does not exist, and will ask you
if you want to create it or not. Select "Yes" with either the cursor keys, by
pressing [Enter], or by typing "Y".

        Now you will be at the FLISTSET main menu. Go through each option and
change what you need to. If you do not understand an option, simply press the
F1 key followed by the option number/letter and full, on-line help will come
up on that option! How much easier can it be!?

─═[ Step Three: Batch File Setup and Execution ]═─

        Now, all you need to do is edit your nightly maintenance batch file or
whatever other batch file(s) that you want to update your BBS file listing in.
In my DAILY.BAT file, I have the following:

@ECHO OFF
CD\BBS
TAGMATE TAGMATE.CFG LOG /L File List Updated
TNTFLIST TNTFLIST.CFG
CD\BBS
EXIT

        In other words, simply add "TNTFLIST <configuration filename>" where
ever you deem it necessary. You could even set it up as a command on a menu
that calls a generic batch file that creates the listing on-the-fly and then
sends it to the user via a DSZ/GSZ command line, but I haven't done it, so
I'm not going to get into details about it. All I know is that it's possible.

3. Multiple Configurations/Lists
────────────────────────────────

        If you want to make separate lists (i.e. one for new files, one for all
files, one for adult files, etc) this section is for you.

        First of all, you have to understand how TNTFLIST works. TNTFLIST is
designed to be the most flexible and most configurable file list generator in
existance. It can read any number of configurations, only limited by the size
of your hard disks and creativity on the types of file lists that you want to
make. It reads the configuration file that you specify on the command line, and
goes by that file the whole time it is executing. It will not mess with any
other configuration file except the one that you specify on the command line.

        Therefore, you have to make separate configuration files named dif-
ferently (or in different directories and/or different drives) in order for it
to read an alternate configuration. For instance, if you wanted one listing
(ALL.CFG for example) to include all files on your BBS, you would execute
"FLISTSET ALL.CFG", create it and configure it to include ALL of your files,
then you would save it and execute "TNTFLIST ALL.CFG" to create the list. But,
if you wanted an adults-only and an "all files" list to be made, you would
keep your ALL.CFG, then you would "FLISTSET ADULT.CFG", create/configure it to
only include adult files, then you would have to have two separate executions
in your batch file(s) that you ran TNTFLIST in, for instance:

@ECHO OFF
CD\BBS
TNTFLIST ALL.CFG
TNTFLIST ADULT.CFG
EXIT

...Like that. The basic idea being: One configuration file and execution in
your batch file per listing created.

III. Troubleshooting.
═════════════════════

1. Bugs in the Program
──────────────────────

        Please note that TNTFLIST is definitely not guaranteed to be bug-free,
and probably ISN'T bug-free!

        If you suspect that there is a bug in TNTFLIST and would like to report
it, here's what you need to do:

        1. Figure out some way to repeat the problem, and repeat it at least
           once so you know for sure what causes the problem.

        2. If the program came up with an actual Runtime Error, see if a
           "TNTERROR.LOG" file was created in the directory that your TNTFLIST
           executable resides in. Sending me that file would assist me greatly
           in solving the problem with you.

        3. Be sure that it's definitely NOT a configuration problem or operator
           error on your part. Check your configuration, paths, directories,
           help files, and documentation files, etc and see if they say any-
           thing about the suspected "bug".

        Once you're sure of all that, NetMail me an explaination (addresses and
such can be found at the end of this documentation file), or call my BBS and
upload your TNTERROR.LOG file and E-Mail an explaination to "Sysop".

2. Known Problems With TNTFLIST
───────────────────────────────

        Below is a listing of some problems that could still exist in TNTFLIST
although it has been under some extensive Alpha and Beta testing in the past
few months.

        1. Runtime Error #4, Too Many Files Open. This problem may occur if you
           have your FILES= command set lower than, say, 20 in your CONFIG.SYS
           file. It is a good idea to set this to at least 20 (mine is 40!) if
           you are running a BBS. This allows for more DOS files to be open at
           one time, and 20 is definitely enough for TNTFLIST. If a problem
           arises with Runtime Error #4, try setting your FILES= to 255 just to
           test and see if that was the problem, and send me your TNTERROR.LOG.

        2. Directory Updating doesn't work. For some of the Beta testers, even
           though for the rest it works fine, they can't seem to get the .DIR
           file updating/creating to work AT ALL. I've tested it and it's work-
           ed absolutely perfectly so far, so it could have been a configur-
           ation error on their part, but I guess we'll see for sure once this
           program gets to the public.

IV. Other Stuff.
════════════════

1. Technical info
─────────────────

A. The FLISTSET.HLP file format.

FLISTSET.EXE indexes the help file with the "/* BEGIN x,y */" and "/* END x,y
*/" header and footer for each option. For instance, if you're on the main menu
and you want help on option four, it'll look for "/* BEGIN 0,4 */". After it
finds the beginning, it'll simply display whatever comes up until the "/* END
0,4 */" footer. The codes that are accepted within the file are:

        "|nn" - Color number to change the color on the screen to (except for
                blinking. All the colors are the same as in TP and TheDraw.

        "" - Prompt the user to press any key (exactly like in a T.A.G. text
              file).

Each help segment can be of unlimited length, but the larger you make help
segments, the longer it will take for it to seek through to 5,5, for instance.

You are permitted to edit the help file (I used QEdit v3.00 to create it), and
if you make a good one (more informative/more helpful) feel free to submit it
to me and if I decide to use it in the next release, you will receive credit in
the documentation for it!

However, do NOT distribute a modified help file at ALL. ONLY distribute what is
included with the original PKZIP archive, and make sure that the archive has
maintained the -AV stamp. Again, basically the same policy as T.A.G. BBS --
modify it all you want, just don't distribute a modified copy to ANYONE.

B. What is TNTFLIST written in?

I have written everything that I've ever release for T.A.G. BBS in Turbo Pascal
Version 7.0. Everything, so far, has been compiled in Real Mode.

My latest programs, however, are using a T.A.G. programming library that I
wrote that may be release (possibly with the source code) sometime soon for you
all to check out. It includes procedures for screen color manipulation (|xx to
change color with procedures similar to Write and WriteLn). See the next
section for more information about other/future products of TNT Software.

2. Other products by TNT Software
─────────────────────────────────

TAGMate v0.90 Gamma - FREQ: "TAGMATE" from 1:2410/480.
------------------------------------------------------

Release date: April 1994.

TAGMate is what "DoorStat", "NewLog", "AutoMail", and "Top 15" were. It does
everything all four of those programs did and more. AutoMail now has JAM
support, Top 15 has been revived and re-updated, and there have been several
minor additions and bug-fixes made to DoorStat and NewLog. All problems with
file board exclusion/access restriction have been fixed in Top 15 as well.

Soon, TAGMate will have a "most-popular message boards" feature where it will
create a compilation/analysis of message-posting on all of your message areas
and nodes of your system so your users [and you] can see exactly what message
sections [including Echo/Group areas, optionally] are active on your system.

Also, a text file colorizer may also be implemented into TAGMate where you
can completely colorize (with T.A.G. ^C# codes) any ASCII file so it will look
nicer on your system when a user with ANSI graphics displays the file.

(If you would like more information about any future updates/programs of TNT
 Software, NetMail Joe McElmeel @ 1:2410/480).

3. About TNT Software
─────────────────────

        TNT Software is a [very] small association of T.A.G. programmers that
was started mid-1992 in the Detroit area. We've been dedicated to bringing you
high-quality, low-cost software since then. The head programmer of TNT Software
is Joe McElmeel, 16, who's hobbies include programming, listening to music, and
talking about himself in third person [credit Brian Dodds].

        Richard Landskroener, 18, is the other programmer for TNT Software that
originally wrote NewLog and has designed and wrote TopBases. As matter of fact,
he's the one that initally taught me the basic Pascal language!

        The name "TNT Software" was thought up by Jeff Witt, 17, another pseudo-
programmer/Alpha site. "TNT" stood for "The NewLog Team", because NewLog was
our original program, but as most of you know by now, it is being merged into
one new program called "TAGMate".

        Here's a listing of TNT Software support sites as of 03/17/94:

               (In alphabetical order by the SysOp's last name).

                               ═[ Alpha Sites ]═

SysOp Name      Fido Node  BBS Name         Phone Number  Location         Key
─────────────── ────────── ──────────────── ───────────── ──────────────── ───
R. Landskroener 1:2410/331 Emergency Scene  (313)941-2176 Romulus, MI       A
Mike Lowe       1:112/99   Marauder's Hidea (904)292-0531 Jacksonville, FL  D
Joe McElmeel    1:2410/480 The Galaxy BBS   (313)928-0522 Lincoln Park, MI  A
Dan Smith       1:318/7    Unknown Gateway  (505)784-3275 Clovis, NM        A

The "Key" means:

        A = Supports v.32bis/v.42bis 14400 BPS.
        B = Supports v.32bis/v.42bis 14400 BPS, as well as HST 16800 BPS.
        C = Supports v.32/v.42bis 9600 BPS, as well as HST 14400 BPS.
        D = Supports v.32bis/v.42bis 14400 BPS, as well as ZyXEL 16800 BPS.

                                ═[ Beta Sites ]═

SysOp Name      Fido Node  BBS Name         Phone Number  Location         Key
─────────────── ────────── ──────────────── ───────────── ──────────────── ───
Chris Bourne    1:2470/11  Law & Order      (517)263-0273 Adrian, MI        A
Chris Bourne    1:2470/16  Law & Order      (517)263-0017 Adrian, MI        A
Tracy Carpenter 1:2410/512 Fantasy Island   (313)284-8507 Riverview, MI     A
Brian Dodds     1:101/200  Purple Cowz ][   (617)373-7404 Boston, MA        B
Alex Mcneilly   1:2410/278 The CPF          (313)386-7054 Lincoln Park, MI  C
Alex Mcneilly   1:2410/0   The CPF          (313)386-1884 Lincoln Park, MI  B
John Perri      1:159/270  Treasure Island  (517)349-4726 Okemos, MI        A
Mark Watts      1:2410/329 Mists of Time    (313)282-6149 Brownstown, MI    A
Mark Watts      1:2410/330 Mists of Time    (313)282-9529 Brownstown, MI    A
Brad Witschner  1:318/15   Scooter's Place  (505)784-5471 Clovis, NM        A

The "Key" means:

        A = Supports v.32bis/v.42bis 14400 BPS.
        B = Supports v.32bis/v.42bis 14400 BPS, as well as HST 16800 BPS.
        C = Supports v.32/v.42bis 9600 BPS, as well as HST 14400 BPS.
        D = Supports v.32bis/v.42bis 14400 BPS, as well as ZyXEL 16800 BPS.

4. Contacting the Author
────────────────────────

        Joe McElmeel, programmer of TNTFLIST & FLISTSET, TNTFLIST documentation
and the FLISTSET help file can be contacted in any of the following ways:

        1. Through the InterNet via mail to bsc@tiamat.umd.umich.edu.

        2. Through FidoNet NetMail at 1:2410/480.0.

        3. Calling The Galaxy BBS directly and leaving E-Mail to SysOp.
           The Galaxy BBS is (313)928-0522, 14.4k v.32bis/v.42bis.

        4. In any of the backbone T.A.G. echos such as: TAG, TAGMULTI,
           TAG_DOORS, TAGBETA, TAG_OS2, and net 2410's LOC_TAG_TECH echo.

5. Acknowledgements
───────────────────

        All programs, operating systems, products, brand names, etc are all
property/under the ownership of/a trademark of their respectable owners.

        Thanks to Jeff Witt for thinking of the name "TNT Software".

        Thanks to Paul Williams, Victor Capton, and Randy Goebel for creating
an excellent, freeware BBS package and releasing the data structures for it!

        Thanks to the Alpha and Beta team for testing my software and putting
up with me!

                                 -End of File-