home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / s.lbr / SETPATH.HZP / SETPATH.HLP
Encoding:
Text File  |  1991-11-18  |  4.1 KB  |  97 lines
  1. ;
  2.                                  SETPATH.COM                                  
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5. SETPATH.COM    4k (27)   D71E  1.1        Bruce Morgen 6/91        Z3COM19
  6. SETPATH.4OM    4k (32)   94E9  1.1        Bruce Morgen 6/91        Z3COM19
  7.  
  8.   1- Syntax  2- Usage  3- Notes  4- Examples of Use                           
  9.  
  10.    SETPATH is a highly enhanced derivative of the ZCPR3 utility  PATH.COM.  It
  11. allows the new path to  be  defined  on  the  basis of  the  existing  path --
  12. elements can be  added or  deleted from either end of the path, along with the
  13. standard  PATH.COM  functions of  displaying  or  replacing  the  entire  path
  14. expression.  
  15.  
  16.    SETPATH was written by R.I. Demrow (3/8/87) and is  derived from ZCPR3 PATH
  17. vs 3.1 (4/12/84) and ZCPR2 PATH 1.0 (1/12/83) by Richard Conn.  While probably
  18. too elaborate for the needs of many users, it is a far more flexible tool than
  19. PATH.
  20. :1
  21.    Syntax   [option element-list] ... [option element-list]
  22.  
  23.   Options   /C    <-- clear path and put in new element list
  24.  
  25.             /P    <-- prefix list of elements to the beginning of the 
  26.                       current path
  27.  
  28.             /A    <-- append list of elements to the end of the 
  29.                       current path
  30.  
  31.             /D    <-- delete listed elements from the path starting
  32.                       from the beginning of the current path
  33.  
  34.             /R    <-- remove listed elements from the path starting
  35.                       from the end of the current path
  36. :2
  37.  Usage - 1/2 
  38.  
  39.    SETPATH performs each operation independently.  Consequently, the command:
  40.  
  41.                          SETPATH /P A1 /A B1
  42.  
  43.       is equivalent to   SETPATH /P B1 A1
  44.  
  45.                and NOT   SETPATH /P A1 B1
  46.  
  47.  
  48.    The temporary prefix and temporary append buffers  are each limited in size
  49. to the size of the sytem's symbolic path buffer.
  50.  Usage - 2/2 
  51.  
  52.    SETPATH sets the program error flag in the  ZCPR3 message buffer to reflect
  53. the result of the  command  operation.  If all  succeeded,  the  error flag is
  54. cleared to a value of zero.  Otherwise it is set to one of the following 
  55. values to show the type of error that occurred:
  56.  
  57.       1.   there is no external path buffer
  58.       2.   the wheel byte is not set
  59.       3.   an illegal option was specified
  60.       4.   the final path is empty
  61.       5.   too many elements for the temporary path buffer
  62.       6.   too many elements in final symbolic path
  63.       7.   too many elements in the temporary prefix buffer
  64.       8.   too many elements in the temporary append buffer
  65.       9.   bad path expression (e.g., nonexistent directory name)
  66. :3
  67.  SETPATH Notes 
  68.  
  69.    a. Version 1.1 updates (6/6/91, Bruce Morgen):
  70.       - Added command line quiet option.
  71.       - Code revised to  bring  the  Type 4  SETPATH  below  4k  (32 records).
  72.         Although it's  algorithmically excellent,  the coding style of SETPATH
  73.         1.0 was both 8080-bound and  sometimes  downright  inefficient.   This
  74.         version requires Z80  compatibility,  and many (surely not all) of the
  75.         inefficiencies have been remedied.   When linked as a Type 4,  SETPATH
  76.         1.1 allocates buffer space below the  program,  while  Type 3 linkages
  77.         will continue to  allocate  from  $memry  on  up,  as in  Version 1.0.
  78.       - Help message now  shows  the program's invocation name, type, and load
  79.         address, as well has a line of text  about  the  new  quiet  option (a
  80.         trailing "Q" or "/Q").  
  81.       - A Type 3 safety  header  has  NOT  been  added,  and  it  is  strongly
  82.         recommended that Type 3 executables be linked at 100h.
  83. :4
  84.  Examples of Use 
  85.  
  86.    The following examples assume an initial path of 'A0 $$ A0'.
  87.  
  88.    a. SETPATH /A A15             <--  resulting path  A0 $$ A0 A15
  89.  
  90.    b. SETPATH /P A1 B1           <--  resulting path  A1 B1 A0 $$ A0
  91.  
  92.    c. SETPATH /D A0              <--  resulting path  $$ A0
  93.  
  94.    d. SETPATH /R A0              <--  resulting path A0 $$
  95.  
  96.    e. SETPATH /P A1 /R A0 /A A$  <--  resulting path A1 A0 $$ A$
  97.