Documentation Name: KWIKTREE.DOC
Documentation Date: 01/01/89
Software Version: 2.11

Modular Software Systems
PO Box 50281
Pasadena, CA 91105

Compuserve: 73367,176
Bix: gpalmer


Modular Software Systems (hereafter refered to as MSS) provides
no warranties, written or implied, with this software. It is
provided on an "AS IS" basis with no guarantee that it is fit for
any particular purpose. MSS does not accept any responsibility
for damage caused by this software whether or not it is operated
correctly. MSS reserves the right to modify the software, at any
time, without obligation to notify any person or organization of
such modifications.

KWIKTREE is user supported software. It may be freely distributed,
but may not be sold or modified without the express written per-
mission of Modular Software Systems. To register your copy,
please send a check or money order for $20 to the address above.
Site licenses are available; please contact MSS for more infor-
mation. By registering your copy you will receive technical
support, a free update, and notification of future updates. By
registering you will be supporting the development of more useful
and affordable software for DOS and OS/2.



Modular Software Systems

MSS is owned and operated by Gary and Kay Palmer. It provides
low cost tools and utilities for DOS and OS/2. Most of these
tools are aimed at programmers, but many are suitable for the
typical PC power user. We are very open to the suggestions
of our users, so please feel free to give us your input.



Technical Support

Guaranteed technical support is available only to registered
users. The best way to reach me is through EasyPlex on Compuserve.
The next best (and only other) way to contact me is by writing to
the address listed at the top of this document. No phone support
is available at this time. If you are an unregistered user, you
may contact me through EasyPlex, but there is no guarantee that I
will be able to get back to you.

When contacting MSS please provide the following information:

your name, address or Compuserve ID,
the product name, version, and serial number,
a description of your hardware and software environment,
a description of the problem.


Overview

KWIKTREE is a program that will allow you to quickly and easily
manage directory trees. It will display a graphic listing of the
directory structure in alphabetical order; create reports on the
number of files and amount of disk space used; and, optionally,
perform operations in a set of subdirectories. It is an ideal
tool for managing hard disks, especially for LAN administrators.
The output is easily redirected to a printer using the standard
DOS redirection methods.



Requirements

KWIKTREE requires DOS version 3.1 or later and should run with any
standard hard (or floppy) disk format. OS/2 is not currently
supported, but will be in future versions. KWIKTREE will run
in OS/2's DOS compatibility box.



How to use KWIKTREE

KWIKTREE is easy to use. The format for the KWIKTREE command is
as follows:

KWIKTREE [path] [options]

where [path] is the drive and directory to use as the base dir-
ectory, and [options] tell how the output is to be formatted. If
[path] is omitted, then the root directory of the current drive
is used as the base. The options may be specified in upper or
lower case. The default action of KWIKTREE if no options are
specified is to only display the directory tree. The following
options are available:

? - Help - Displays the list of options.

/RA - Report Alpha - Displays a report sorted
alphabetically by directory name.

/RS - Report Space - Displays a report sorted by
the amount of disk space used.

/R - Reports - Displays both the Alpha and Space
reports.

/FF - FormFeed - Causes a formfeed character to be
output after the tree and each report are
displayed. This option is normally used
when redirecting the output to a printer.

/FX - Force eXpanded - Produces full width 94 column
reports instead of the default 80 column reports.
With 80 column reports, directory names that
are longer than 50 characters will be truncated
so that the report will fit on the screen or an
80 column printer. This option is only valid
when used in combination with one of the /R
report options.

/P - Pause - Causes a pause with the message "Press
any key to continue..." after the tree and each
report are displayed.

/NB - No Banner - Disables the display of the program
title banner. This is useful if you are using
the KWIKTREE output as the input to another
program.

/NH - No Headers - Disables the display of the report
headers and totals. This is useful if you are
using the KWIKTREE output as the input to another
program.

/NT - No Tree - Disables the display of the directory
tree. This is useful if you are only interested
in the report output.

/TT - Tree Total - Affects the file and space counts
for the directories when using one or both of
the report options. In normal reports (not using
the /TT option) the file and space counts for
each directory are the totals for that actual
line item in the report. When using the /TT
option, those counts become the totals for that
directory as well as all subdirectories beneath
it. This feature is very nice for managing large
network hard disks where many users have their
own directory trees.

/X:"" - eXecute - This very powerful option allows
you to execute any command or program in each
subdirectory in the tree. Specify the command
to execute in double quotes. Please note some
things to be aware of when using this command:

1) - Nested levels of quotes are not allowed.

2) - The command being executed will execute
in the base directory as well as all
subdirectories of the base directory.
This is important to note if you wish
to delete the files in all subdirectories
but not in the base directory.




Examples

1) - You need a list of the options. The command would have the
following format:

KWIKTREE ?


2) - You wish to display a directory tree of drive C: and drive
C: is the current drive. The command would have the
following format:

KWIKTREE


3) - You wish to display a directory tree of drive C: and drive
C: is the NOT the current drive. The command would have the
following format:

KWIKTREE c:


4) - You wish to display a directory tree starting with the
current directory and route the output to your printer.
The command would have the following format:

KWIKTREE . >prn


5) - You wish to display a directory tree and reports for the
current drive. The command would have the following format:

KWIKTREE /r


6) - You wish to display a space report but not the directory tree.
The command would have the following format:

KWIKTREE /rs /nt


7) - You wish to display a directory tree and reports for the
current drive. You have set your printer to 132 columns and
want the expanded width reports to be printed. You also
want each report to be printed at the top of the page. The
command would have the following format:

KWIKTREE /r /ff /fx >prn


8) - You have a network drive on which many users have their own
directory trees all under the directory z:\USR\name.
You want to know how much space each user is using including
the space in any subdirectories the user may have set up below
his own personal directory. The command would have the
following format:

KWIKTREE Z:\USR /rs /tt


9) - You want to delete all the files on the disk in drive A: but
wish to keep the directory structure intact. The command
would have the following format:

KWIKTREE A:\ /x:"del *.*"


10) - You want to delete all the files on the disk in drive A: but
wish to keep the directory structure intact. You also do
not want to see the directory tree and you do not want to
be prompted with the question "Are you sure? (y/n)" for each
directory. The command would have the following format:

KWIKTREE A:\ /nt /x:"del *.*
NOTE: For this command to work you must create a text file
called YES.TXT that only contains a Y and a carriage
return.