home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / misc / findfile.lha / FindFile / FindFile.doc < prev    next >
Encoding:
Text File  |  1992-11-05  |  5.8 KB  |  142 lines
  1. ******************************************************************************
  2. *                                 FindFile                                   *
  3. *                         an AmigaDOS 2.04 Commodity                         *
  4. *                                                                            *
  5. *                 Code Developed & Written By: Russ Steffen                  *
  6. ******************************************************************************
  7.  
  8. I. Introduction
  9.  
  10.    FindFile is an AmigaDOS 2.04 Commodity modeled after the "Find File"
  11.    Desk Accessory on the Macintosh. It will search any AmigaDOS volume for
  12.    all files that match a given pattern.
  13.  
  14.  
  15.    FindFile requires only AmigaDOS 2.04 (V37), and will not work under under
  16.    earlier AmigaDOS 2.0 releases, such as 2.02.
  17.  
  18.  
  19. II. Supported ToolTypes
  20.  
  21.   As a commodity, FindFile supports all aplicable standard ToolTypes, plus
  22.   some custom ToolTypes.
  23.  
  24.  
  25.     CX_POPUP              If YES, FindFile's window will open
  26.                           at startup.
  27.                           Default: NO
  28.  
  29.  
  30.     CX_PRIORITY           Sets FindFile's commodity priority.
  31.                           Default: 0
  32.  
  33.     CX_POPKEY             Sets FindFile's hot key. Pressing this key
  34.                           will either open the window, or bring it to
  35.                           the front.
  36.                           Default: "LCommand help"
  37.  
  38.     DEF_PATTERN           Sets FindFile's default search pattern.
  39.                           Default: #? (Matches all files)
  40.  
  41.  
  42.     CENTERWINDOW          Controls FindFile's window behavior when it
  43.                           is opened.
  44.                             YES causes the window to be centered on the mouse
  45.                                 every time it is opened.
  46.                             NO  causes the window to be mouse centered only on
  47.                                 the first opening. After that, the window will
  48.                                 remember it's position when it closes, and will
  49.                                 reopen at that position.
  50.                           Default: YES
  51.  
  52.  
  53.     IGNOREICONS           If YES, FindFile will skip all .info files it encounters.
  54.                           Default: NO
  55.  
  56.  
  57.     SORTLIST              If YES, the list of files that FindFile finds will
  58.                           be sorted alphabetically.
  59.  
  60.  
  61.     Please note: All tooltypes may be given as either true ToolTypes in FindFile's
  62.                  icon, or as command line parameters. If given as CLI parameters,
  63.                  ToolTypes with spaces in them should be enclosed in quotes.
  64.                  ( e.g. "DEF_PATTERN=#? #?" matches any files with a space in the
  65.                    name. )
  66.  
  67.  
  68. III. Window Operation
  69.  
  70.   The FindFile Window contains the following gadgets:
  71.  
  72.   Search Pattern:  A string gadget where the AmigaDOS pattern to search is entered.
  73.                    The default value is controlled by the DEF_PATTERN ToolType.
  74.                    Keyboard Eqiv: P
  75.  
  76.  
  77.   Device to Search:  A cycle gadgets that lists all the volumes mounted on the
  78.                      system. The default is the first volume it encounters in
  79.                      the system device list, usually it's the last volume inserted.
  80.                      Keyboard Eqiv: D
  81.  
  82.  
  83.   Files Found: A ListView gadget that will contain a list of found files during and
  84.                after the actual search. Clicking on a file in this gadget will cause
  85.                the Path gadget to display this file's path.
  86.                Keyboard Eqiv: F
  87.  
  88.   Path: A ListView gadget that shows the path the current file. The topmost entry
  89.         is the volume name, and the subsequent entries comprise the path.
  90.         Keyboard Eqiv: [none]
  91.  
  92.  
  93.   Search: This button will initiate a search. The search may be aborted by
  94.           the Quit button, described later on.
  95.           Keyboard Eqiv: S
  96.  
  97.   Hide: This button will cause FindFile to hide it's window. The window can be
  98.         reopened by pressing the program's hot key, wich defaults to Left-Command HELP.
  99.         Keyboard Eqiv: H
  100.  
  101.   Quit: This is a dual purpose button. When FindFile is searching for files, this
  102.         button will abort the search. Otherwise, this will terminate the program.
  103.  
  104. IV. COPYRIGHT & DISCLAIMER
  105.  
  106.   This program is copyrighted by the author. Permission is granted for private use.
  107.   This program is also freely redistributable, and encouraged, provided that the
  108.   following criteria are met. 1) The complete program package must remain intact. The
  109.   complete program package consists of (A) The binary executable {FindFile} (B) The
  110.   C-Language source code {FindFile.c & .h} (C) This documentation file {FindFile.doc}
  111.   (D) Any addendums and readme-type files that may become nessary on future revisions.
  112.  
  113.   This program is distributed in the hope that it will be useful, but WITHOUT
  114.   ANY WARRANTY; without even the IMPLIED warranty of MERCHANTIBILTY or FITNESS
  115.   FOR A PARTICULAR PURPOSE.
  116.  
  117.   The author may not be held responsible by any damage caused by the use or misuse
  118.   of this program. This program is distributed as-is, and can not be guaranteed to
  119.   work under all conditions & circumstances. Use this program at your own risk.
  120.  
  121. V. Author's Information
  122.  
  123.   Name:            Russell R. Steffen
  124.   Home Address:    11551 Sherman Rd.
  125.                    Cedarburg, WI 53012     (Permanent)
  126.  
  127.   School Address:  318 Callahan Hall
  128.                    Menomonie, WI 54751      (Valid until May, 1993)
  129.  
  130.   Email:           STEFFENR@UWSTOUT.EDU
  131.  
  132. VI. CREDITS
  133.  
  134.   Thanks to the authors of the Amiga Techincal Reference Series at Commodore. Thanks
  135.   also to the author of FracBlank, Olaf 'Olsen' Barthel, who's code showed me how
  136.   to center a window on the mouse pointer.
  137.  
  138.   Also, thanks to the members of the Dead Moose Society ( Erik, Emmy, Dick,
  139.   Shawn, Sara, Spike & Max ), whose many diversions kept my sanity in check this
  140.   summer. ( Beware of lurking rangers, guys! )
  141.  
  142.