@DATABASE DiSk_Quicklog Documentation
@AUTHOR Adam Chapman
@(c) © 1995 Adam Chapman
@$VER: v1.0 (29.4.95)
@WIDTH 78
@INDEX Main
@WORDWRAP

@NODE Main "DiSk_Quicklog"
@REMARK This node is the main contents list
                           @{fg shadow}@{u}                       @{uu}@{fg text}
                           @{fg fill}@{u}                       @{uu}@{fg text}

                                  @{fg shine}Disk Quicklog
                           @{fg shine}A Disk Catalog Compiler
                                Version 1.03

                             © 1995 Adam Chapman
                           @{u}@{fg fill}                       @{uu}@{fg text}
                           @{u}@{fg shadow}                       @{uu}@{fg text}


       A PROGRAM IN THE 'MINI TOOLS' RANGE OF SOFTWARE BY ADAM CHAPMAN

  This software is freeware although the copyright remains with the author.
   If you wish to make any modifications to it, please contact the author.


@{u}Contents:@{uu}

@{"Introduction" link Introduction}             -   An introduction to Disk Quicklog
@{"System Requirements" link SysReq}      -   What do you need to run Disk Quicklog?
@{"Overview" link Overview}                 -   An overview of the Disk Quicklog system
@{"Installation" link Installation}             -   How to install Disk Quicklog
@{"Usage" link Usage}                    -   Using Disk Quicklog
@{"Revision History" link History}         -   What happened between versions?
@{"Thanks and Salutations" link Thanks}   -   Cheers lads!
@{"Contacting the Author" link Contact}    -   Contact me!
@ENDNODE

@NODE Introduction
@{u}Introduction:@{uu}

Fed up with huge GUI based disk catalog compilers?  Want a nice simple, quick
and efficient one instead?  Want one with a couple of unique features?  Want one
that automatically sorts the list into alphabetical order?  Try Disk Quicklog
for speed and size!
@ENDNODE

@NODE SysReq "System Requirements"
@{u}System Requirements:@{uu}

@{fg shine}°@{fg text} Any Amiga running Kickstart/Workbench v2.1 or above)
@ENDNODE

@NODE Overview
@{u}Overview:@{uu}

In the FidoNet echo AMIGA_UK there have, sporadically, been requests for disk
catalog compilers.  A while back I wrote a program called Compile Directory
Listing (CDL).  This program replaced another in my range (Search For File -
SFF).  This program supercedes both.  It is put simply, a killer disk catalog
compiler!
@ENDNODE

@NODE Installation
@{u}Installing Disk Quicklog:@{uu}

To install Disk Quicklog on your system, simply run the Install_Disk_Quicklog
file and follow on screen prompts.  This script will install the following files
in the following places:


@{u}@{b}C:@{ub}@{uu}

Disk_Quicklog

This is the main DOS script itself
@ENDNODE

@NODE Usage
@{u}Using Disk Quicklog:@{uu}

Disk Quicklog is designed to be run from a CLI/Shell or from the "Execute a
Command" option on the Workbench.  With a little skill it could also be linked
to buttons in a directory utility such as Directory Opus.

The syntax is as follows:

Disk_Quicklog DIR/A,OUTPUT/A,DATES/S,INCR/S,RESET/S

Where:

DIR/A		is the directory you wish to make a list of

OUTPUT/A	is the text file you wish to create (output to)

DATE/S		is a switch to turn on the inclusion of filedates in the
		compiled list (ie.  Disk Quicklog does NOT show them if this
		switch is not specified.)

INCR/S		is a switch to turn on 'same filename incremental saves'.
		This is discussed more fully below.

RESET/S		is a switch to reset the INCR variable - see below.


@{u}Simple example usage:@{uu}

Disk_Quicklog DF0: Work:DiskLog

Would produce an alphabetically sorted directory listing of DF0: in the file
"Work:DiskLog"  There would be no filedates in the listing.


Disk_Quicklog HD1: Data:BigFile DATES

Would produce an alphabetically sorted directory listing of HD1: in the file
"Data:BigFile"  There would be filedates in the listing.


The INCR and RESET switches:
----------------------------

The INCR switch allows you to continuously run Disk Quicklog by using Cursor Up
from the CLI/Shell window and not having to alter the filename.  It does this by
appending an INCRemental number onto the end of the filename.

For example, if I entered the command:

Disk Quicklog Df0: RAM:Log INCR

Disk Quicklog would produce an alphabetically sorted listing of Df0: in the file
"RAM:Log.x"  where x is the number of times I have run Disk Quicklog without
interruption.  In this instance the file would be "RAM:Log.1"

If I entered the command again but with a different disk in Df0: (of course!)
Disk Quicklog would produce a file called "RAM:Log.2".  Then .3, .4, .5 and so on.
I hope this makes sense to you.  When you are used to it, it becomes a
powerful feature and automates the proceedings a lot when processing lots of
disks in one shot.

The RESET switch allows you to reset the INCR variable so you can start from
a ".1" file again.  For example if we had reached "RAM:Log.10" in our example
and now wished to used the filename "RAM:DiskLog.x" where x is our INCR
number, then we would use the RESET switch to reset the incremental numbers
back to 1.

Caveat:

The RESET switch must be run with the DIR and OUTPUT arguments due to a
limitation of AmigaDOS.  Fortunately, these arguments may be shortened to
nonsense.  Example:

Disk Quicklog a b RESET

Disk Quicklog any junk RESET
@ENDNODE

@NODE History "Revision History"
@{u}Revision History:@{uu}

@{fg shine}Version 1.0:@{fg text}
	Original launch.

	@{fg fill}°@{fg text} Works fine - no problems during beta testing.

@{fg shine}Version 1.01:@{fg text}
	Minor Update.

	@{fg fill}°@{fg text} Ian Forest in the AMIGA_UK FidoNET echo requested that Disk Quicklog show
	  the full path of the files it catalogs.  Disk Quicklog now does this.

@{fg shine}Version 1.02:@{fg text}
	Minor Update.

	@{fg fill}°@{fg text} Documentation changed slightly
	@{fg fill}°@{fg text} Now included a 'dynami-install' installer

@{fg shine}Version 1.03:@{fg text}
	Minor Update.

	@{fg fill}°@{fg text} Generally tidied up and optimised code
	@{fg fill}°@{fg text} Changed method of pulling filenames from
	  AmigaDOS (for the technicaly among you, it was %s%s it's now %P%N - it's
	  the more correct method.
	@{fg fill}°@{fg text} Changed to using AmigaGuide documentation
@ENDNODE

@NODE Thanks "Thanks and Salutations"
@{u}Thanks and Salutations:@{uu}

@{fg shine}Thank-You's go out to...@{fg text}

	Alan Merritt	   - For being such a wonderful human being
	Bob Adams	   - For requesting a directory compiler
	Ian Wilson	   - For being a bloater
	Ian Forest	   - For suggesting improvements to Disk Quicklog

@{fg shine}Salutations go out to...@{fg text}
	Everyone in the FidoNET echo AMIGA_UK
	Everyone at Commodore who has ever had anything to do with AmigaDOS
	Mark Smiddy for being my DOS Guru
@ENDNODE

@NODE Contact "Contacting the Author"
@{u}Contacting The Author:@{uu}

@{i}Postal Service:@{ui}

Adam Chapman (Disk Quicklog - DSQ),
17, Duchess Grove
Wavendon Gate,
Milton Keynes.
MK7 7DG

@{i}BBS:@{ui}

                    The Concrete Cow BBS - (01908) 584961
                     All speeds to 28k8, v.34 supported
@ENDNODE