home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / rdx200.zip / RDX200.TXT < prev   
Text File  |  1994-01-19  |  9KB  |  234 lines

  1. RDX Version 2.00
  2. ================
  3.  
  4. RDX is a command-line directory changer written in REXX for OS/2 V2.x. It
  5. will locate directories based on partial names, optionally containing
  6. wildcards, search multiple drives and includes a lookup table option so
  7. that frequently-used (at the user's discretion) directories can be located
  8. conveniently and quickly without a disk search.
  9.  
  10. This program requires that the OS/2 REXX interpreter and REXX utility 
  11. functions (REXXUTIL.DLL) have been properly installed. These can be added 
  12. if necessary by using Selective Install and checking the "REXX" box.
  13.  
  14. Anyone is free (encouraged) to use, distribute or modify this program to
  15. suit their own needs. If you distribute a modified version, please document
  16. the changes and give it another name.
  17.  
  18.                                                      James Brombergs
  19.                                             bro561@geel.dwt.csiro.au
  20.  
  21. COMMAND  LINE  OPTIONS
  22. ======================
  23.  
  24. (Options are not case-sensitive).
  25.  
  26. RDX [/H] [/?]
  27.  
  28.        Show instructions and command line options.
  29.  
  30. RDX /L
  31.  
  32. Edit lookup table
  33.  
  34.        Interactively add and delete items, or view the table. 
  35.  
  36.        The lookup table can be used to store abbreviations for the paths of
  37.        frequently-used directories.
  38.  
  39.        DO NOT MAKE RDX.CMD READ-ONLY IF YOU INTEND TO USE THIS
  40.  
  41.  
  42. RDX [/+] [/B] [/T] [[-]drivelist:]dirname
  43.  
  44. Search for a directory
  45.  
  46.        /+     Include drives A and B when searching multiple drives.
  47.  
  48.        /B     Stop at first matching directory without prompting.
  49.  
  50.        /T     Search lookup table only - do not search drives.
  51.  
  52.        drivelist     List of drive letters followed by a colon eg. CDG:
  53.  
  54.                  * =        Searches all drives (excludes A: and B: unless /+
  55.                             switch is given).
  56.  
  57.                ddd =        Searches drives in list.
  58.  
  59.               -ddd =        Searches all drives except those in the list (also
  60.                             excludes A: and B: unless /+ switch is given).
  61.  
  62.  
  63.        dirname       A partial directory name to search for. <dirname> may
  64.                      contain wildcards ? and *. By default, <dirname> is assumed
  65.                      to end with a * wildcard. Other wildcards do not work with
  66.                      lookup table keys.
  67.  
  68.  
  69. Notes
  70. -----
  71. <dirname> and <drivelist> are not case-sensitive. eg a directory called
  72. "Rexx" can be found by searching for "REXX" or "rexx".
  73.  
  74. Don't enclose <dirname> in quotes or use embedded spaces. If you want to
  75. search for a directory name that contains spaces, either use the partial
  76. name before the first space or replace the spaces with ? wildcards.
  77.  
  78. If there is only one possible directory matching <dirname>, RDX will change
  79. to that directory without prompting even if the /B switch has not been
  80. used. If multiple drives are being searched, this only applies to the last
  81. drive.
  82.  
  83. If the /+ switch is used without a <drivelist>, the switch is ignored and
  84. only the current drive is searched. If it is used with <drivelist> other
  85. than *, the <drivelist> takes precedence.
  86.  
  87. The command syntax is (deliberately) similar to that of CDX, a DOS
  88. directory changer written by Michael Holmes and Bob Flanders.
  89.  
  90.  
  91. Examples
  92. --------
  93. Assume that drives A: B: C: D: E: are available.
  94.  
  95. RDX WIN
  96.        Searches the lookup table for any keys starting with "WIN".
  97.  
  98.        Searches the current drive, and finds all directory names starting
  99.        with "WIN" eg. \OS2\MDOS\WINOS2, etc.
  100.  
  101. RDX ?IN
  102.        Searches the lookup table for keys starting with "?IN". Note that the
  103.        question mark is _not_ treated as a wildcard.
  104.  
  105.        Searches the current drive only and finds directory names starting
  106.        with any character followed by "IN" eg. \OS2\MDOS\WINOS2,
  107.        \BORLANDC\BIN, etc.
  108.  
  109. RDX /+ *:*.*
  110.        Searches the lookup table for keys starting with "*.*".
  111.  
  112.        Searches all drives including A: and B: and finds any _directory_
  113.        names that contain a dot.
  114.  
  115. RDX /+ -AD:BIT
  116.        Searches the lookup table for keys starting with "BIT"
  117.        Searches drives B:, C: and E: for directory names starting with "BIT".
  118.  
  119.  
  120. SEARCHING  FOR  DIRECTORIES
  121. ===========================
  122.  
  123. When RDX finds a directory matching the given specifications, either in the
  124. lookup table or on a disk drive, it will display the full path followed by
  125. a question mark, unless the /B switch was used. If the /B switch was used,
  126. it will change to the directory without prompting.
  127.  
  128. When a directory is offered, press <SPACE> to search for the next match,
  129. <ESCAPE> to cancel the search and revert to the original directory, or any
  130. other key to change to change to the directory that was found.
  131.  
  132. If at some stage of the search there is only one possible directory that
  133. matches the specifications, RDX will change to that directory without
  134. prompting.
  135.  
  136. Notes
  137. -----
  138. RDX constructs a complete directory list for a drive before looking for 
  139. matches, so it can take a while to search a large hard disk partition, and 
  140. even longer to search a CD-ROM.
  141.  
  142.  
  143. LOOKUP  TABLE
  144. =============
  145.  
  146. The lookup table stores a list of keys and corresponding directories, so
  147. that frequently-used directories can be located very quickly. If there are
  148. any entries in the lookup table, the table is automatically searched first,
  149. and any matching keys are offered before any disk drives are searched.
  150.  
  151. If you find that you use the same directory often when you open an OS/2
  152. command-line, you can create an identifier (key) for it and add it to the
  153. lookup table to quickly change to the directory you want. For instance, if
  154. your REXX code is in a directory called E:\os2\Programming\Rexx, create a
  155. key "RX" and set the corresponding path to "E:\OS2\PROGRAMMING\REXX". Then
  156. you can change to this directory at any time by typing "RDX RX".
  157.  
  158. Keys may contain any characters except spaces. Duplicate keys are allowed
  159. in the table, if they match the search criteria, they will be offered in
  160. the order that they are found. The search is not case-sensitive. Keys need
  161. not bear any resemblance to the directories they correspond to.
  162.  
  163. Since * and ? are legal characters in lookup table keys, searches based on
  164. wildcards will be treated literally when searching the lookup table. The
  165. wildcards will still be expanded when drives are searched.
  166.  
  167.  
  168. Editing the Lookup Table
  169. ------------------------
  170. When RDX is started with the /L switch, it will show a menu offering the
  171. choices :
  172.  
  173. (A)dd Entry
  174.        Add a new key and directory path to the table. New entries are added
  175.        at the end. Keep this in mind if you use duplicate keys. You will be
  176.        prompted for the key, and then for the corresponding path. Enter a
  177.        fully qualified path name (including drive, path and terminating
  178.        directory name). RDX will check the path for illegal characters, then
  179.        attempt to change to the directory. If it cannot, the following
  180.        message will be displayed :
  181.  
  182.        Cannot locate the directory. Is that OK (Y/N)?
  183.  
  184.        Enter 'N' if you made a mistake, or 'Y' if you intend to create the
  185.        directory later, or if it is on a drive that is not currently
  186.        available (eg. network, floppy, CD-ROM, etc.)
  187.  
  188. (D)elete Entry
  189.        Shows a list of all entries in the table, stopping after each screen.
  190.        Type the number next to the entry you want to delete.
  191.  
  192. (V)iew Table
  193.        Shows a list of all entries in the table, stopping after each screen.
  194.  
  195. (C)ancel and Exit
  196.        Exit without saving changes to the lookup table.
  197.  
  198. (S)ave and Exit
  199.        Exit and save changes to the lookup table. If you see the message
  200.  
  201.        Cannot replace original file
  202.  
  203.        this means that the original file (RDX.CMD or whatever you have 
  204.        called it) could not be deleted for some reason. The program will 
  205.        terminate at this point, leaving a file called "RDX#####.CMD" (where 
  206.        # is a random digit) in the current directory. Delete the original 
  207.        file and rename this file.
  208.  
  209. Notes
  210. -----
  211. The lookup table is stored as a stem variable within the RDX.CMD file, for
  212. performance considerations. When the table is changed, the entire command
  213. file must be rewritten, so RDX.CMD should not be made read-only.
  214.  
  215. You can rename RDX.CMD and still use these features. The name will be 
  216. determined at run-time.
  217.  
  218. The table can be edited directly. Load RDX.CMD into your favourite text
  219. editor and find the comment /*LOOKUP*/, indicating the beginning of the
  220. table. Do not change this comment or the /*ENDLOOKUP*/ comment which
  221. indicates the end of the table. This is also the easiest way to change the
  222. order of table entries. The format of the table is :
  223.  
  224.        lookUp.0 = integer         the number of entries in the table.
  225.  
  226.        lookUp.n.key = "string"    string contains key n
  227.        lookUp.n.dir = "string"    string contains path n
  228.  
  229. If you don't want to use the lookup table at all, and want to get rid of
  230. the code, find the comment that says LOOKUP TABLE EDITING ROUTINES. Delete
  231. everything from here to the end of the file.
  232.  
  233.  
  234.