home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 53 / af053sub.adf / quicktools.lha / QuickTools.doc < prev    next >
Text File  |  1993-09-14  |  10KB  |  260 lines
  1. 930915                     QuickTools Release 1.0
  2.           Requires an Amiga with OS compatible with Workbench 2.04.
  3.  
  4.          Copyright © 1993 Ultima Thule Software, All Rights Reserved.
  5.                           Author: Eivind Nordseth
  6.  
  7. This  package  is  NOT  public domain, but freely distributable.  This means
  8. that  you can copy it and give it to all your friends, upload it to a BBS or
  9. include  it  in  a  PD-library.   The  only restrictions are:  All the files
  10. included  in  this archive must be in their original form without additions,
  11. deletions  or  modifications of any kind.  QuickTools may not be distributed
  12. for  profit.  Only a nominal charge may be associated with its distribution.
  13. If  you  want to distribute QuickTools along with any commercial product you
  14. need  written  permission  from  the author.  QuickTools is provided "AS IS"
  15. without  warranty  of  any  kind,  and the author is not responsible for any
  16. damage this software may do.  (Just in case :-)
  17.  
  18.  
  19. BACKGROUND:
  20. ~~~~~~~~~~~
  21. This package started with Qcd (Quick Change Directory) a few years ago.  Qcd
  22. was  made  because  I was tired of writing long pathnames when I should move
  23. around  on  my  harddisk.   I  had  seen  a  utility  on  PC which did CD to
  24. directories by writing a part of the directory name (NortonCD).  I wanted to
  25. make something like it on the Amiga.  Up the years Qcd has been improved and
  26. I got the idea to make a search package for both files and directories.  And
  27. here it is:  QuickTools.
  28.  
  29.  
  30. QUICKTOOLS PACKAGE
  31. ~~~~~~~~~~~~~~~~~~
  32. This package consist of:
  33. - quicktools.library: This library contains the search-routines for 
  34.                       searching in the database.
  35. - GetQInfo: Scans disks to build up the database of files and directories.
  36. - Qcd: Change directory by searching the database.
  37. - QFind: Find files in the database.
  38. - QPop: Commodity for finding files and directories.
  39. - QAsn, Qdir: Scriptfiles using Qcd.
  40.  
  41. If  you  want  to  use  the  search  routines  in  the library from your own
  42. programs,  the  autodocs  and  includes for the library are included in this
  43. package.
  44.  
  45.  
  46. INSTALLATION
  47. ~~~~~~~~~~~~
  48. The  installation  is quite simple.  Just copy the library to LIBS:  and put
  49. the  executables  from  the  bin  directory somewhere in your path.  Qcd and
  50. QFind  is  pure  and  can be made resident.  (If the pure-bit is off on your
  51. copies,  use  Protect to set it on.) If you want QPop to start up every time
  52. the computer boots, you can drop the QPop icon in the WBStartup drawer.  The
  53. scriptfiles  from  the  S directory should be in the S:  directory.  (If the
  54. script-bit is off on your copies, use Protect to set it on)
  55.  
  56.  
  57. USING WILDCARDS
  58. ~~~~~~~~~~~~~~~
  59. All  programs  using  quicktools.library for searching will allow the use of
  60. standard AmigaDOS wildcards.  A '#?' wildcard is automaticaly added to every
  61. file  and  directory name used for searching.  So searching for 'tes' equals
  62. searching  for  'tes#?',  and searching for wo:sou/qto/#?.c equals searching
  63. for 'wo#?:sou#?/qto#?/#?.c#?'.
  64.  
  65.  
  66. GETQINFO
  67. ~~~~~~~~
  68. Before  you  can use Qcd, QFind and QPop you must use GetQInfo to obtain the
  69. database  for  the library.  The database is stored in S:QuickTools.Dirs and
  70. S:QuickTools.Files.
  71.  
  72. The parameters GetQInfo takes is:
  73. DRIVE/M - Drives to scan for files and directories.
  74. USAGE/S - Show help. Same as using no parameters.
  75.  
  76. Example: 
  77.  GetQInfo System2.0: Work:
  78.   Scans drives System2.0: and Work: for directories and files and stores
  79.   them in the database.
  80.  
  81. You  should  also use GetQInfo often to update the database.  It is possible
  82. to  stop GetQInfo while scanning without destroying the database by pressing
  83. CTRL-C.
  84.  
  85.  
  86. QFIND
  87. ~~~~~
  88. QFind uses the database to search for files.  It takes just a few seconds to
  89. search  trough the database, while ordinary file-searching program could use
  90. several minutes.
  91.  
  92. The parameters QFind takes is:
  93. FILE    - Partial path and/or partial filename to search for.
  94. USAGE/S - Show help. Same as using no parameters.
  95.  
  96. Examples:
  97.  QFind qfi
  98.   Search for files in database matching 'qfi#?'.
  99.  QFind tes/qfi
  100.   Search for files in database matching 'qfi#?' and with a parent directory
  101.   matching 'tes#?'
  102.  
  103.  
  104. QPOP
  105. ~~~~
  106. QPop  is  a Workbench commodity which searches for files or directories with
  107. quicktools.library.   It's  quite  simple  to use, one just write the search
  108. specification  in the string gadget and press enter.  All the entries in the
  109. database  that  match  the  search  spesification  are then shown in the the
  110. ListViewGadget.   The ListViewGadget can be scrolled with the cursor keys in
  111. combination  with  shift  and ctrl.  Located at the bottom of the window are
  112. gadgets  labeled  'Hide',  'Cut',  'Copy' and 'Type'.  The 'Hide' and 'Quit'
  113. gadgets  are  standard commodities gadgets.  'Cut' copies the selected entry
  114. in the ListViewGadget to the clipboard and hides QPop.  'Copy' does only the
  115. copying  to  the  clipbroard.   To  retrive the text from the clipboard, you
  116. could  use  a  tool  for pasting text from the clipboard to the input stream
  117. (Snap could be used).  It is also possible to paste text to a console window
  118. by using R-Amiga V if the program using the console supports it.  The 'Find'
  119. cycle gadget switches between file and directory searching.  Pressing return
  120. when  the  string  gadget  is not active has the same effect as pressing the
  121. 'Cut' gadget.
  122.  
  123. QPop takes its parameters as tooltypes:
  124. CX_PRIORITY, CX_POPKEY, CX_POPUP - Standard commodities toolstypes.
  125. FINDTYPE - Which searchtype to start with.  Possible values are 'File' and
  126.            'Dir'.
  127.  
  128.  
  129. QCD
  130. ~~~
  131. Qcd  is  the main reason for making this toolpackage, and is perhaps the CLI
  132. utility  I  use the most.  With Qcd you could change to any directory on the
  133. disks  in  the  database  by  just  giving enough of the name and/or path to
  134. identify  it.   As  the  other  QuickTools utilities Qcd also support use of
  135. wildcards.   Before  any searching in the database is done, Qcd tests if the
  136. parameter  is  a  directory  relative  to the current directory by trying to
  137. change  to  a  directory  with the name of the parameter.  If this fails the
  138. database  will be searched.  This means that after you have installed Qcd on
  139. your system you don't have to use the old CD command.
  140.  
  141. The parameters Qcd takes is:
  142. DIR        - Partial path and/or partial name of directory to change to.
  143. SEARCHES/N - Change to the n'th directory matching the DIR parameter.
  144. SHOW/S     - Show the full path and name of the directory Qcd changed to.
  145.              Handy in scriptfiles.
  146. USAGE/S    - Show help.
  147.  
  148. Special cases of the DIR-parameter:
  149. '-' : Changes to the directory which last was current.  Qcd stores the
  150.       previous current directory in a local environment variable called 
  151.       'QCDLASTPATH'.
  152. '..' '...' '....' :  Go up one [two][three] directory levels.
  153.  
  154. If  more  than  one  directory  matches  the  DIR parameter and the SEARCHES
  155. parameter is not used, a requester with all the matched directories will pop
  156. up.   This  requester  can  be  controlled  with the mouse or cursor keys in
  157. combination  with shift and ctrl.  The return key equals the 'OK' gadget and
  158. the ESC key equals the 'Cancel' gadget.
  159.  
  160. Examples:
  161. If you want to change to a directory with the following path: 
  162.  
  163. 'Harddisk0:Work/SAS/SelfMade/QuickCD'
  164.  
  165. It's several ways to do it:
  166. You can write: 'Qcd Harddisk0:Work/SAS/SelfMade/QuickCD' (the hard way)
  167. Or           : 'Qcd hard:/sas//quic'
  168. Or           : 'Qcd Self/Quick'
  169. Or           : 'Qcd :///#?cd'
  170. Or           : 'Qcd QuickCD' 
  171. Or just      : 'Qcd qui'   (the fast way)
  172.  
  173. And bang, you are in 'Harddisk0:Work/SAS/SelfMade/QuickCD' !!
  174. Quite nice eh!! 
  175.  
  176. If you think it will be hard to remember to write Qcd instead of CD, can you
  177. use the alias command 'Alias CD Qcd'.
  178.  
  179.  
  180. SCRIPTFILES
  181. ~~~~~~~~~~~
  182. There are also two scriptfiles which uses the Qcd utility.
  183.  
  184. Qasn:  With this script can you do assigns as quick and easy as CD's with 
  185.        Qcd.
  186. Usage: Qasn [logical_name:] [dir] [SEARCHES]
  187.  
  188. Qdir:  Dir any directory quick and easy.
  189. Usage: Qdir [dir] [SEARCHES]
  190.  
  191. If you want to use Qcd in your own scripts, here are the error codes Qcd
  192. returns:
  193.   OK    (0)  - Everything is ok.
  194.   ERROR (10) - The directory given as parameter doesn't match any directorys
  195.                in the database.
  196.   FAIL  (20) - A serious error has occured. Either are the datafiles 
  197.                missing, directorys in the database doesn't exist or the 
  198.                change to last current dir function failed.
  199.  
  200.  
  201. KNOWN PROBLEMS
  202. ~~~~~~~~~~~~~~
  203. When  using  Qcd  in combination with custom shells, there could be problems
  204. with  the path in the prompt update after changing directory.  This is *not*
  205. a bug in Qcd.  The problem is with custom shells who doesn't use the correct
  206. store  for  the  path used in the prompt.  So if you experience this problem
  207. flame the author of the shell and not me :-)
  208.  
  209. One workaround could be:
  210. Rename Qcd to Qcd.bin and a script like this:
  211. <--------------- cut here ----------->
  212. .key DIR,SEARCHES,SHOW,USAGE
  213. Qcd.bin <DIR> <SEARCHES> <SHOW> <USAGE>
  214. cd >NIL:
  215. <--------------- cut here ----------->
  216.  
  217. The following workaround could be used with WShell:
  218.  
  219.   Alias cd     LITERAL "parse arg $1;'qcd' $1;'cd >nil:'"
  220.  
  221.  
  222. RELEASE HISTORY
  223. ~~~~~~~~~~~~~~~
  224. 930915 - QuickTools Release 1.0:
  225. - quicktools.library 2.43
  226. - GetQInfo 3.120
  227. - Qcd 3.93
  228. - QFind 1.48
  229. - QPop 1.97
  230.  
  231.  
  232. THANKS
  233. ~~~~~~
  234. Thanks go to:
  235.  
  236. - The betatesters: Petter Nilsen, Tommy Larsen, Marius Mortensen, 
  237.                    Flemming Andreassen.
  238. - Tommy Hansen for posting the WShell workaround to c.s.a.applications.
  239. - Marius Mortensen (again) for thanking me for Qcd in Offline.doc. :-)
  240. - Ola Fosheim Grøstad, Marius Mortensen and Espen Lyngaas for bug reports
  241.   and/or suggestions on earlier releases of Qcd.
  242. - Amiga for being such a great computer with such a great OS.
  243.  
  244.  
  245. HOW ABOUT SOME FEEDBACK
  246. ~~~~~~~~~~~~~~~~~~~~~~~
  247. Please send donations, bug reports or a list of features you would like to
  248. have included in future releases to:
  249.  
  250. Eivind Nordseth
  251. Herman Krags Vei 17-21
  252. N-7035 TRONDHEIM
  253. Norway
  254.  
  255. Email: eivindno@idt.unit.no
  256.  
  257. You can also get in touch with me at the following BBSes in Norway:
  258. Ultima Thule BBS, Barents BBS, Crusaders BBS, Rodeløkka BBS and 
  259. Mediafoto BBS.
  260.