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 / KAYPRO / K83Z33.LBR / V_ZFILER.DZC / V_ZFILER.DOC
Text File  |  2000-06-30  |  6KB  |  162 lines
  1. [the following has been taken from documentation supplied with VFILER version 
  2. 4.1, although the macro parameter character has been changed to what is now in 
  3. effect ($)]
  4.  
  5. Invoking User Macros
  6.  
  7.  
  8.   The VFILER command set is augmented by a set of user-definable macros
  9. contained in file VFILER.CMD.  VFILER performs parameter substitutions to
  10. build command lines.
  11.  
  12.  
  13.   Each defined macro has a unique identifier.  The identifier can be any
  14. printable character except a space.  There are two ways to invoke a macro,
  15. directly or indirectly:
  16.  
  17. Direct Invocation
  18.  
  19.   To invoke a macro directly press the lead-in character (default is ESC)
  20. followed by the macro identifier character.  As a special case, macros with
  21. digit identifiers (0..9) can be invoked without pressing the lead-in key.
  22.  
  23. Indirect Invocation
  24.  
  25.   A macro is invoked indirectly by striking "#" and waiting for the HELP
  26. Block of VFILER.CMD to be displayed.  The user then invokes the desired macro
  27. by pressing the identifier key.
  28.  
  29.  
  30. Search Path
  31.  
  32.   When a macro is invoked, VFILER searches along the path for VFILER.CMD,
  33. extracts the macro and expands it before it is executed.  Since VFILER
  34. searches for VFILER.CMD along the path, several VFILER.CMD files may be
  35. available for the user.
  36.  
  37.  
  38. Structure of VFILER.CMD
  39.  
  40.  
  41.   The structure of VFILER.CMD is quite simple.  It can be created by any
  42. text editor, and it consists of the following types of lines:
  43.  
  44.   1) a command line macro, which begins with a macro identifier that can be
  45.   any printable character except a space and which contains the text of the
  46.   macro to be expanded and executed.
  47.  
  48.   2) a help block, which is printed whenever the user types a pound
  49.   sign (#); this block is denoted by a line which begins with a pound sign,
  50.   and it extends from there to the end of the file
  51.  
  52.   3) a comment line, which is used to embed explanatory comments or a title;
  53.   a comment line is a command line which begins with a space.
  54.  
  55. Command line macros
  56.  
  57.   The command line macro consists of the macro identifier , zero or more
  58. spaces (which are ignored), and the text of the macro with embedded prompts
  59. for user input.
  60.  
  61.   Prompts are enclosed in single- or double-quotes ('  or  ").  When  VFILER
  62. executes these command lines, it prints the prompts contained within the quotes
  63. as they are encountered and waits for the user to input a line of text
  64. (terminated by a RETURN), at which point the text is substituted in the
  65. command line where the prompt is.  If a prompt extends to the end of a command
  66. line, it need not be terminated.  Spaces within the prompt are significant.
  67.  
  68. Example: 1 copy 'Source File? ' 'Destination Dir? '
  69.  
  70. When macro 1 is invoked, the user is prompted with "Source File?  ", he
  71. enters his text, it is substituted in the command line, he is prompted for
  72. "Destination Dir? ", he again enters a response, it is substituted,
  73. and the resulting command line is executed.
  74.  
  75. There are a number of parameters that VFILER will expand before placing the
  76. command line in the command buffer.  The values of the parameters are as
  77. follows:
  78.  
  79.           Symbol      Parameter
  80.             $D        Current Disk Letter
  81.             $U        Current User Number (1 or 2 digits)
  82.             $C        Current Named Directory (or "noname")
  83.             $F        Current File Name and Type (pointed to by arrow)
  84.         $N        Current File, Name only
  85.             $T        Current File, Type only
  86.             $P        Current File, Complete Spec DU:FILENAME
  87.             $H        Logged in DU:
  88.             $R        Logged in DIR:
  89.             $<char>   Inserts <char> in command line, where <char> is any
  90.             character other than those above (e.g., $$ or $")
  91.  
  92.  
  93. Examples: (A0:BASE logged in, A15:ROOT displayed, and pointing to MYFILE.TXT)
  94.  
  95.  
  96. macro:      Disk is $d, User is $u, File is $f
  97. expansion:  Disk is A, User is 15, File is MYFILE.TXT
  98.  
  99. macro:      Name is $"$N$", Type is $"$T$", Logged-in DIR is $"$R$"
  100. expansion:  Name is "MYFILE", Type is "TXT", Logged-in DIR is "BASE"
  101.  
  102.  
  103.   A "!" placed at the beginning of a macro will set the shell wait message
  104. so that you will get the "strike any key" message when VFILER is reloaded.
  105.  
  106. Help Block
  107.  
  108.   The Help Block in the VFILER.CMD file is simply a block of text which
  109. extends from the pound sign (#) in the file to the end of the file.
  110.  
  111. ^A will turn on highlighting (if defined in TCAP) and ^B will turn it off.
  112.  
  113. This help information is displayed to the user as one screen, and it is
  114. the responsibility of the person who writes the VFILER.CMD file to insure that
  115. this body of text (including the line the pound sign is on) does not exceed
  116. 22 lines.
  117.  
  118. Example:
  119.  
  120. #  Help for Word Processing
  121.  
  122.      1 - Run WordStar
  123.      2 - Run WordMaster
  124.      3 - Run ROFF4
  125.  
  126. Comment Line
  127.  
  128.   A comment line is any line in the command section of VFILER.CMD which
  129. begins with a space. The text of that line is the comment.  It is not
  130. displayed to the VFILER user and is used only for reference by the person
  131. who wrote the VFILER.CMD file.
  132.  
  133. Example:
  134.  
  135.     Edit Macro
  136. W $d$u:;ws $f;$h:
  137.     Assemble Macro
  138. A !$d$u:;zas $n;$h:
  139.  
  140. [the following information has been abstracted from information provided with 
  141. VFILER version 4.2]
  142.  
  143. VFILER now logs into the displayed directory (certain problems Sage warns from 
  144. this feature would appear to have been addressed in the recoding of ZCPR3 to 
  145. version 3.3).
  146.  
  147. File attributes are retained in renaming and moving, and there are options for 
  148. dealing with other operations.
  149.  
  150. Control J jumps to next file matching last given mask.  For example, when ^J 
  151. asks you what mask, you say ".D" for stand for all *.DOC files, then just keep 
  152. hitting ^J to get to each file in turn.
  153.  
  154. [the following information comes from documentation supplied with ZFILER 
  155. version 1.0a]
  156.  
  157. Macro designator changes to $ from %.
  158.  
  159. [further information should be gleaned from current ZFILER 1.0f documentation 
  160. and by an article by Rick Charnes called ZF10F.ART, which describe the 
  161. addition of a group user macro facility to ZFILER]
  162.