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 / BEEHIVE / ZSUS / Z3HELP-5.LBR / V.LBR / VFILER.HZP / VFILER.HLP
Text File  |  2000-06-30  |  20KB  |  537 lines
  1. ;
  2.  
  3.                       VFILER, Version 4.1
  4.  
  5.                        A - Overview 
  6.               B - Installation and Customization 
  7.  
  8.  
  9. F - Operations on Files             M - Invoking User Macros              
  10. G - Movement Commands               N - Creating User Macros (VFILER.CMD) 
  11. H - Miscellaneous Commands          O - ZEX and VFILER                    
  12.  
  13. I - VFILER Options                  P - Macro Parameter Summary           
  14.  
  15. :A
  16.  
  17.  
  18. Program:  VFILER
  19.  
  20. Syntax:
  21.  
  22.        VFILER               (show all files in default directory)
  23.        VFILER DIR: or DU:   (show all files in designated DIR:/DU:)
  24.        VFILER AFN           (show all files in default DU that match AFN)
  25.        VFILER DIR:AFN       (show all files in DIR: that match AFN)
  26.  
  27. Function:
  28.  
  29.   VFILER (for Video FILER) is a screen-oriented ZCPR3 shell used to work in
  30.   various ways with individual files or groups of files.  VFILER presents a
  31.   full-screen alphabetized display of the files in a specified directory that
  32.   match a specified file mask.  A pointer "-->" designates the current file.
  33.   A number of commands are available to allow the user to move the pointer
  34.   so that it is pointing to a file of interest.  Once pointing to such a
  35.   file, the user may perform any of a number of operations on it, such as
  36.   copying, deleting, or viewing.  One of the operations is to tag the file.
  37.   Group operations can then be performed on all tagged files at one time.
  38.  
  39.  
  40. Options:
  41.  
  42.   There are no options to be chosen while invoking VFILER other than the
  43.   selection of a directory, using either the DIR or DU form, and a file
  44.   mask using any ambiguous file specification, such as "*.COM".  See the
  45.   Options section of this help file for the VFILER options that can be
  46.   changed from within VFILER.
  47.  
  48. Special Features:
  49.  
  50.   The VFILER user is given added flexibility in his command possibilities
  51.   by the availability of user-definable macros.  These macros are like alias
  52.   scripts that form command lines based on the currently selected file.  The
  53.   macro definitions are contained in file VFILER.CMD, which is described in
  54.   a special section of this help file.
  55.  
  56. Error Messages:
  57.  
  58.   Self-explanatory.
  59.  
  60.  
  61.  
  62.  
  63. Examples of Use:
  64.  
  65.   VFILER is used for various file maintenance tasks, such as cleaning disks of
  66.   unwanted files, copying groups of files to other diskettes, or performing
  67.   automatic archival backup of modified files.  One common pattern of use is
  68.   to examine the display of files and to tag the files to be operated on.
  69.   Then the desired operation is performed quickly on the full set of tagged
  70.   files.  Because of the convenient and powerful macro facility, very general
  71.   operations, such as editing or assembling, can be performed on the file that
  72.   is pointed to.
  73.  
  74. :B
  75.  
  76. Installing VFILER
  77.  
  78.   This version of VFILER will automatically install itself on any ZCPR3
  79.   system unless that system uses a very unusual configuration, in which
  80.   case Z3INS is used as with other ZCPR3 programs.
  81.  
  82. Configuration
  83.  
  84.   There are three features of VFILER that some users might want to tailor to
  85.   their own preferences using a debugger or file patching utility.
  86.  
  87.   1. Macro scripts can be initiated using a lead-in key, whose default is the
  88.   escape key (ESC).  If a different key is desired, change the byte in the
  89.   first page of the file immediately after the string "CONFIG".
  90.  
  91.   2. When the macro help screen is displayed and the user selects an undefined
  92.   macro, an error message is displayed and, after a delay, the file display
  93.   is restored.  This delay time is set by the byte following the lead-in
  94.   character; the value represents the number of tenths of a second delay.
  95.   Caution: use only values from 1 to 255.  A value of 0 will give a delay of
  96.   nearly two hours!  The default value is 10 for a one second delay.
  97.  
  98.  
  99.  
  100.  
  101.   3. The next byte is a flag that allows VFILER to recognize macros "0" to "9"
  102.   without requiring the lead-in character.  As distributed, VFILER has this
  103.   option turned off.  Patch a byte of 0FFH to turn it on.
  104.  
  105.  
  106.  
  107. Command Table Addresses
  108.  
  109.  
  110.   For those who might wish to make changes to the command dispatch tables by
  111.   patching rather than reassembling, the addresses of the three command tables
  112.   are stored for reference just before the "CONFIG" marker.  The first table
  113.   is for commands that can be used only when files are displayed, the second
  114.   is for commands that can always be used (even when the ring is empty), and
  115.   the third is for group commands.
  116. :F
  117.  
  118. Operations on Files
  119.  
  120.  
  121. The following are the built-in operations that can be performed on files.
  122. All of them, except for "A", can be performed on individual files.  Those
  123. that have "(Group)" following the name of the operation can be performed on
  124. groups of files.  The Group counterpart of an operation is invoked by
  125. preceding the command by the group command "G".
  126.  
  127.  
  128. A - ARCHIVE  (Group Only)
  129. Archive files to another DIR area.  If the archive attribute of a tagged
  130. file is not set, then the file is copied to the designated DIR and, if the
  131. copy was successful, the archive attribute of the file is set.  Tagged files
  132. whose attribute bit was already set are not copied.
  133.  
  134.  
  135. C  - COPY  (Group)
  136. Copy file(s) to another DIR area.  A colon after the DU or DIR specification
  137. is optional.  The disk system is reset so that disks can be changed freely.
  138.  
  139.  
  140. D - DELETE  (Group)
  141. Delete file(s) from disk (prompts for verification).
  142.  
  143.  
  144. F  - FILE  SIZE  (Group)
  145. File size(s) in kilobytes,  rounded up to next disk allocation block.
  146.  
  147.  
  148. P - PRINT  (Group)
  149. Print file(s) to CP/M list device (printer).  Any keypress cancels.
  150.  
  151.  
  152. Q - UNSQUEEZE  (Group)
  153. Unsqueeze file(s).  User is prompted for directory in which to place
  154. unsqueezed file.
  155.  
  156.  
  157. R - RENAME
  158. Rename file in current directory.  Only CP/M convention names permitted.
  159. Wild cards are not permitted.  User is prompted for new file name.
  160.  
  161.  
  162.  
  163. T - TAG  (Group)
  164. Tag file name(s) to be operated on by a group command.  A file remains
  165. tagged  until either a disk log-in is selected, a group operation is
  166. performed, or the file is untagged by the user.  A "#" marker is placed
  167. after a tagged file name as a reminder that it is tagged.  A "'" (single
  168. quote) marker is placed by a file name that had been tagged before a group
  169. operation was performed on it.  The "Y" command (below) can be used to retag
  170. those previously tagged files.  The group tag command, "GT", tags all files
  171. selected by the current VFILER mask.  See the "W" command for a way to tag a
  172. specified group of files.
  173.  
  174.  
  175. U  - UNTAG  (Group)
  176. Untag file name (opposite of tag command).
  177.  
  178.  
  179.  
  180. V  - VIEW  (Group)
  181. View file(s) on console, with pagination or single-line turn-up.  <CTRL-C>
  182. cancels function.  <SPACE> advances to next line, and any other character
  183. advances one screen.  In group-view mode, <CTRL-X> skips to the next file.
  184. Only ASCII characters are processed.   Squeezed files are unsqueezed for
  185. viewing.
  186.  
  187.  
  188. W - WILD TAG
  189. Wildcard tag or untag of files.
  190.  
  191.  
  192. Y - RETAG
  193. Retag files that were untagged as the result of a group operation being
  194. performed on them (those with "'" next to their names).
  195. :G
  196.  
  197.  
  198. Movement Commands
  199.  
  200.  
  201. There are a number commands used to move the pointer to a file of interest.
  202. If cursor control keys are defined in the TCAP, they will work in VFILER.
  203. The TCAP definitions of control characters will, in all cases, override the
  204. definitions given to control characters by VFILER.
  205.  
  206.  
  207. The following are the WORDSTAR cursor control characters.  They will work
  208. in VFILER if they are not overridden by TCAP definitions.
  209.  
  210.  
  211.  
  212.                              ^E
  213.                               ^
  214.                          ^S <-+-> ^D
  215.                               v
  216.                              ^X
  217.  
  218. <SP>, <CR>  - NEXT FILE
  219. Advance to next file name.  Wraparound from last to first may occur.
  220. ^D also performs this function if not overridden by TCAP definitions.
  221.  
  222. <BS>  -  PREV FILE
  223. Back  up to previous file name.  Wraparound from first to last may occur.
  224. ^S also performs this function if not overridden by TCAP definitions.
  225.  
  226. J - JUMP
  227. Jump to a file.  Used to jump quickly to a specific file name.  User is
  228. prompted for a file spec, which may include wildcards (? and *).  Moreover,
  229. a wildcard "*" is automatically placed at the end of both the file name and
  230. type.  Thus "A" is equivalent to "A*.*" and ".B" to "*.B*".  User is
  231. positioned at first file that matches the file spec or at first file in ring
  232. if not found.
  233.  
  234. +  - NEXT SCREEN
  235. Jump to Next Screen (if any).  If there is more than one screen of file
  236. names, the user is advanced to the next screen.  If at the last screen,
  237. wraparound occurs to the first.  ^F also performs this function if not
  238. overridden by TCAP definitions.  ">" and "." also perform this function.
  239.  
  240.  
  241. - - PREV SCREEN
  242. Jump to Previous Screen (if any).  Similar to "+" but in the opposite
  243. direction.  Wraparound to last screen may occur.  ^A also performs
  244. this function if not overridden by arrow keys.  "<" and "," do also.
  245.  
  246.  
  247. ^R - TOP OF SCREEN
  248. Jumps to first file name in the current screen.
  249.  
  250.  
  251. ^C - END OF SCREEN
  252. Jumps to last file name in the current screen.
  253.  
  254.  
  255. ^T - FIRST FILE
  256. Jumps to first file name, regardless of current screen.
  257.  
  258.  
  259. ^B - LAST FILE
  260. Jumps to last file name, regardless of current screen.
  261. :H
  262.  
  263. Miscellaneous Commands
  264.  
  265. A - ALPHA SORT
  266. This command reverses the sense of the sort of the current directory,
  267. reloads the directory, and refreshes the screen, having sorted it in the
  268. new sense.  Sorting is done by file name and type or by file type and
  269. name.  See the "O" command for another way to do this.
  270.  
  271. E - REFRESH SCREEN
  272. Cleans up the screen.
  273.  
  274. H  - HELP VFILER
  275. Invokes external HELP Information.  VFILER will chain to HELP and display the
  276. information in VFILER.HLP.  VFILER checks to see if HELP can be found along
  277. path and does not attempt to chain if HELP.COM cannot be found.
  278.  
  279. L - LOGIN [DU/DIR][:MASK]
  280. Log in new directory area and/or new file mask.  A DU or DIR specification
  281. alone (no colon) changes the directory only and leaves the file mask the
  282. same.  A colon followed by a mask spec ("*.*" if colon only) changes only
  283. the file mask and not the directory.
  284.  
  285.  
  286.  
  287. O - OPTIONS
  288. Allow the user to view and selectively change the options.  For further
  289. information on available options see Options subsection of this help file.
  290.  
  291. S  - DISK STATUS
  292. Status of requested drive (shows remaining disk storage in kilobytes).
  293.  
  294. Z - ZCPR3 COMMAND
  295. Run any ZCPR3 Command Line.  User will be prompted for command line.  Note that
  296. the command will execute in the original DU area as indicated by the prompt.
  297.  
  298. X - EXIT VFILER
  299. Removes VFILER from the shell stack so that the user returns to the
  300. operating system or to the previous shell on the stack.
  301.  
  302. /  or  ?  - PRINT COMMAND SUMMARY  (Short Help Info)
  303. After viewing the summary, "/" will cause VFILER to redisplay the files.
  304. :I
  305. Options
  306.  
  307.   There are a number of options that can be set from within VFILER.  These
  308. options remain in force until the user exits VFILER with the "X" command.
  309. The options are changed using the "O" command.
  310.  
  311.   The user may create a new version of VFILER with the curent options as the
  312. default options using the ZCPR3 "SAVE" command.  This can be done from within
  313. VFILER by using the "Z" command.  The number of pages to save must have been
  314. determined in advance (version 4.1 is 55 pages as released).
  315.  
  316. The results of having the options set to "Y" (yes) are as follows:
  317.  
  318. 1 -  SINGLE REPLACE QUERY
  319. If a file to be copied or created by unsqueezing already exists in the
  320. destination directory, the user is asked whether he wants to delete it.
  321. If the user chooses not to, then the operation is cancelled.
  322.  
  323. 2 - GROUP REPLACE QUERY
  324. For each file that already exists in the destination directory, the user
  325. is asked whether he wants to delete it.  If the user chooses not to, then
  326. the next tagged file is processed.
  327.  
  328. 3 - ARCHIVE REPLACE QUERY
  329. For each file that is to be archived, if it exists in the destination
  330. directory, then the user is asked whether he wants to delete it.  If the
  331. user chooses not to, then the next tagged file is processed.
  332.  
  333. 4 - VERIFY QUERY
  334. Before any operation is performed involving copying or unsqueezing files, the
  335. user is asked whether he wants to employ CRC verification during the copy.
  336.  
  337. 5 - VERIFY DEFAULT
  338. If "verify query" is "N", then all copy/unsqueeze operations will employ CRC
  339. verification or not depending on this option.  If "verify query" is "Y", then
  340. this default answer will be used if the user responds with an answer other
  341. than "Y" or "N" when prompted about verification.
  342.  
  343. 6 - SUPPRESS SYS FILES
  344. VFILER does not display files with the SYS attribute set.
  345.  
  346. 7 -  SORT BY FILE NAME
  347. Displayed files are sorted by filename and type.  (If the option is set
  348. to "N" (no), then the files are sorted by type and filename.
  349. :M
  350.  
  351.  
  352.  
  353. Invoking User Macros
  354.  
  355.  
  356.   The VFILER command set is augmented by a set of user-definable macros
  357. contained in file VFILER.CMD.  VFILER performs parameter substitutions to
  358. build command lines.
  359.  
  360.  
  361.   Each defined macro has a unique identifier.  The identifier can be any
  362. printable character except a space.  There are two ways to invoke a macro,
  363. directly or indirectly, as explained on the next screen.
  364.  
  365.  
  366. Direct Invocation
  367.  
  368.   To invoke a macro directly press the lead-in character (default is ESC)
  369. followed by the macro identifier character.  As a special case, macros with
  370. digit identifiers (0..9) can be invoked without pressing the lead-in key.
  371.  
  372. Indirect Invocation
  373.  
  374.   A macro is invoked indirectly by striking "#" and waiting for the HELP
  375. Block of VFILER.CMD to be displayed.  The user then invokes the desired macro
  376. by pressing the identifier key.
  377.  
  378.  
  379. Search Path
  380.  
  381.   When a macro is invoked, VFILER searches along the path for VFILER.CMD,
  382. extracts the macro and expands it before it is executed.  Since VFILER
  383. searches for VFILER.CMD along the path, several VFILER.CMD files may be
  384. available for the user.
  385. :N
  386.  
  387.  
  388. Structure of VFILER.CMD
  389.  
  390.  
  391.   The structure of VFILER.CMD is quite simple.  It can be created by any
  392. text editor, and it consists of the following types of lines:
  393.  
  394.   1) a command line macro, which begins with a macro identifier that can be
  395.   any printable character except a space and which contains the text of the
  396.   macro to be expanded and executed.
  397.  
  398.   2) a help block, which is printed whenever the user types a pound
  399.   sign (#); this block is denoted by a line which begins with a pound sign,
  400.   and it extends from there to the end of the file
  401.  
  402.   3) a comment line, which is used to embed explanatory comments or a title;
  403.   a comment line is a command line which begins with a space.
  404.  
  405.  
  406.  
  407. Command line macros
  408.  
  409.   The command line macro consists of the macro identifier , zero or more
  410. spaces (which are ignored), and the text of the macro with embedded prompts
  411. for user input.
  412.  
  413.   Prompts are enclosed in single- or double-quotes ('  or  ").  When  VFILER
  414. executes these command lines, it prints the prompts contained within the quotes
  415. as they are encountered and waits for the user to input a line of text
  416. (terminated by a RETURN), at which point the text is substituted in the
  417. command line where the prompt is.  If a prompt extends to the end of a command
  418. line, it need not be terminated.  Spaces within the prompt are significant.
  419.  
  420. Example: 1 copy 'Source File? ' 'Destination Dir? '
  421.  
  422. When macro 1 is invoked, the user is prompted with "Source File?  ", he
  423. enters his text, it is substituted in the command line, he is prompted for
  424. "Destination Dir? ", he again enters a response, it is substituted,
  425. and the resulting command line is executed.
  426.  
  427.  
  428.  
  429. There are a number of parameters that VFILER will expand before placing the
  430. command line in the command buffer.  The values of the parameters are as
  431. follows:
  432.  
  433.           Symbol      Parameter
  434.             %D        Current Disk Letter
  435.             %U        Current User Number (1 or 2 digits)
  436.             %C        Current Named Directory (or "noname")
  437.             %F        Current File Name and Type (pointed to by arrow)
  438.         %N        Current File, Name only
  439.             %T        Current File, Type only
  440.             %$ or %P  Current File, Complete Spec DU:FILENAME
  441.             %H        Logged in DU:
  442.             %R        Logged in DIR:
  443.             %<char>   Inserts <char> in command line, where <char> is any
  444.             character other than those above (e.g., %% or %")
  445.  
  446.  
  447. See the next screen for some examples.
  448.  
  449.  
  450.  
  451. Examples: (A0:BASE logged in, A15:ROOT displayed, and pointing to MYFILE.TXT)
  452.  
  453.  
  454. macro:      Disk is %d, User is %u, File is %f
  455. expansion:  Disk is A, User is 15, File is MYFILE.TXT
  456.  
  457. macro:      Name is %"%N%", Type is %"%T%", Logged-in DIR is %"%R%"
  458. expansion:  Name is "MYFILE", Type is "TXT", Logged-in DIR is "BASE"
  459.  
  460.  
  461.  
  462.   A "!" placed at the beginning of a macro will set the shell wait message
  463. so that you will get the "strike any key" message when VFILER is reloaded.
  464.  
  465.  
  466.  
  467. Help Block
  468.  
  469.   The Help Block in the VFILER.CMD file is simply a block of text which
  470. extends from the pound sign (#) in the file to the end of the file.
  471.  
  472. ^A will turn on highlighting (if defined in TCAP) and ^B will turn it off.
  473.  
  474. This help information is displayed to the user as one screen, and it is
  475. the responsibility of the person who writes the VFILER.CMD file to insure that
  476. this body of text (including the line the pound sign is on) does not exceed
  477. 22 lines.
  478.  
  479. Example:
  480.  
  481. #  Help for Word Processing
  482.  
  483.      1 - Run WordStar
  484.      2 - Run WordMaster
  485.      3 - Run ROFF4
  486.  
  487.  
  488.  
  489. Comment Line
  490.  
  491.  
  492.   A comment line is any line in the command section of VFILER.CMD which
  493. begins with a space. The text of that line is the comment.  It is not
  494. displayed to the VFILER user and is used only for reference by the person
  495. who wrote the VFILER.CMD file.
  496.  
  497. Example:
  498.  
  499.     Edit Macro
  500. W %d%u:;ws %f;%h:
  501.     Assemble Macro
  502. A !%d%u:;zas %n;%h:
  503. :O
  504.  
  505.  
  506.  
  507. Running Zex from VFILER
  508.  
  509.  
  510.   Like all standard ZCPR3 Shells, VFILER is able to support the
  511. execution of the the ZEX command file processor on top of itself.  If ZEX
  512. is running, VFILER will simply prompt ZEX for input rather than entering
  513. its normal screen- oriented display mode.  In this way, a command executed
  514. from the VFILER.CMD file may invoke ZEX, and all of the ZEX command
  515. file processing will be performed before VFILER is reentered.
  516. :P
  517.  
  518.  
  519. Macro Parameter Summary
  520.  
  521.  
  522.           Symbol      Parameter
  523.  
  524.             %D        Current Disk Letter
  525.             %U        Current User Number (1 or 2 digits)
  526.             %C        Current Named Directory (or "noname")
  527.             %F        Current File Name and Type (pointed to by arrow)
  528.         %N        Current File, Name only
  529.             %T        Current File, Type only
  530.             %$ or %P  Current File, Complete Spec DU:FILENAME
  531.             %H        Logged in DU:
  532.             %R        Logged in DIR:
  533.             %<char>   Inserts <char> in command line, where <char> is any
  534.             character other than those above (e.g., %% or %")
  535. 
  536.                                                               Variables
  537.                           Dis