@DATABASE SimpleFind_English.guide
@$VER: SimpleFind_English.guide 1.5 (21.07.97)
@Author Sebastian Bauer
@(C) ©1997

@NODE main "SimpleFind Documentation"
@SMARTWRAP
@{b}SimpeFind 1.5 @{AMIGAGUIDE}@{ub}


Note that the authors native language is german, so please forgive
bad spelling, grammar mistakes and so on (I know that there are many). Or better - correct them
and @{" contact " link SB } me.

Attention! This guide is designed for the version 40 of the
amigaguide.datatype which is supplied with AmigaOS 3.1. Under other
versions this guide may look very terrible.
@{CODE}

@{" Copyright " link COPYRIGHT}              Copyright and disclamer
@{" Introduction " link INTRO}           What is it ?
@{" Requirements " link REQUIRE}           What does it need ?
@{" Installation " link INSTALL}           How to install ?
@{" Usage " link USAGE}                  How to use ?
@{" Future " link FUTURE }                 What is comeing next ?
@{" History " link HISTORY }                What has be done ?
@{" Author " link SB }                 Where to send bug reports ?
@ENDNODE

@NODE COPYRIGHT "Copyright and disclamer"
@SMARTWRAP
@{b}Copyright@{ub}


(c) Copyright 1997 @{" Sebastian Bauer " link SB }


SimpleFind is Freeware. You can give it to anybody you want as long as
all the files are complete and in a unchanged form. You also aren't
allowed to make any profit with it.


@{b}Standard Disclamer@{ub}


THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE
COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.


IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE
PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS
OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.

@ENDNODE

@NODE INTRO "Introduction"
@SMARTWRAP
@{b}Introdution@{ub}


SimpleFind is a Search-Tool for your Amiga. It scans a selected
directory for a entered name pattern and shows them. You can
copy, delete, rename or view this files.

@{CODE}
Features
  - allows searching by name and comments (AmigaOS-Patterns), size, date
  - Indexfiles for faster searching
  - allows to copy, delete, view and rename
  - easy to use GadTools-GUI
  - shell support
  - and much more
@{BODY}

I know that there are some good tools there, but the some of them use MUI
and other have no GUI.
I want to have one which has an easy to use GUI and which doesn't need MUI.
(but this means not that I'm against MUI. It is very powerful and helps
developers by createing there software, for example without MUI some good WWW-Browser
wouldn't exists).

One other reason was that I want to test my programing knowledge (this is my first 'real'
program)
@ENDNODE

@NODE REQUIRE "Requirements"
@SMARTWRAP
@{b}Requirements@{ub}


SimpleFind needs at least Kickstart 3.0. It should work with a MC68000
processor but this is not recommended.
@ENDNODE

@NODE INSTALL "Installation of SimpleFind"
@SMARTWRAP
@{b}How to install SimpleFind@{ub}


Currently there is no installer script. To install SimpleFind simply copy the whole
drawer where you want.
@ENDNODE

@NODE USAGE "Usage"
@{b}Usage@{ub}

 @{b}Programmstart@{ub}

 @{" Shell " link SHELL }
 @{" Tooltypes " link TTYPES }

 @{b}GUI@{ub}

 @{" Menu " link MENU }
 @{" Main Window " link MAINWND }
 @{" Result Window " link RESULTWND }
@ENDNODE

@NODE SHELL "Shell"
@{b}Shell@{ub}

SimpleFind has a standart AmigaOS template. It looks like this:

 DIR/M,PAT=PATTERN/K,COM=COMMENT/K,MINSIZE/N/K,MAXSIZE/N/K,GUI/S,
 CASE/S,EXACT=EXACTPAT/S,EXACTCOM/S,NOSIZE/S,NODATES/S,LFORMAT/K,
 CI=CREATEINDEX/S,UPI=UPDATEINDEX/S,UI=USEINDEX/S,DI=DELETEINDEX/S,
 AI=AVAILABLEINDEXES/S,ALL=ALLINDEXES/S,ALLMOUNTEDVOLS/S,
 ID=INDEXDIR/K,IN=INDEXNAME/K
  
@{u}DIR/M@{uu}
 This defines the directories where to start searching.

@{u}PAT=PATTERN/K@{uu}
 The search-pattern. (AmigaOS-Style)

@{u}COMMENT/K@{uu}
 The comment-pattern. (AmigaOS-Style)

@{u}MINSIZE/N@{uu}
 The minimum size (in 1024 Bytes}

@{u}MAXSIZE/N@{uu}
 The maximum size (in 1024 Bytes}

@{u}GUI/S@{uu}
 Only if you specify this, SimpleFind will show its GUI.

@{u}CASE/S@{uu}
 SimpleFind takes care of the case of the filenames.

@{u}EXACT=EXACTPAT/S@{uu}
 SimpleFind don't add a #? at the beginning and at the
 end of the pattern.

@{u}EXACTCOM/S@{uu}
 SimpleFind don't add a #? at the beginning and at the
 end of the comment-pattern.

@{u}NODATES/S@{uu}
 Don't show the files' dates.

@{u}NOSIZE/S@{uu}
 Don't show the files' sizes.

@{u}LFORMAT/K@{uu}
 Defines the output-format of SimpleFind.

   %d ....... The last changed date of the founded file
   %f, %p ... The path of the file (with '/')
   %n ....... The filename
   %s ....... The size (in Bytes) of the file
   %w ....... The path of the file (without '/')
   %c ....... The comment of the file

 To reserve some spaces just add positive integer after '%'
 for right justification and a negative integer for left
 juat the folowed integer is thetificationthe. A Point '.'
 between '%' and the integer means that the followed integer
 is the limit of the string.

 Defaults to "%-25n %8l %d %w"

@{u}CI=CREATEINDEX/S@{uu}
 SimpleFind creates an Indexfile for the given directory.

@{u}UPI=UPDATEINDEX/S@{uu}
 SimpleFind updates an Indexfile. When the Indexfile doesn't
 exist it creates a new one.

@{u}UI=USEINDEX/S@{uu}
 SimpleFind uses the Indexfile if it is available.

@{u}UI=USEINDEX/S@{uu}
 SimpleFind deletes the Indexfile..

@{u}AI=AVAILABLEINDEXES/S@{uu}
 SimpleFind shows available Indexfiles in the IndexDir.

@{u}ALL=ALLINDEXES/S@{uu}
 When you specify this SimpleFind searches through all
 availabe Indexfiles. The DIR/M option is ignored.
 If you specify the UPDATEINDEX/S option SimpleFind
 will update all availabe Indexfiles.

@{u}ALLMOUNTEDVOLS/S@{u}
 SimpleFind searches throw all mounted volumes if they are
 available.

@{u}ID=INDEXDIR/K@{uu}
 Specifies the directory where to put the Indexfiles in.
 Default to PROGDIR:IndexFiles

@{u}IN=INDEXNAME/K@{uu}
 This is only necessary when you don't want that SimpleFind
 handles its Indexfiles automatically. Here you can specify
 the filename for useing a Indexfile.

@ENDNODE

@NODE TTYPES "ToolTypes"
@{b}Tool Types@{ub}

Currently there is only one ToolType

@{u}PREFSFILE@{uu}

Here you can specify the path and the name of prefs
file which is created when you select @{" SaveSettings " link MENU} in the @{" menu " link MENU}.

(Default PROGDIR:SimpleFind.prefs)

@ENDNODE

@NODE MENU "Menu"
@{CODE}@{b}Menu@{ub}

Project    @{tab}Indexfiles      @{tab}  Settings
@{"About...  ?" link "MENU" 21 }@{tab}@{"Create Indexfile...    " link MENU 30}@{tab}  @{"  Case sensitive?  C " link MENU 58}
-----------@{tab}@{"Update Indexfile...    " link MENU 36}@{tab}  @{"  Exact?           E " link MENU 62 }
@{"Quit      Q" link "MENU" 25 } @{tab}-----------------------@{tab}  @{"  Exact Comment?     " link MENU 66}
           @{tab}@{"Available Indexfiles..." link MENU 40}@{tab}  @{"  Use Indexfiles?    " link MENU 66}
           @{tab}@{"Delete Indexfile...    " link MENU 43}@{tab}  ---------------------
           @{tab}-----------------------@{tab}  @{"Sort By            » " link MENU 73}
           @{tab}@{"Recreate all Indexfiles" link MENU 47}@{tab}  ---------------------
           @{tab}@{"Update all Indexfiles  " link MENU 50}@{tab}  @{"Select Viewer...   V " link MENU 83}
           @{tab}@{"Delete all Indexfiles  " link MENU 53}@{tab}  @{"Select Indexdir...   " link MENU 88}
           @{tab}                      @{tab}  @{"Output Format...     " link MENU 92}
           @{tab}                      @{tab}  ---------------------
           @{tab}                      @{tab}  @{"Save Settings      S " link MENU 104}



@{B}The 'Project' Menu@{UB}

 @{U}About ?@{UU}
  Shows information about SimpleFind and its Author (hey
 that's me).

 @{U}Quit Q@{UU}
  Quits the program.

@{B}The 'Indexfiles' Menu@{UB}

 @{u}Create Indexfile...@{uu}
  Here you can create a new IndexFile for an specified
 directory. When this indexfile already exists a requester
 is shown where you an select between create, update or
 cancel.

 @{u}Update Indexfile...@{uu}
  This brings up a requester where you can select the
 indexfile which should be updated.

 @{u}Available Indexfiles...@{uu}
  Here you can see the available Indexfiles.

 @{u}Delete Indexfile...@{uu}
  This brings up a requester where you can select the
 indexfile which should be deleted.

 @{u}Recreate all Indexfiles@{uu}
  Creates all indexfiles completly new.

 @{u}Update all Indexfiles@{uu}
  Updates all Indexfiles.

 @{u}Delete all Indexfiles@{uu}
  Deletes all Indexfiles.

@{B}The 'Settings' Menu@{UB}

 @{U}Case sensitive?  C@{UU}
  If this option is checked, SimpleFind takes care of the
 case of the filenames.

 @{U}Exact?  E@{UU}
  If it is checked, SimpleFind looks doesn't add a '#?' on
 left and right side of the pattern..

 @{u}Exact Comment?@{uu}
  Same like @{"Exact" link MENU 58}, but for Comments.

 @{U}Use Indexfiles?@{UU}
  Only if this option in checked SimpleFind will use
 Indexfiles, if available.

 @{u}Sort By@{uu}
  You can choose beween following sort modes.

   No Sorting
   Complete Filename
   Filename
   Comment
   Date (the latest first)
   Size (the smallest first)

 @{U}Select Viewer...  V@{UU}
  This opens a window where you an specify your prefered
 viewer. %s is replaced by the selected file name, otherwise
 the name is added at the end of the line.

 @{U}Select IndexDir...@{UU}
  This will open an asl requester where you can specify the
 directory for the indexfiles (Default to PROGDIR:Indexfiles)

 @{U}Output Format...@{uu}
  Here you can choose the output format in the @{"Resultwindow" link RESULTWND}.

   %d ....... The last changed date of the founded file
   %p ....... The path of the file
   %n ....... The filename
   %p%n ..... The complete filename
   %s ....... The size (in Bytes) of the file
   %c ....... The comment of the file

  A '-' after '%' means left adjustment.

 @{U}Save Settings  S@{UU}
  Save the settings you have made.






































@ENDNODE

@NODE MAINWND "Main Window"
@{b}Main Window@{ub}

  The Main window is the window where you specify the
 criteries of a searching process. Following gadgets
 or gadgetgroups you can find in this window.

 @{b}The 'Search options' group@{ub}

  @{u}Search Path@{uu}
   Path where SimpleFind start its search. You can
  enter this path by keyboard or by clicking the button («)
  right to the string gadget which brings up a
  filerequester. Multiple path are separated by '|'.
   Clicking on 'All' defines a multiple path for all
  available Indexfiles when @{" Use Indexfiles? " link MENU 74} is selected.
  Otherwise it defines a multiple path for all mounted
  Volumes.
   The path(s) you entered here are saved when you select
  @{"Save Settings" link MENU 95 }, too.

  @{u}Pattern@{uu}
   Standard AmigaOS Pattern.

 @{b}The 'Advanced options' group@{ub}

  @{u}Comment@{uu}
   If you want to search for comments you can activate this
  option (Standart AmigaOS Pattern).

  @{u}Min Size(kb)@{uu}
   When the Checkbox is checked you can specify the minimum
  size in kbytes (1024 bytes)

  @{u}Max Size(kb)@{uu}
   When this option is checked you can specify the maximum
  size in kbytes (1024 bytes).

  @{u}Within the last@{uu}
   Here you can specify how many days/month ago (maximal) a
  file should have been created/changed.

 @{u}Start Search@{uu}
  This will start the scanning process. The results are
 shown in the @{" Result Window " link RESULTWND }. While searching
 breaking is possible with 'Esc'.

@ENDNODE

@NODE RESULTWND "Result Window"
@{b}Result Window@{ub}

 Here you see a listview which shows the found files.
Simply select a file by clicking on its name. When you
enter a new name in the string gadget the file will be
renamed to this name. Below this gadget you will find
a further string gadget. Here you can enter a AmigaOS-
Pattern, which defined the viewed files.
 You will find following other gadgets here.

@{u}Show@{uu}

 When you click this button the actual selected file will
be shown via MultiView (or the defined viewer).

@{u}Copy@{uu}

 Here you can copy the seleted file. It brings up an
asl-requester where you an select a destination.

@{u}Delete@{uu}

 This will delete the selected file from disk, after
you have agreed it in a requester.
@ENDNODE

@NODE FUTURE "Future"
@PREV USAGE
@SMARTWRAP
@{b}Future@{ub}


I plan to add following features:
@{CODE}
  - work with Kickstart 2.0 if wanted
  - a seperate shell version ?
  - more buttons
  - a better guide (also an german version) and fewer mistakes
  - maybe an installer script
  - any other suggentions if I think they are good (for example
    I will not add a racing game or a function plotter ;-) )
@ENDNODE

@NODE HISTORY "History"
@SMARTWRAP
@{b}History@{ub}


And now the very long history of SimpleFind:
@{CODE}

  @{b}Version 1.0 (06.04.97)@{ub}
    - first Aminet release

  @{b}Version 1.1 (21.04.97)@{ub}
    - Oops, SimpleFind frees its memory twice.
      This is fixed now (I hope)
    - Now can use Indexfiles to speed up searching

  @{b}Version 1.2 (22.06.97)@{ub}
    - Some bugs in "Update Indexfile" fixed
      (still not perfect)
    - Nicer GUI
    - Shell Support

  @{b}Version 1.3 (30.06.97)@{ub}
    - More shell commands (suggested by Jørn Ove Nilsen)
    - Some internal changes

  @{b}Version 1.4 (09.07.97)@{ub}
    - Added LFORMAT CLI-Option
    - New CLI standart output format
    - Added a possiblity to search through all indexfiles
      (suggested by Jørn Ove Nilsen)
    - Added break possibility in the GUI part with 'Esc'

  @{b}Version 1.5 (21.07.97)@{ub}
    - Added possibility to search for comments
      (suggested by Robert Taje)
    - Now the Outputformat of the Resultwindow is configurable
    - Sorting is possible now by filename, date, size,
      comments and complete filename
    - added View Pattern for filenames in the Resultwindow
    - Changed function of the 'All' Button a little bit and
      added ALLMOUNTEDVOLUMES/S CLI-Option
      Now it is easier to search throw all mounted Volumes
      (suggested by Rick Adams)

@ENDNODE

@NODE SB "How can you reach me ?"
@{b}Author@{ub}


@SMARTWRAP
This is the sixth release of SimpleFind. But there can still be many bugs!
If you find
some bugs (also in this guide) or have suggestions to
improve SimpleFind, you should contact me.

I would be pleased, if you could send me a really good Icon for SimpleFind.
(I know my one is ugly but I'm a doc, aeh program(m)er not an artist...)

Also feel free to send me harddisks, gfxcards, disks, CDs or
money ;-)
@{CODE}

Address:
   Sebastian Bauer
   Neustädter Str. 45
   07768 Kahla
   Germany

You can also contact me via E-Mail:
   sebauer@t-online.de

@{BODY}
I have an homepage in the WWW, too. It is currently in german only
and in a very early state. But you will find the latest version of SimpleFind
and also other projects for Amiga there.
@{CODE}

   http://home.t-online.de/home/sebauer/

@ENDNODE