home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / a.lbr / ADIR.HZP / ADIR.HLP
Encoding:
Text File  |  1991-11-18  |  9.1 KB  |  191 lines
  1. ;
  2.                                    ADIR.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5. ADIR26.COM     5k (35)   50A4  2.6        Greg Miner 9/89          Z3COM1
  6. ADIR25IN.COM   5k (34)   F088  2.5        Greg Miner 8/89          Z3COM1
  7.  
  8.    1- Syntax  2- Notes  3- Patch Table  4- Error Messages                     
  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,  ADIR may  be configured 
  13. to search a default directory.   If the  wheel byte is set,  the  directory to
  14. search in the form of DU: or DIR:, may be entered on the command line.
  15.  
  16.    ADIR.COM is for use with an External Environment.   If using  ZCPR3.3,  you
  17. may use the program  as is.   For ZCPR3.0,  simply patch the  address  of your
  18. External Environment at locations 0109h and 010Ah or use Z3INS.
  19.    ADIRIN.COM is for systems which do not support an external environment.
  20. :1
  21.  
  22.      Syntax:   ADIR [dir:][filename.ext] [=mask] [/oo]   
  23.  
  24.     Options:   N   <-- No page pause
  25.                S   <-- Display hidden
  26.                P   <-- Send output to LST:
  27.                Ln  <-- Specify Alias Name length
  28.                Rn  <-- Loads alias count into ZCPR register n (1-9)
  29.  
  30.    All tokens are optional.  Any invalid or restricted token is ignored.
  31.  
  32.    When ALIAS.CMD,  or the selected file,  is located in  a password-protected
  33. directory,  either by  path  search or  by user selection,  the Wheel  byte is 
  34. checked  and,  if not set,  the user is requested  for the directory password.
  35. An invalid entry terminates the program. 
  36.  
  37.    mask:  Takes the form '=mask' and may be up to twenty chars in length.  The
  38. first n chars of each entry are compared to the  mask and the entry eliminated
  39. from the display if no match occurs.
  40. :2
  41.  ADIR Notes - 1/5 
  42.  
  43.    a. ADIR assumes that the ALIAS.CMD file adheres to a few simple rules:
  44.  
  45.       1.  ADIR ignores any line beginning with a space or semi-colon.  Aliases
  46.           beginning with  a  punctuation character  are  special  cases.   The 
  47.           leading character is normally ignored and the alias is  displayed as
  48.           though it did not exist.
  49.  
  50.               Thus the line:
  51.                              :default Z3ERROR
  52.               is ignored, while
  53.                              :DEFAULT Z3ERROR
  54.               would be displayed as:
  55.                               DEFAULT
  56.  
  57.           If the  /S switch were used in the above example,  then both aliases
  58.            would be displayed as found, including the leading colons.
  59.  ADIR Notes - 2/5 
  60.  
  61.       2.  ADIR assumes that any alias beginning with a lower case letter (a-z)
  62.           is "system" or hidden.   These are not displayed nor included in the 
  63.           final tally (see switch /S). Thus the lines:
  64.  
  65.              PACK ROOT:;PUBLIC /CA;PACK2;PUBLIC /DAU8;%D0%U0:
  66.              pACK2 LX SAP;LX PACK10
  67.  
  68.           produce only one entry,  "PACK" in the  directory.   The rest of the
  69.           alias name may be in  either upper or lower  case, although,  if the
  70.           CAPSON flag is  left  off and hidden  aliases appear in ALIAS.CMD in 
  71.           lower case characters,  they become  easily distinguishable  in  the
  72.           directory when the /S switch is used.  Hidden aliases may also occur
  73.           in either upper or lower case, or in numeric or other form following
  74.           a special comment line which  takes  the form:  ;PRIVATE.   The word
  75.           PRIVATE must occur in upper  case.   No entries following  this line 
  76.           are displayed unless the /S switch is present on the command line. 
  77.  ADIR Notes - 3/5 
  78.  
  79.       3.  "Equated" aliases are treated as separate entries. 
  80.  
  81.           ie.  SD=?DIR=D=dIR/? produces two entries: SD and D, while
  82.           ?DIR and dIR/? are ignored as explained above.
  83.  
  84.       4.  Finally, ADIR assumes by default that the maximum length of an alias
  85.           name will be nine  characters.   This may be altered by changing the
  86.           value of ALENTH as explained above.   Any alias  name which  exceeds
  87.           the value of ALENTH  is truncated and appended with  a semi-colon to
  88.           indicate that it has been truncated. 
  89.  ADIR Notes - 4/5 
  90.  
  91.    b. Version 2.3 updates:
  92.       - removes code which  prevented  any alias  beginning with a punctuation 
  93.       character being displayed in the non-hidden format.   This code also had 
  94.       the side effect of hiding aliases beginning with numeric characters.   
  95.       - recognizes any character with  the  exception  of ":" and "_"  in  the 
  96.       first character position.   
  97.       - bug is  also fixed which caused ADIR to  hang up if the ALIAS.CMD file  
  98.       happened to end with a blank line, CR or LF as the last character in the
  99.       file.     
  100.  
  101.    c. Version 2.4 updates:
  102.       - corrects a recursion problem in version 2.3 if any of the options were
  103.       used in previous runs.    All flags are not  reset each time the program 
  104.       is re-entered.
  105.  ADIR Notes - 5/5 
  106.  
  107.    d. Version 2.5 updates:
  108.       - adds 'truncation' of alias  names which are longer than ALENTH.   Long 
  109.       aliases are presented terminated  with  a  semi-colon.   The  truncation 
  110.       character is patchable at the label TRNCHR.
  111.       - adds test for commented lines (beginning in ";").
  112.       - adds /Ln switch for length specification from the command line.
  113.  
  114.    e. Version 2.6 updates:
  115.       - terminal data now taken from TCAP if available.  If no TCAP is 
  116.       installed, the values at TLINE and PLINE are used. 
  117.       - in addition to 'lower case' hidden aliases, any alias present after the
  118.       comment line ';PRIVATE' is treated as hidden
  119.       - alias count may be directed to one of the ZCPR registers (1-9)
  120.       - accepts search mask from command line
  121.       - optional default DU to find ALIAS.CMD if non-wheel
  122.       - accepts filename from command line regardless of wheel state
  123.       - internal environment no longer supported
  124. :3
  125.  ADIR Patch Table (configure to suit) - 1/3 
  126.  
  127.                             Location
  128. LABEL     Function    Default   ADIR22EX  ADIR22IN    Comments
  129.  -------------------------------------------------------------
  130. CAPSON   Capitalize      0       10BH      202H        Note 1
  131. TLINE    Chars/Line   50H/80     10CH      203H        Note 2,3
  132. PLINE    Lines/Page   16H/24     10DH      204H        Note 2
  133. ALENTH   Default Len. 0AH/10     10EH      205H        Note 3
  134. TRNCHR   Trunc. char    ";"                            Note 4 
  135. DEFDU    Default DU   01/00                            Note 5
  136.  
  137. NOTE 1
  138.    Capitalization Flag.   Default is OFF to display Aliases as found.   If set
  139. TRUE (0FFH),  all  aliases,  including hidden  if  the /S switch  is used, are 
  140. displayed in Upper Case.
  141.  
  142. NOTE 2
  143.    Terminal characters  per line  and lines per page.   Congigure to suit your 
  144. hardware, or preference (See Note 3).
  145.  ADIR Patch Table - 2/3 
  146.  
  147. NOTE 3
  148.    Set ALENTH to the  maximum number of characters in  an alias name.   If any 
  149. alias exceeds this length, you'll have trouble.  The number of aliases printed
  150. on  a line is  a function of ALENTH and TLINE.   With the default settings the 
  151. display is  eight columns wide.   The formula for the number of columns is the  
  152. integer of TLINE divided by ALENTH.  Thus if you want a display of six columns
  153. on  an  eighty character terminal,  set TLINE to 50H  and ALENTH to 0DH.   The 
  154. display would then be left justified with 13 chars allotted to each entry.
  155.  
  156.    As a footnote, it should be remembered that the larger ALENTH is, the fewer
  157. actual records ADIR will be able to handle.   This will not  be  a problem  in 
  158. most cases  as ADIR uses all  of available memory for the data table up to the 
  159. location of the CCP.  This means that with the default setting ALENTH=10, over 
  160. 4400 Aliases could be accomodated.  
  161.  
  162. NOTE 4
  163.    This is  the truncation character.   The semi-colon was chosen as it is the
  164. single character which is least likely to appear in  a command name, being the
  165. command separator character on most systems.
  166.  ADIR Patch Table - 3/3 
  167.  
  168. NOTE 5
  169.    DEFDU provides an alternate method of determining the default directory for
  170. non-wheel users.   If the first byte is  set to FF hex,  then  the normal ROOT 
  171. search method isused.   Otherwise, and  as the default, the default DU  may be
  172. specified.   Byte 1 represents the drive, where A=1; and byte 2 the user area,
  173. 0-31.   The ROOT search method is always used if the wheel byte is set and may 
  174. be overridden from the command line.
  175. :4
  176.  Error Messages   
  177.  
  178.    "du:ALIAS.CMD not found."                                
  179.  
  180.    - ADIR was unable to locate the file ALIAS.CMD in either the root directory
  181.      by default, or in the specified directory by user selection.
  182.  
  183.    "File too large. ABORTING"
  184.  
  185.    - ALIAS.CMD contains more  alias  names  than can  be  accommodated  in the
  186.      available TPA.
  187.  
  188.    "Can't Sort. File too large"
  189.  
  190.    - ADIR ran out of buffer space while attempting to sort the list.
  191.