home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / util / cli / qcd / qcd.doc < prev    next >
Text File  |  1995-06-11  |  8KB  |  203 lines
  1.                                           _    _   _
  2.                              __ _  ___ __| |  / | / |
  3.                             / _` |/ __/ _` |  | | | |
  4.                            | (_| | (_| (_| |  | |_| |
  5.                             \__, |\___\__,_|  |_(_)_|
  6.                                |_|
  7.  
  8.                           © 1993-1995 by Frank Würkner
  9.                               All Rights Reserved
  10.  
  11.  
  12. COPYRIGHT NOTE
  13. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  14. The program qcd is copyrighted © 1995 by Frank Würkner.
  15. All rights reserved.
  16.  
  17. qcd is FREEWARE.  This program may be freely distributed as long as
  18.   - the executable and documentation remain unchanged and
  19.     are included in the distribution
  20.   - No other charge is made than to cover time and copying costs
  21.  
  22.  
  23. DISCLAIMER
  24. ¯¯¯¯¯¯¯¯¯¯
  25. No warranties of any kind are made as to the functionality of this
  26. program. You are using it ENTIRELY at your own risk.
  27.  
  28.  
  29. SYSTEM REQUIREMENTS
  30. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  31. To run qcd you'll need OS2.0 or higher !!!
  32.  
  33.  
  34. QUICK OVERVIEW
  35. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  36. With qcd you can not only match paths, but also assigns/volumes/devices,
  37. e.g. loc*:cat* would be short for locale:catalogs. If more than one
  38. path maches it will ask you which one you really meant. Whenever possible
  39. it understands the Unix elements . .. ~ / ,though the Amiga syntax has
  40. priority. You also have the ablility to set a CDPATH variable to show
  41. the program where to look for your directories. Of course you can go
  42. back to the directory where you where before (similar to the script S:PCD).
  43. Finally you can also select the directory via filerequester.
  44.  
  45.  
  46. USAGE
  47. ¯¯¯¯¯
  48. qcd only works in your CLI, so don't start it from your Workbench !
  49. Nearby qcd is pure and can be made resident (and it is adviced to do so).
  50. It has the following template :
  51.      DIR,NOREQ/S,NOPAT/S,NOHARD/S,NOSOFT/S,NOUX/S,FREQ/S,
  52.      PCD=-/S,PPCD=--/S,WAIT/K/N
  53.  
  54.  
  55. DIR
  56.      Normal Amiga syntax:
  57.      <assigns/volumes/devices>:     absolute Path
  58.      :                              the root of your current directory
  59.      /                              the parent directory
  60.      Unix syntax:
  61.      / (first char)                 Root (see also ENVIRONMENT VARIABLES)
  62.      ~                              Home (see also ENVIRONMENT VARIABLES)
  63.      .                              current directory
  64.      ..                             the parent directory
  65.  
  66.      As described in the QUICK OVERVIEW you can use patterns where ever
  67.      you like. Here some examples and the explanation in brackets:
  68.      > qcd ram:env/sys          [just normal cd, anything accepted by cd
  69.                                  is also accepted by qcd]
  70.      Ram Disk:Env/Sys> qcd /    [this would make RAM:Env in Amiga syntax
  71.                                  and RAM: in Unix syntax, but qcd always
  72.                                  assumes that you meant the Amiga syntax,
  73.                                  if only one directory matches with
  74.                                  Amiga syntax]
  75.      Ram Disk:Env> qcd :*       [so what to do? RAM:Clipboards RAM:T
  76.                                  and RAM:Env matches: let the user decide]
  77.      1.) Ram Disk:Env
  78.      2.) Ram Disk:Clipboards    [if you would see 10 directories plus "..." it
  79.      3.) Ram Disk:T              would mean there are more than 10 matching]
  80.      Which directory ??? 2
  81.      Ram Disk:Clipboards> qcd ../t [obviously Unix syntax, because no
  82.                                     ".." directory exists here]
  83.      Ram Disk:T> qcd :*//       [qcd will check that all ways end in RAM:]
  84.      Ram Disk:> qcd xyz:        [Assuming xyz: is not mounted, you will not
  85.                                  see a "Please insert ..." requester,
  86.                                  because qcd scanns the devicelists and
  87.                                  knows it does not exist.]
  88.      Can't find directory "xyz:".
  89.      Ram Disk:> 
  90.  
  91. NOREQ/S
  92.      When cding to a device with changeable media, such as DF0: and
  93.      no media is inserted, you get a "Please insert ..." requester.
  94.      To suppress the requester set this switch.
  95.  
  96. NOPAT/S
  97.      Set this if you want to change to a directory with #,?,|,~,%,[,-,],'
  98.      in it, e.g. "qcd ?x#'* NOPAT" insted of "qcd '?x'#'''*"
  99.  
  100. NOHARD/S
  101.      The default is to handle hardlinks to directory in the same way as
  102.      normal directories. Set this switch if you don't want to walk over
  103.      hardlinks when using pattern matching. You can still cd to hardlinked
  104.      directories when using the full name.
  105.  
  106. NOSOFT/S
  107.      The same is true for softlinks.
  108.  
  109. NOUX/S
  110.      Set this if you don't want to use the Unix pathelements. That means
  111.      / ~ . .. are no longer understood.
  112.  
  113. FREQ/S
  114.      Display a filerequester and cd to the selected directory.
  115.  
  116. PCD=-/S
  117.      Cd to your last directory. (Of course this only works if you used
  118.      qcd to change the directory)
  119.  
  120. PPCD=--/S
  121.      Cd to your directory before your last directory. (Of course this only
  122.      works if you used qcd to change the directories)
  123.  
  124. WAIT/K/N
  125.      If you cd to a device with changeable media, such as DF0: and you
  126.      previously changed the media, you might get a "Please insert ..."
  127.      requester. This is because the system didn't check yet that there
  128.      is a media present now. You can tell qcd to wait some amount of
  129.      time to let the system notice the change. The amount of time is given
  130.      in ½ seconds, e.g. "qcd df0: wait=4" to wait a maximum of 2 seconds.
  131.  
  132.  
  133. ENVIRONMENT VARIABLES
  134. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  135. The value in the brackets is used if the variable is unset.
  136. "CDPATH" [default ",SYS:"]
  137.     Probably the most important one. Tells the program where to look
  138.     for your relative directories. The "," sperates each of your directories,
  139.     if your directory contains a "," you must write "\," and if your
  140.     directory contains a "\" you must write "\\" (though your directories
  141.     shouldn't contain such crazy chars). To make qcd act as the normal cd
  142.     only specify "\" as CDPATH (this is because "" will unset the variable). 
  143. "ROOT" [default ":"]
  144.     Unlike the Unix filesystem there is no root of all devices in
  145.     the Amiga filesystem, so you might like "SYS:" or something else
  146.     as your "root".
  147. "HOME" [default "SYS:"]
  148.     In most Unixshells "~" gets expanded to your homedirectory.
  149.     Set this variable to any path you need to cd often.
  150.  
  151. Following local variables are set by qcd:
  152. "PWD"
  153.     Your last directory (Previous Working Directory)
  154. "PPWD"
  155.     The directory before your last (Pre-Previous Working Directory)
  156.  
  157.  
  158. TIPS
  159. ¯¯¯¯
  160. If you want to use qcd in your shell you should keep in mind that qcd
  161. is NOT designed to replace the cd command, this is because of the fact
  162. that shell scripts could have problems with following points
  163.   - qcd is designed to be interacive if there is a need
  164.   - qcd accepts paths which would be refused by cd, e.g. SYS:s/RAM:
  165.   - qcd doesn't pop up a requester if a volume is not currently known
  166.     to the system. But scripts use e.g. "cd Install1:" to inform the
  167.     user to insert an other disk
  168. So don't use the commands (nearby I get a "Memory header not located"
  169.                            guru when using these commands, but this
  170.                            must be a bug in the resident command)
  171. > resident cd remove
  172. > resident cd c:qcd
  173.  
  174. I would advice you to add the lines
  175. > resident c:qcd
  176. > alias cd qcd [] noreq wait=6
  177. or something similar to your S:Shell-Startup file. You can also set the
  178. environment variables here.
  179.  
  180.  
  181. HISTORY
  182. ¯¯¯¯¯¯¯
  183. 1.0
  184.      first release
  185.  
  186. 1.1
  187.      o removed a bug that caused KCON: to crash when having the current
  188.        directory name in the title of the shell
  189.  
  190.  
  191.  
  192. If you have comments, suggestions, criticism, bug reports etc.
  193. send mail to
  194.  
  195.                 Frank Würkner
  196.                 Georgenschwaigstr. 22
  197.                 D-80807 München
  198.                 Germany
  199.  
  200.                 or
  201.  
  202.                 E-Mail: wuerkner@informatik.tu-muenchen.de
  203.