==========================================================================

                               DirecTree v1.0
                             By Aaron M. Fisher
                                  (c) 1994

                                DOCUMENTATION

===========================================================================

Shareware Notice
~~~~~~~~~~~~~~~~
This program is Shareware, and as such the restrictions for distribution
are as follows:

1. This program may be freely distributed, but the copyright remains with
the author.

2. No more profit must be made but for the price of the disk.

3. All the files on the disk must remain unaltered.

4. The buyer, if they like this program, are obliged to send a small fee to
the author (whose address is at the end of this file).

===========================================================================

Disclaimer
~~~~~~~~~~
Even though the program is very safe and efficient, the author will not be
held responsible for any damage or loss of data caused by the running of
this program.

===========================================================================

Introduction
~~~~~~~~~~~~
This program was written to fulfil three wishes of computer users who have
hard disks and/or large collections of disks/software:

1. Those who want a complete directory listing, in tree structure form, of
every single disk in their collection, so that every single file is listed.

2. Those who are looking for a particular file that they are after, but who
have no idea at all which subdirectory on which disk it may be found.

3. Those programmers who want a complete directory listing of their hard
disks so they can get rid of all unwanted files.

DirecTree's role
~~~~~~~~~~~~~~~~
This program, DirecTree, will come in useful in both those situations.
It is a program which, when given a device to read, whether it is hard
disk, floppy disk, ram disk, or even a PCMCIA card, will scan the media in
the relevant device, in whatever format it is in, whether it is AmigaDOS,
MS-DOS or even ST TOS (CrossDOS support required). It will then produce a
directory tree which lists all files and subdirectories in their correct
positions in alphabetical order, for a useful and quick 'summary' of the
media's contents, which can then be dumped to an Epson-compatible printer.

===========================================================================

The DirecTree Interface
~~~~~~~~~~~~~~~~~~~~~~~
When it is first loaded, the DirecTree interface will appear. This is a
screen split into three parts, which are:

1. The Main Panel,

2. The Directory Window, and

3. The Scroller/Totals

The Main Panel
~~~~~~~~~~~~~~
There are three main parts to this panel, which are:

1. Device
~~~~~~~~~
This part of the panel contains two items:

The 'Device' text gadget which is used for declaring devices to read from,
and

The Volume window which contains the name of the current volume in the
declared device.

2. I/Build/Dump
~~~~~~~~~~~~~~~
These three buttons are the ones used for producing and printing the
directory trees:

The 'I' button, if pressed in, will include icon files (.info) into the
directory trees.

The 'Build' button will construct the directory tree itself, and

The 'Dump' button will output the directory tree to an Epson-compatible
printer.

3. Status
~~~~~~~~~
The 'Status' window acts as a commentator which tells you what the program
is actually doing at all times, whether it is idle (Ready) or busy, in
which case it will keep you informed, moment by moment, of all its actions.

Directory Window
~~~~~~~~~~~~~~~~
This is where the actual directory tree is displayed, with branches,
subdirectories, files and icon files all in different colours.
It is called a directory 'tree' because of the way successive
subdirectories, with two or more subdirectories than their parents, seem to
'branch out' the further they move in, so looking like the branches of a
tree.

The branches in DirecTree are represented by vertical lines which encompass
the whole contents of subdirectories. This acts not only as a
representative of the size of a subdirectory, but also acts as a guide for
those dumps of directory trees that spread over several pages when printed
out.

The branches are shown in dark green.
The subdirectory names are shown in medium green.
The files are shown in light grey.
The icon files are shown in dark grey.

Scroller/Totals
~~~~~~~~~~~~~~~
This small panel at the bottom of the screen contains:

Two large scroller buttons for moving back and forth through the directory
tree listing on-screen,

The number of subdirectories in the directory tree, and

The number of files in the directory tree.

===========================================================================

DirecTree Notes
~~~~~~~~~~~~~~~
1. When changing the volume in one device, it is not necessary to retype
the device name in the text gadget. A double-click is all that is required
to get DirecTree to recognise the new volume.

2. The Dump feature makes heavy use of the Epson Master Print Mode command,
so it is important that the printer you intend to use has Epson emulation,
otherwise undesirable corruption might result.

3. The maximum name length of subdirectories and files is 32 characters,
to allow for the more longer names (!) which can crop up at any time.

4. The program can handle a maximum of 5,000 entries (names) in the entire
directory tree, with a maximum of 500 entries in each subdirectory, which
should be more than enough when reading a medium-high capacity hard disk or
even a CD-ROM (depending on the number of subdirectories and files). If the
number of subdirectories and files in the volume exceeds this limit, then
truncation of subdirectories and the directory tree will occur.

===========================================================================

Instructions for DirecTree
~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a simple tutorial to show you how to list the directory tree of a
floppy disk in drive DF0:. Just follow these instructions:

1. Insert a disk in drive DF0:
2. Click on the 'Device' text gadget and enter 'DF1:'
3. Click in the 'I' button if you want icons to be included
4. Click on 'Build' to construct the directory tree
5. If hardcopy is required, prepare your printer and then click on 'Dump~

And that's all there is to it!

===========================================================================

Contact
~~~~~~~
If you need to contact the author at any time for enquiries/payments/
suggestions for improvement, you can reach him at the following address:

                            Aaron M. Fisher,
                            27 Elderberry Road,
                            Pentrebane,
                            Cardiff CF5 3RG
                            WALES
                            UNITED KINGDOM

===========================================================================