@database DirScanner.guide
@author Hynek Schlawack
@smartwrap
@tab 4

@node MAIN "DirScanner - Manual"
	@{line}
	@{fg shine}@{b}DirScanner 2@{ub}@{fg text} @{line}
	Copyright © 1998 - 2000 by Hynek Schlawack @{line}
	All Rights Reserved @{line}

	@{b}General:@{ub}@{line}
@{line}
	@{"  " link intro } - Introduction@{line}
	@{"  " link copy  } - Distribution@{line}
	@{"  " link support } - Support@{line}
	@{"  " link req } - Requirements@{line}
	@{"  " link install} - Installation@{line}
@{line}
	@{b}Manual:@{ub}@{line}
@{line}
	@{"  " link start} - Invocation@{line}
	@{"  " link conf} - Configuration@{line}
	@{"  " link mwin} - Main Window@{line}
	@{"  " link menus} - Menus@{line}
	@{"  " link rexx} - ARexx@{line}
@{line}
	@{b}Appendix:@{ub}@{line}
@{line}
	@{"  " link credits} - Credits@{line}
	@{"  " link History/Main} - History@{line}

@endnode

@node intro "DirScanner - Introduction"
@{line}
	@{fg shine}@{b}Introduction@{ub}@{fg text}@{line}

	Welcome to the second release of the free distributable filefinder
@{b}DirScanner@{ub}. It is compareable with eg. SimpleFind3, but that is
actually intended because DirScanner might be not so configurable and powerful 
on the one hand but he is fast and easy to use on the other hand. If you simply
just want to find a file, you maybe want to have a look at DirScanner.@{par}

	After having restarted the development of DirScanner I got some mails of
kind users and that made me feel that DirScanner isn't that useless. But even
having rewritten big parts of DirScanner, I decided to restart the development
from scratch without changing the character of being a fast and easy to use
tool. Now the first version of DirScanner is finished and I'm quiet proud of it
because it got better than I though. Now it also have such nice things like a
Rexx-Port and the code is really clean now and can be improved much easier than
the one of DirScanner 1.@{par}
@{line}
	I hope that you will like it too and if you do so, than send me a mail
please. If you don't, send me a mail anyway with the points you don't like
on DirScanner and I'll try to improve it that he fits also your needs. The
development of DirScanner still depends on @{b}you@{ub}!
@endnode

@node copy "DirScanner - Distribution"
@{line}
	@{fg shine}@{b}Distribution@{ub}@{fg text}@{line}
@{line}
	DirScanner and all it's related files are Copyright © 1998 - 2000 Hynek
Schlawack, All Rights Reserved. No file may be altered or distributed without
the rest of the archive. The whole archive may be freely distributed as long no
included file has been altered. If you think that something should be corrected
then contact me.@{par}
@{line}
	The archive is brought to you "AS IS" without any warranty for
functionality and the author denies all responsibilities for any damage made by
a part of the archive.@{par}
@{line}
	If you would like to include DirScanner on a disk or a CD of a magazin, you
have to ask for my permission. My permission is granted for Stefan Ossowski and
his AMINET-CDs, everyone else has to ask.
@{line}
	DirScanner may be freely used but if you think that it is really useful
than consider to write me a mail and as DirScanner is @{b}mailware@{ub} and it
is immoral to use it without sending @{"me" link support} a e-mail, postcard or
a letter.@{par}

@endnode

@node support "DirScanner - Support"
@{line}
	@{fg shine}@{b}Support@{ub}@{fg text} @{line}
@{line}
	If you have any questions or suggestions then don't hesiate to contact
me:@{par}
@{line}
	@{b}E-Mail:@{ub}@{line}
	  hynek.s@web.de@{line}
@{line}
	@{b}Snail-Mail:@{ub}@{line}
	  Hynek Schlawack@{line}
	  Röländer Str. 40@{line}
	  13125 Berlin@{line}
	  Germany@{line}
@{line}
	You may write in German, Czech and English.@{par}
@{line}
	@{b}WWW:@{ub}@{line}
	  http://me.in-berlin.de/~hys@{line}
@{line}
	@{b}Mailinglist:@{ub}@{line}
	  DirScanner-List-subscribe@onelist.com

@{line}
	I suggest to everyone who uses DirScanner frequently to subscribe to
the mailinglist because I will announce all updates there and not all updates
will be released in the AMINET!
@endnode

@node req "DirScanner - Requirements"
@{line}
	@{b}@{fg shine}Requirements@{fg text}@{ub}@{line}
@{line}
	DirScanner should work with a MC68020 CPU and OS3.0. The GUI needs the
MagicUserInterface (© Stefan Stuntz) therefore version 3.8 and NList(view) has
to be installed. @{par}
@{line}
	Please note that all system libraries has to be at least V39 (OS
3.0)!@{par}
@endnode

@node install "DirScanner - Install"
@{line}
	@{b}@{fg shine}Install@{fg text}@{ub}@{line}
@{line}
	Copy this guide to HELP:english/, the catalogs to PROGDIR:Catalogs/ or 
LOCALE:Catalogs/ and the binary wherever you want.@{par}

	You can of course also use the included install script.

@endnode

@node start "DirScanner - Invocation"
@{line}
	@{fg shine}@{b}Invocation@{ub}@{fg text}@{line}
@{line}
	When starting DirScanner from the shell, you may supply it with some
arguments, the complete template of DirScanner is: "PAT=PATTERN/K,PATHS/M".
Thus, all arguments are treated as paths exept the one starting with "PAT " or
"PAT=". I haven't implemented any arguments when starting from the workbench
because I don't think that it is useful.@{par}

@endnode

@node conf "DirScanner - Configuration"
@{line}
	@{fg shine}@{b}Configuration@{ub}@{fg text}@{line}
@{line}

	Actually only the viewer can be configured by setting the enviroment
variable DS_Viewer (eg. by "Setenv DS_Viewer SYS:Utilities/Visage").@{par}
@{line}
	@{b}Important:@{ub} Don't enclose any options in the string!@{par}
@{line}
Note: If you have used DirScanner 1.x before you should have a look in your
ENVARC: directory and eventually delete DS_Version.@{par}

@endnode

@node mwin "DirScanner - Main Window"
@{line}
	@{fg shine}@{b}Main Window@{ub}@{fg text}@{line}
@{line}
	The main window may be divided into three parts. One contains a list of the
paths that have to be scanned. It contains a listview and two gadgets, one to
add paths and an another to remove them. It is also possible to drop paths over
the listview. If you drop a file, it's path will be added.@{par}
@{line}
	An another contains the pattern and the searching conditions. You may
search by name, by size, by comment and by date. When searching by name and
comment you may only to use the conditions "equal" and "unequal". The only
thing I think that I have to say is the format of the date. You have to use the
DOS type of date. eg. 25-03-00.@{par}
@{line}
	The last one contains a listview with all matches and a toolbar below of
it. If you double-click an entry it is the same as if you click on "View", thus
the viewer get started. If you click on "Path -> Clip", the match with its whole
path gets copied into the clipboard. The final gadget is "Copy To..." which
enables you to copy the selected match to an another place (an asl-request will
ask for the new path).@{par}

@endnode

@node menus "DirScanner - Menus"
@{line}
	@{fg shine}@{b}Menus@{ub}@{fg text}@{line}
@{line}
	There is actually only one menu containing the following items:@{line}
@{line}
	· About (RAMIGA - ?) - Pops up the about requester.@{line}
	· About MUI - Pops up the MUI about requester.@{line}
	· MUI prefs... (RAMIGA - M) - Pops up the MUI preferences for DirScanner.@{line}
	· Iconify (RAMIGA - I) - Iconifies DirScanner.@{line}
	· Quit (RAMIGA - Q) - Quits DirScanner.@{line}

@endnode

@node rexx "DirScanner - Rexx"

@{line}
	@{fg shine}@{b}Rexx@{ub}@{fg text}@{line}
@{line}
	Version 2 of DirScanner introduced an extensive Rexx port which enables
many possibilities. He consists of the following commands:@{par}
@{line}
	@{"GET" link rx_get}@{line}
	@{"SET" link rx_set}@{line}
	@{"TOGGLE" link rx_toggle}@{line}
@{line}
	@{"ABOUT" link rx_about}@{line}
	@{"REQUESTER" link rx_req}@{line}
	@{"START" link rx_start}@{line}
@{line}
	@{"ADDPATH" link rx_addp}@{line}
	@{"CLEARPATHS" link rx_clearp}@{line}
	@{"DELPATH" link rx_delp}@{line}
@{line}
	@{"CLIP" link rx_clip}@{line}
	@{"COPY" link rx_copy}@{line}
	@{"VIEW" link rx_view}@{line}
@endnode

@node rx_get "DirScanner - GET"
@{line}
	@{fg shine}@{b}GET@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A@{line}
@{line}
	Gets an attribute and returns it in the "result" variable. The possible
attributes are:@{par}
@{line}
	· PATTERN - The pattern (string).@{line}
	· ACT_MATCH - The active match (integer).@{line}
	· MATCH_AMM - The ammount of matches (integer).@{line}
	· MATCH_FILE - The full path of the current match (string).@{line}
	· ACT_PATH - The active path (-1 if none selected) (integer).@{line}
	· PATH_AMM - The ammount of paths (integer).@{line}
	· PATH - The active path (string).@{line}
	· MODE - The mode (Search By:) (string).@{line}
	· CONDITION - The Condition (string).@{line}
	· ICONIFY - Is DirScanner iconified (boolean)?@{line}

@endnode

@node rx_set "DirScanner - SET"
@{line}
	@{fg shine}@{b}SET@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A,VAL/A@{line}
@{line}
	Sets an attribute. The possible attributes are:@{par}
@{line}
	· PATTERN - The pattern (string).@{line}
	· ACT_MATCH - The active match (integer).@{line}
	· ACT_PATH - The active path (integer).@{line}
	· MODE - The mode, please use the english Search By-Strings for it.@{line}
	· CONDITION - The condition, please use the english Mode-Strings for it.@{line}
	· ICONIFY - Iconify or uniconify DirScanner (boolean).
@endnode

@node rx_toggle "DirScanner - TOGGLE"
@{line}
	@{fg shine}@{b}TOGGLE@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} WHAT/A,HOW@{line}
@{line}
	Toggles an attribute. The possible attributes are:@{par}
@{line}
	· MATCH_CURS - Move the cursor in the matches listview ("UP" or "DOWN").@{line}
	· PATH_CURS - Move the cursor in the paths listview ("UP" or "DOWN").@{line}
	· MODE - Set the "NEXT" or "PREV" mode.@{line}
	· CONDITION - Set the "NEXT" or "PREV" condition.@{line}
	· ICONIFY - Iconify or uniconify. No "how" supported.@{line}
@endnode

@node rx_about "DirScanner - ABOUT"
@{line}
	@{fg shine}@{b}ABOUT@{ub}@{fg text}@{line}
@{line}
	Pops up the about requester.@{par}
@endnode

@node rx_req "DirScanner - REQUESTER"
@{line}
	@{fg shine}@{b}REQUESTER@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} TEXT/A@{line}
@{line}
	Pops up a requester with the specified text.@{par}
@endnode

@node rx_start "DirScanner - START"
@{line}
	@{fg shine}@{b}START@{ub}@{fg text}@{line}
@{line}
	Starts the scan.@{par}
@endnode

@node rx_addp "DirScanner - ADDPATH"
@{line}
	@{fg shine}@{b}ADDPATH@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} PATH@{line}
@{line}
	Adds a path. If no path is specified an asl-requester will ask for
him.@{par}
@endnode

@node rx_clearp "DirScanner - CLEARPATHS"
@{line}
	@{fg shine}@{b}CLEARPATHS@{ub}@{fg text}@{line}
@{line}
	Clears the list of paths.@{par}
@endnode

@node rx_delp "DirScanner - DELPATH"
@{line}
	@{fg shine}@{b}DELPATH@{ub}@{fg text}@{line}
@{line}
	Removes the active path from the list.@{par}
@endnode

@node rx_clip "DirScanner - CLIP"
@{line}
	@{fg shine}@{b}CLIP@{ub}@{fg text}@{line}
@{line}
	Puts the path of the active match in the clipboard.@{par}
@endnode

@node rx_copy "DirScanner - COPY"
@{line}
	@{fg shine}@{b}COPY@{ub}@{fg text}@{line}
@{line}
	@{b}Template:@{ub} TO@{line}
@{line}
	Copies the active match either to "TO" or pops up an asl requester for
determinating the destination.@{par}
@endnode

@node rx_view "DirScanner - VIEW"
@{line}
	@{fg shine}@{b}VIEW@{ub}@{fg text}@{line}
@{line}
	Views the active match.@{par}

@endnode

@node credits "DirScanner - Credits"
@{line}
	@{fg shine}@{b}Credits@{ub}@{fg text}@{line}
@{line}
	DirScanner 2 was written using "CygnusED 3.5" and compiled with "DICE
3.16". The binary has been processed with "Hunk" from Thomas Richter. I'm
looking forward to use SAS/C and CygnusEd 4 soon.@{par}
@{line}
	I would like to thank all people who have supported me with their kind
mails and ideas. DirScanner 2 wouldn't exist without you!@{par}
@{line}
	I would also like to thank @{b}Nils Bandener @{ub}who helped me to get into
implementing Rexx ports (although it's much easier under MUI...). The next I
would like to thank is @{b}Nils Görs @{ub}who helped me to make a useful Rexx port as
possible and who is still supporting me concerning Rexx and also with
bugreports. A another person who is sending bugreports to me without getting
tired is @{b}Bill Duxbury@{ub}. He was also the first one who contacted me when I
started to develop DirScanner again. The last person I wuld like to thank is
Eric Gerard who designed the nice icons for me.@{par}
@{line}
	@{b}Translations:@{ub}@{line}
	  · deutsch - Hynek Schlawack@{line}
	  · italiano - Luca 'Hexaae' Longone@{line}
@{line}
	Other translations are strongly welcome!@{line}
@endnode