home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / zsys / znode-12 / s / z3help08.lbr / ADIR.HZP / ADIR.HLP
Encoding:
Text File  |  1993-06-12  |  6.5 KB  |  151 lines
  1. ;
  2.                                    ADIR.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5. ADIR22IN.COM   4k (30)   0934  2.2        Greg Miner 1/89          Z3COM1
  6. ADIR22EX.COM   4k (32)   1E99  2.2        Greg Miner 1/89          Z3COM1
  7.  
  8.    1- Syntax  2- Notes  3- Patch Table  4- Error Message                      
  9.  
  10.    ADIR provides  a sorted list in a directory format of all Aliases contained
  11. in the ALIAS.CMD file.   ALIAS.CMD must be located in the ROOT directory,  the
  12. last element along your search path.   Alternatively, the Drive/User to search
  13. in the form DU: or DIR:, may be entered on the command line.
  14.  
  15.    ADIREX.COM is for use with an External Environment.   If using ZCPR3.3, you
  16. may use the program  as is.   For ZCPR3.0,  simply patch the  address  of your
  17. External Environment at locations 0109h and 010Ah or use Z3INS.
  18.    ADIRIN.COM is  for systems  which do  not support  an external environment.
  19. Use Z3INS to install your environment.
  20. :1
  21.  
  22.        Syntax:  ADIR du:filename.typ /oo   <-- produces directory of
  23.             or  ADIR dir:filename.typ /oo           ALIAS.CMD file 
  24.  
  25.       Options:  N   <-- No page pause
  26.                 S   <-- Display hidden
  27.                 P   <-- Send output to LST:
  28.  
  29.    The use of filename.typ is wheel dependent to prevent use of the program to
  30. peek  into  other,  possibly  restricted  text  files.   ADIR has  no means of
  31. distinguishing an ALIAS file from any other,  nor does it test the system file
  32. attribute as  the  ALIAS.CMD file will usually  be SYS.   If 'filename.typ' is 
  33. omitted, ALIAS.CMD is used.  If '.typ' is  omitted,  the extention  CMD is the
  34. default.
  35.  
  36.    When ALIAS.CMD,  or the selected file,  is located in  a password-protected
  37. directory,  either by  path  search or  by user selection,  the Wheel  byte is 
  38. checked  and,  if not set,  the user is requested  for the directory password.
  39. An invalid entry terminates the program. 
  40. :2
  41.  
  42. ADIR Notes:
  43.  
  44.    a. ADIR assumes that the ALIAS.CMD file adheres to a few simple rules:
  45.  
  46.       1.  ADIR ignores any line  beginning  with  a space.   Aliases beginning
  47.           with  a  punctuation  character  are  special  cases.   The  leading 
  48.           character is normally ignored  and the alias is  displayed as though 
  49.           it did not exist.
  50.  
  51.               Thus the line:
  52.                              :default Z3ERROR
  53.               is ignored, while
  54.                              :DEFAULT Z3ERROR
  55.               would be displayed as:
  56.                               DEFAULT
  57.  
  58.           If the  /S switch were used in the above example,  then both aliases
  59.            would be displayed as found, including the leading colons.
  60.  
  61.  
  62.  
  63. ADIR Notes (cont'd):
  64.  
  65.       2.  ADIR assumes that any alias beginning with a lower case letter (a-z)
  66.           is "system" or hidden.   These are not displayed nor included in the 
  67.           final tally (see switch /S). Thus the lines:
  68.  
  69.              PACK ROOT:;PUBLIC /CA;PACK2;PUBLIC /DAU8;%D0%U0:
  70.              pACK2 LX SAP;LX PACK10
  71.  
  72.           produce only one entry,  "PACK" in the  directory.   The rest of the
  73.           alias name may be in either upper or lower case.
  74.  
  75.  
  76.  
  77. ADIR Notes (cont'd):
  78.  
  79.       3.  No case switching is performed by ADIR.   If you want your directory
  80.           in upper case, then the alias names must appear in the file in upper
  81.           case.   The exception is  the first character which  is used  as the 
  82.           display/hide switch explained  above.   A  very nice  display can be 
  83.           produced if  all entries  in  your ALIAS.CMD  file  which  you  want 
  84.           displayed are in upper case,  and those which are not normally to be 
  85.           displayed are in lower case.   In this way,  when  the /S  switch is 
  86.           used, hidden aliases appear distinctly in the display.  This feature
  87.           may  be overridden  by setting  the capitalization flag in the patch 
  88.           table located at the beginning of the program to TRUE (0FFH).
  89.  
  90.  
  91.  
  92. ADIR Notes (cont'd):
  93.  
  94.       4.  "Equated" aliases are treated as separate entries. 
  95.  
  96.           ie.  SD=?DIR=D=dIR/? produces two entries: SD and D, while
  97.           ?DIR and dIR/? are ignored as explained above.
  98.  
  99.       5.  Finally, ADIR assumes by default that the maximum length of an alias
  100.           name will be nine characters.  This allows room for a colon, etc. in
  101.           the  case  of  a  Directory  name  (PERSONAL:)  or  the  '.'  in  an 
  102.           abbreviated alias (PERS.ONAL).  Both of these types are displayed as
  103.           found.
  104.                    PERSONAL:   PERS.ONAL
  105.  
  106. :3
  107.  
  108. ADIR Patch Table - configure to suit
  109.  
  110.                             Location
  111. LABEL     Function    Default   ADIR22EX  ADIR22IN    Comments
  112.  -------------------------------------------------------------
  113. CAPSON   Capitalize      0       10BH      202H        Note 1
  114. TLINE    Chars/Line   50H/80     10CH      203H        Note 2,3
  115. PLINE    Lines/Page   16H/24     10DH      204H        Note 2
  116. ALENTH   Default Len. 0AH/10     10EH      205H        Note 3
  117.  
  118. NOTE 1
  119.    Capitalization Flag.   Default is OFF to display Aliases as found.   If set
  120. TRUE (0FFH),  all  aliases,  including hidden  if  the /S switch  is used, are 
  121. displayed in Upper Case.
  122.  
  123. NOTE 2
  124.    Terminal characters  per line  and lines per page.   Congigure to suit your 
  125. hardware, or preference (See Note 3).
  126.  
  127.  
  128. ADIR Patch Table (cont'd):
  129.  
  130. NOTE 3
  131.    Set ALENTH to the  maximum number of characters in  an alias name.   If any 
  132. alias exceeds this length, you'll have trouble.  The number of aliases printed
  133. on  a line is  a function of ALENTH and TLINE.   With the default settings the 
  134. display is  eight columns wide.   The formula for the number of columns is the  
  135. integer of TLINE divided by ALENTH.  Thus if you want a display of six columns
  136. on  an  eighty character terminal,  set TLINE to 50H  and ALENTH to 0DH.   The 
  137. display would then be left justified with 13 chars allotted to each entry.
  138.  
  139.    As a footnote, it should be remembered that the larger ALENTH is, the fewer
  140. actual records ADIR will be able to handle.   This will not  be  a problem  in 
  141. most cases  as ADIR uses all  of available memory for the data table up to the 
  142. location of the CCP.  This means that with the default setting ALENTH=10, over 
  143. 4400 Aliases could be accomodated.  Not a very likely case, eh?
  144. :4
  145.  
  146.  
  147.  
  148. Error Message:  
  149.  
  150.    "File A15:ALIAS.CMD not found."                                
  151.