home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / f / finder / !Finder / !Help < prev    next >
Encoding:
Text File  |  1995-03-27  |  13.9 KB  |  299 lines

  1. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  2. +                        !Help for !Finder v 1.1                           +
  3. +                       Copyright Chris Nelson 1995.                       +
  4. +                                                                          +
  5. +     A file search utility similar to the file manager search option in   +
  6. +                                                                          +
  7. +                               Windows 3.1                                +
  8. +                                                                            +    
  9. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  10.  
  11.  
  12. Thank you for acquiring !Finder.  This program is Freeware, and may be
  13. freely distribtuted provided all files are kept together and my authorship is
  14. acknowledged.  No fee may be charged for this software, except to cover
  15. reasonable distribution costs. Use of the software is at your own risk, and I
  16. take no responsibility for any damage or loss caused by its use.
  17.  
  18. You should have received the following files:
  19.  
  20. !Boot
  21. !Run
  22. !Runimage
  23. !Sprites
  24. !Sprites22
  25. Templates
  26. !Help
  27.  
  28.  
  29.  
  30. Brief Overview:
  31. !Finder is a multi-taking file search utility which takes a (wild-carded)
  32. file name and/or a file type specification and searches a user specified
  33. directory for matches.  Options include recursive searches, case sensitivity
  34. and automatic directory opening.
  35.  
  36. Running !Finder
  37. ======= =======
  38. To install !Finder on the icon bar, double click on its icon as usual. In a
  39. few seconds, the Finder icon will appear.
  40.  
  41. Using !Finder to find files
  42. ===== ======= == ==== =====
  43. Click with the middle (menu) button on the icon bar icon, and a simple three
  44. entry menu will appear. Besides the usual 'Info' and 'Quit' options is the
  45. 'Find' option. Select this and a dialogue box pops up. Alternatively, clicking
  46. with the select button opens the dialog box immediately. There are three text
  47. fields to specify, namely 'Filename', 'File Type' and 'Start Directory'. The
  48. first and third of these are set up with an asterisk '*' and a dollar '$'
  49. respectively. Each field/option is now described in detail:
  50.  
  51. Filename
  52. ========
  53. Searches are wild-carded using the normal '*' and '#' characters. '*' means
  54. match with any number of characters, or none. '#' matches any single
  55. character. All other characters will be searched for explicitly, though only
  56. characters acceptable to the filer can be entered. You can type as many
  57. '*'s and '#'s as you like in the filename eg.
  58.  
  59. 'a##*s' would match 'arts', 'articles' or 'aspidistras', but not 'abs', you
  60. could also type 'a#*#s' and get the same effect. Even quite tricky searches
  61. like 'b*art#' would find a file named 'bart_carts', but reject 'blart_cart'
  62. etc.
  63.  
  64.  
  65. File Type
  66. ==== ====
  67. This field can be used to enter a file type, either as a textual reference,
  68. 'Command', 'Text' etc, or by using the hexadecimal file type i.e. '&fff', or
  69. even just 'fff'. Only files matching the file type will be listed.
  70.  
  71. You can enter something in both the 'Filename' and 'File Type' field, or in
  72. just one of them. If you do not enter anything in either, (i.e. you delete
  73. the '*' in the 'Filename' box and press 'Start', an error box appears.
  74.  
  75. Note, that to simplify entering a file type, if you are not sure what name
  76. has been given a specific file type, just drag a file of the relevant type
  77. from a filer window into the 'File Type' entry box, and the file's type will
  78. appear automatically.
  79.  
  80.  
  81. Start Directory
  82. ===== =========
  83. This defaults to the root directory of the current drive, i.e. '$'. You can
  84. enter any valid directory on any valid filing system. For some reason, 
  85. !Finder has problems with the Resources filing system on the RISC PC, I
  86. suspect it is because this system is not a true filing system, but actually
  87. represents part of the hard disc drive, IDEDisc4.
  88.  
  89. Like the 'File Type', if you drag a file or directory to the 'Start
  90. Directory' entry box, the directory which contains that file/directory is
  91. automatically entered for you.
  92.  
  93.  
  94. There are three options which may be selected and deselected by clicking the
  95. appropriate click box. A tick, or cross indicates that the option is
  96. selected:
  97.  
  98. Case Sensitive
  99. ==== =========
  100. Searches for filenames are carried out case sensitively, this is probably
  101. not entirely useful, but was easy to code! Perhaps if someone wants to port
  102. !Finder to unix...
  103.  
  104. Recurse
  105. =======
  106. If selected, searches are made of all subdirectories below the 'Start
  107. Directory', as well as the 'Start Directory' itself of course.
  108.  
  109. Open Directory
  110. ==== =========
  111. Sometimes when you are searching for a fairly small number of files, it will
  112. be useful to open the filer directory containing the files automatically.
  113. Selecting this option causes !Finder to open each directory that contains a
  114. file matching the search criteria as soon as it is found.
  115.  
  116.  
  117. The two remaining buttons are the 'Cancel' and 'Start' buttons. Pressing
  118. 'Start' starts the search, pressing 'Cancel' before pressing 'Start' cancels
  119. the search before it starts(!) and closes the dialogue box, clicking on the
  120. dialog box's close icon also does this. Once a search has begun, pressing
  121. 'Cancel' stops the search, closes the dialog box, but leaves the result of
  122. the interrupted search on display in the file information window.
  123.  
  124.  
  125. The 'Status' icon at the bottom of the dialog box is used to inform the
  126. user of the progress of the search. It displays the directory being searched
  127. and each file found matching the search criteria.
  128.  
  129.  
  130. File Information Window
  131. ==== =========== ======
  132. This window opens automatically as soon as a file matching the search
  133. criteria has been found. It contains a list of all the files found in a
  134. format similar to the Filer when in full info mode. The title of the window
  135. is the 'Start Directory' selected when the search began. In the window
  136. itself are displayed the following from left to right:
  137.  
  138. A sprite suitable for the objects type, this may be a directory or an
  139. applications sprite if appropriate.
  140.  
  141. The file name rooted in the 'Start Directory', i.e. the path shown here is
  142. using the 'Start Directory' as the current directory. This is indicated by
  143. the use of the '@' symbol. As an example, if the file entry is
  144. '@.downloads.hensa.misc.newsfile', and the 'Start Directory', and window
  145. title, is 'ADFS::IDEDisc4.$.internet', then the files full path name is:
  146. 'ADFS::IDEDisc4.$.internet.downloads.hensa.misc.newsfile'. Note that !Finder
  147. makes no assumption about the lengths of file names, and if you have
  148. !LongFiles by Jason Tribbeck, !Finder has no problems. One thing to note
  149. though, is that as !Finder retrieves files in the order they are stored in
  150. the directory, it will get file names greater than 10 characters in the
  151. wrong order. This is because !LongFiles renames a file to something like,
  152. '(C)JPT-###', where ### is a ID code, and stores the actual long file name
  153. in a hidden file. This means that all files that have the long names (>10)
  154. will appear in !Finder's window wherever '(C)JPT-###' would appear. This is
  155. not a problem, as !Finder does a full alphanumeric sort when it has finished
  156. the search, this uses !Finder's copy of the file name, and order is
  157. restored.
  158.  
  159. Next comes the read/write access in the same format as the filer window
  160. displays. I.e. WR/ means read/write access granted to you etc.
  161.  
  162. The file size comes next, again in a similar manner to the filer windows.
  163.  
  164. The file type in text where possible, else in hexadecimal.
  165.  
  166. Finally, the date/time of creation of the file is given.
  167.  
  168. Text is displayed in the 'Homerton.Medium' font by default. You can alter
  169. this by editing the !Run file for !Finder and altering the line that begins
  170.  
  171. *Set finder$font
  172.  
  173. i.e. to say:
  174.  
  175. *Set finder$font Trinity.bold
  176.  
  177. If the specified font is not found, !Finder will complain and adopt the
  178. system font. Font selection comes in a later version! Note that you can select
  179. to use the system font by editing the !Run file to say
  180.  
  181. *Set Finder$font System
  182.  
  183. instead of a fancy font; this avoids the font not found errors. Note that
  184. 'System' has to be typed as shown as the selection is case sensitive.
  185.  
  186. Files in the display window can be manipulated in several ways:
  187.  
  188. Double clicking on a file or application performs a filer_run. Double
  189. clicking on a directory opens the directory as usual. Holding down the shift
  190. key when double clicking on an application line, opens the directory just
  191. like the filer. Similarly, holding down the control key when opening a
  192. directory prevents the !Boot files of any applications within the directory
  193. from being run. Adjust clicking does not close the file display window, I
  194. do not think this is terribly useful personally, but if people particularly
  195. want it, this can be implemented.
  196.  
  197. Items can be selected by clicking once on their display line, using the
  198. select button clears any existing selected files, clicking with the adjust
  199. button adds files to the existing selection, if any. The adjust button can
  200. be used to toggle files in and out of the selected group. If you click and
  201. hold down either the select or adjust buttons when the mouse is somewhere
  202. between file lines, a simple drag box appears. Moving the mouse stretches
  203. the box like a rubber band. When the button is released, the files within
  204. the box alter their selection status as if they had been clicked individually
  205. with whichever button was held down during the drag. I.e. if the select
  206. button was being pressed, all files within the box are selected, all those
  207. outside are deselected. If the adjust button was being pressed, files within
  208. the box are toggled into or out of the selection depending on the previous
  209. status. Files outside the box are unaffected. Note that only the file name
  210. itself is highlighted when a file line is selected, even if the button was
  211. pressed anywhere else on the line.
  212.  
  213. Once a file or group of files have been selected, you can drag the
  214. files/directories into an application window, or to the icon bar. I.e. click
  215. and hold down the select or adjust button when over one of the selected
  216. files. An icon appears (RISC OS 3) or a square dashed line (RISC OS 2). If
  217. only one file is selected, the icon will be that appropriate to the file or
  218. application or directory. If several files are selected, the 'package' sprite
  219. is shown if this is defined, otherwise !finder's own multiple selection icon
  220. is used. In any event when the file/files are dragged to another applications
  221. icon or window, the application can load or insert the files as appropriate.
  222. The only exceptions are the filer windows. The filer uses a different
  223. mechanism for moving files around between filing systems and so, at the
  224. moment, attempts to drag files to filer windows are ignored. This may be
  225. implemented in a later version.
  226.  
  227.  
  228. Clicking the menu button opens the menu for the filer window. This has the
  229. five sort options available to the display. These are 'Path', 'Name', 'Type',
  230. 'Size' and 'Date'. The last three are fairly straightforward, the files
  231. are sorted into order of file type (alphanumeric), size and date/time
  232. respectively. 'Path' and 'Name' both sort the files according to their
  233. names. 'Path' uses the whole pathname for the file, 'Name' just uses the
  234. leaf name. This can be useful where several files share the same leaf name
  235. but are in different directories, like a C/C++ project for example. In order
  236. to make picking out the leaf names easier, when the 'Name' type sort is
  237. selected, the filenames are shown right-aligned within the file window.
  238.  
  239. Incidentally searches can be performed before all the files have been found,
  240. although the sort is not multi-tasking, blame C's qsort for this. If you do
  241. this you should be aware that any matches found after performing this search
  242. will be added to the bottom of the window like before, all is not lost
  243. however, as when the search is completed, !Finder will sort the window using
  244. the sort option you selected automatically.
  245.  
  246. It is possible to run two or more searches simultaneously, but all that happens
  247. is that one waits until the other has finished before continuing.
  248.  
  249.  
  250. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  251.  
  252. Well that's about it, I have several ideas for improvements to !Finder,
  253. perhaps the most useful would be to graft it on to the Filer rather than
  254. have !Finder on the icon bar. This will probably mean attatching it to the
  255. filer's menu using a filter. When I find out how to do this, I will give it
  256. a whirl! RISC OS 3 PRM's going cheap anyone? Another idea which will be quite
  257. straightforward given the structure of !Finder, is to allow file searches
  258. requested by other applications via the wimp message system. This would perform
  259. a search in the background, and the results of the search would be passed to
  260. the application that requested it, a file at a time.
  261.  
  262. I hope you find !Finder useful, feedback from user's would be appreciated,
  263. especially if it is positive ;-) In particular, if there is an obvious omission
  264. from !Finder, why not e-mail/write me and I will try to add it.
  265.  
  266. P.S. !Finder was written in C++ and is therefore quite large for what it does.
  267. However, memory management is reasonably effective, and a large search (like the
  268. whole of your hard disc), will only temporarily increase the size of !Finder's
  269. wimp slot. When the display window is closed, all the memory used will be
  270. released.
  271.  
  272.  
  273. Chris Nelson
  274. e-mail: c_nelson@bbcnc.org.uk
  275. s-mail: #4, 74 Lexham Gardens, Kensington, LONDON, W8 5JB
  276. Arcade User #1804
  277. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  278.  
  279. Version History
  280.  
  281. 1.00 16th March 1995
  282. First release of !Finder
  283.  
  284. 1.10 27th March 1995
  285. Fixed an irritating bug that could crash the application when cancel was
  286. selected in the dialog box. Also tightened up some internal coding. Removed bug
  287. that caused problems if dialog box was closed when a search was in progress,
  288. but no file had been found. This also caused problems if the search was
  289. unsuccesful.
  290.  
  291. Yet another bug found which caused problems when only one file was found. Fixed
  292. it.
  293.  
  294. Dialog box appears centred on the screen. File windows appear terraced across
  295. and then down the screen, so as to avoid too much overlap.
  296.  
  297. Tightened up memory management.
  298.  
  299. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++