home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / ENTERPRS / CPM / UTILS / S / ZCNFG21.LZH / ZCNFGHLP.LZH / ZCNFG.HLP < prev    next >
Text File  |  1992-11-03  |  10KB  |  215 lines
  1. ;
  2.                                  Z C N F G
  3.  
  4.                        Z-SYSTEM CONFIGURATION EDITOR
  5.                                     FOR
  6.                       ZCPR and CP/M EXECUTABLE FILES
  7.  
  8.  
  9.  
  10.                        I -->  Introduction          
  11.                        C -->  Configuration Functions
  12.                        Q -->  Quick Configuration   
  13.                        S -->  Syntax                
  14.                        D -->  Defaults in ZCNFG     
  15.                        L -->  Locating CFG Files    
  16.                        H -->  Hints for Usage       
  17.                        W -->  Writing CFG Files     
  18. :I
  19. INTRODUCTION
  20.  
  21. ZCNFG is a universal configuration utility for programs like ZMAC, MCOPY, 
  22. ZXD, ZFILER, and many others.  The behavior of such programs is designed to 
  23. be modified by users without reassembly.  This is done by changing data at 
  24. known addresses in the first page of program code.  ZCNFG performs this 
  25. editing function in a particularly convenient way.  Data options are 
  26. displayed in one or more menus.  The current selection for each option is 
  27. displayed as part of the menu information.  HELP screens can be invoked for 
  28. assistance in selecting options.
  29.  
  30. ZCNFG is universal because it uses an overlay file to provide the menu 
  31. layout(s), Help screen(s), and the data specifying the location and nature 
  32. of each option.  An appropriate overlay must be present for each target 
  33. program.  ZCNFG loads the overlay (CFG) file automatically or as a result 
  34. of a command line specification.  The generation of overlays is discussed 
  35. in the section on 'Writing CFG Files' for those who wish to write such 
  36. files for their own use or for utilities they are writing.
  37.  
  38. ZCNFG is a CP/M compatible Z-system utility.  If ZCPR3/33/34 is present, 
  39. then ZCPR facilities are used to take advantage of the TCAP and named 
  40. directories.  ZCNFG will automatically configure ZCPR3 type 1, type 3 and 
  41. type 4 utilities.
  42.                    A. E. Hawley  (213) 649-3575 (voice)     
  43.                    Ladera Z-node:(213) 670-9465 (modem)
  44. :C
  45. CONFIGURATION FUNCTIONS
  46.  
  47. ZCNFG modifies bytes, words, and text strings in the configuration block 
  48. of the target program.  The menu may show the data itself or a logical 
  49. equivalent.  For example, toggling a byte between 0 and 0ffh may cause the 
  50. screen display to toggle between 'YES" and 'NO' or some other pair that 
  51. has meaning in the context of the target program.  The screen display, 
  52. target addresses to modify, and data interpretation are controlled by 
  53. information in the CFG file.  ZCNFG can also:
  54.  
  55.        Toggle any bit in a byte (8 YES/NO choices)
  56.        Rotate a bit within a field of bits in a byte (multiple choice)
  57.        Change the value of a byte with display/entry in HEX or Decimal
  58.        Change the value of a word with display/entry in HEX or Decimal
  59.        Replace a string of ASCII characters
  60.        Replace or modify a DU specification
  61.        Replace or modify a Z3-style File Specification
  62.  
  63. The menu prompt may include an acceptable range for numeric values; values 
  64. outside that range will be ignored.  This prevents entry of inappropriate 
  65. values for objects like a buffer size or a ZCPR3 system file number.  HELP 
  66. screens from the CFG file can be invoked to explain configuration items. 
  67. :Q
  68. QUICK CONFIGURATION with ZCNFG
  69.  
  70. Just type ZCNFG's name to get a help screen that explains how to invoke 
  71. ZCNFG.  Any form of the following invocation will work:
  72.  
  73.           ZCNFG [/[/]]       <== ? may replace the /
  74.  
  75. To configure a target file when it and its overlay file are on the 
  76. currently logged directory, use:
  77.  
  78.           ZCNFG <target filename>
  79.  
  80. This example assumes that the name of the overlay file is the same as the 
  81. targets name or is named in the targets configuration area. 
  82.  
  83. In the more general case, the target file may be in any directory on your 
  84. system.  You can use a full filespec form to tell ZCNFG where to find it. 
  85. You can also do that for the overlay file, naming it and its location 
  86. explicitly.  See SYNTAX for the full syntax and how you can take advantage 
  87. of it to configure files easily and quickly.
  88. :S
  89. SYNTAX
  90.  
  91. Here is the command form used to configure file TFS:
  92.  
  93.         ZCNFG  TFS CFS LFS  or  TFS LFS CFS
  94.  
  95.   where:    TFS = [TDIR:] [TFN] [.TFT]  = file to configure     (TGT)
  96.             CFS = [CDIR:] [CFN] [.CFT]  = configuration overlay (CFG)
  97.             LFS = /[LDIR:][LFN][.LFT]   = LBR of CFG overlays
  98.               or   [LDIR:][LFN].LBR
  99.  
  100. Each TGT file requires its own unique CFG file.
  101. TDIR, CDIR, and LDIR specify Drive and User and may be one of the 
  102. following forms: 
  103.  
  104. D:, U:, DU:, :, or (for Z-systems) DIR: 
  105.  
  106. TFN, CFN, and LFN are filenames for the TGT, CFG, and LBR files. 
  107. TFT, CFT, and LFT are their filetypes.
  108.  
  109. As implied, all parts of the specifications are optional; if everything is 
  110. omitted the help screen will be displayed.  The minimum meaningful command 
  111. specifies TFN; the target filename is explicitly declared.  If it's not in 
  112. the current directory, then you will also include one of the DIR forms so 
  113. that ZCNFG can find the target file. Defaults exist for all other parts.
  114.  
  115. Example invocations with $$=A5:, ALT:=C15:, CDIR default is TDIR
  116.  
  117. ZCNFG TGT B:            ;seeks CFG in B5:
  118. ZCNFG A15:TGT           ;seeks CFG in C15:CONFIG.LBR, A15:, C15:
  119. ZCNFG TGT /CFG01        ;seeks CFG in C15:CFG01.LBR,  A5:,  C15:
  120. ZCNFG TGT /B:           ;seeks CFG in B15:CONFIG.LBR, A5:,  C15:
  121. ZCNFG TGT B3:CFG01.LBR  ;seeks CFG in B3:CFG01.LBR,   A5:,  C15:
  122.  
  123. The order in which the directories shown above are searched is given 
  124.  in section L - Locating Overlay Files.
  125.  
  126. Other examples appear in the ZCNFG on-line HELP screen. (ZCNFG //)
  127. :D
  128. DEFAULTS USED BY ZCNFG
  129.  
  130.     Syntax Element      Default
  131.  
  132.         TDIR:           $$             (The current directory)
  133.         CDIR:           $$ or TDIR:    (ZCNFG configuration option)
  134.         LDIR:           ALT:           (see below)
  135.         TFN             (none)         command line argument
  136.         CFN             From TGT       (see below)
  137.         LFN             CONFIG         (configurable)
  138.         TFT             COM            (configurable)
  139.         CFT             CFG            (configurable)
  140.         LFT             LBR            (configurable)
  141.  
  142. ALT: is a configurable default within ZCNFG.  It is the directory in 
  143. which CFG overlays are normally kept.  ALT: may be specified as an 
  144. unambiguous DU or ambiguously (like B?: or ?15: or ??:).  The default 
  145. used for an ambiguous ALT: is $$. ZCNFG is distributed with ALT:=??. 
  146.  
  147. CFN is taken from the TGT configuration page if possible.  If there is 
  148. no recognizable name there, then ZCNFG uses TFN as the CFG filename. 
  149. :L
  150. LOCATING OVERLAY FILES
  151.  
  152.                 THE CONFIGURATION FILENAME
  153.  
  154. The ZCNFG command form is:
  155.  
  156. ZCNFG TFS_[CDIR:] [CFN] [.CFT]              (see SYNTAX)
  157.  
  158. If you have specified CFN, then that is the name that ZCNFG will use.  If 
  159. not, then ZCNFG looks in the target file configuration block for a filename 
  160. and uses that. If there is no name there, then the name of the CFG file is 
  161. assumed to be TFN. The CFT, if not included in the command, assumes the 
  162. default filetype, .CFG.
  163.  
  164. If you specify CDIR (even a ':') in the CFS portion of the command tail, 
  165. ONLY that directory will be searched for the CFG overlay file.  Note that 
  166. either TDIR or the logged DU provides defaults for CDIR, as chosen during 
  167. configuration of ZCNFG itself.
  168.  
  169. If you did NOT specify CDIR, ZCNFG searches 3 places for the CFG file:  
  170. ALT:CONFIG.LBR, the ALT: directory itself, and either TDIR (the target 
  171. directory) or the current directory. 
  172.                    THE SEARCH PATH
  173.  
  174. Here is a summary of the search path used when CDIR is unspecified:
  175.  
  176.      COMMAND         CFN source             SEARCH PATH
  177.      -------------   ---------       ---------------------------
  178.      ZCNFG TFS       TFN             ALT:CONFIG.LBR, DDIR:,  ALT:
  179.      ZCNFG TFS CFN   command line    ALT:CONFIG.LBR, DDIR:,  ALT:
  180.      ZCNFG TFS       CFG block       ALT:CONFIG.LBR,  ALT:, DDIR:
  181.   (DDIR is configured as TDIR or the current DIR)
  182.  
  183. CONFIG.LBR, if it exists, is always searched first.  The search order for 
  184. the other two depends on the source of the CFN.  If it comes from the 
  185. configuration block in the target then the ALT: directory is searched 
  186. first.  If CFN comes from the command tail or the TFN, DDIR is searched 
  187. first.
  188.  
  189. The object of this search strategy is to permit normal invocation with an 
  190. implied overlay filespec.  The search path is arranged so that in normal 
  191. use the CFG file will be found in the first path element.  If the target 
  192. program contains the name of its overlay file as described, the overlay is 
  193. very likely to be found even if the target program has been renamed.
  194. :H
  195. HINTS ON USING ZCNFG
  196.  
  197. Each element of the search path requires a disk directory access.  To 
  198. minimize these time consuming directory searches:
  199.  
  200.      Put all your .CFG files in one directory in a library named 
  201.      CONFIG.LBR.  Use another name if you wish, but see below.
  202.  
  203.      If you don't use the LBR approach, put all the CFG files in one 
  204.      directory.
  205.  
  206.      Configure ZCNFG, changing the ALTERNATE Directory to the one that 
  207.      contains your CFG files.  If you don't like CONFIG as the library 
  208.      name, change it to whatever you have named your library.  The result 
  209.      is that normal invokations will only require ONE directory access to 
  210.      find the CFG file.
  211.  
  212. When you're trying out a new CFG file, name its directory explicitly in the 
  213. command tail.  Again, only one directory access. Speedy!
  214. :W:ZCFG.HLP
  215.