home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / znode3 / uploads / z3help43.lbr / FILT.HZP / FILT.HLP
Encoding:
Text File  |  1991-11-10  |  5.4 KB  |  114 lines
  1. ;
  2.                                    FILT.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                4k (30)   0393  8.10       Gene Pizzetta 10/91      Z3COM7
  6.  
  7.   1- Syntax/Options  2- Screen Display  3- Notes                              
  8.  
  9.  
  10.    FILT is a ZCPR3 utility that sets or expands tabs and removes several types
  11. of unwanted characters in ASCII text, WordStar documents, or assembler  source
  12. code files.   A summary of what the program found and what it did is presented
  13. upon completion.
  14.  
  15.    FILT is a Z'ified version of  FILT7  (vs 7.0a, 5/11/86)  by  Irv Hoff.  The
  16. various interactively-chosen modes have been converted into a group of logical
  17. command line options.
  18. :1
  19.  Syntax   FILT {dir:}infile {{dir:}outfile} {{/}options}
  20.  
  21.    Only the input filename is  required.   If no output filename is given, the
  22. default is the name of the input file.   Any existing file with the  same name
  23. in the destination directory will be renamed to filetype BAK.  If no DIR or DU
  24. specifications are given, the current directory is assumed.
  25.  
  26.    As distributed,  FILT  defaults to  ASCII text  mode.   Control  characters
  27. (except carriage returns and line feeds) are removed, high-bits are reset, and
  28. trailing spaces and tabs are removed.  Lines ending with only a line feed will
  29. have a carriage return inserted.  All tabs are expanded to spaces and then the
  30. file is retabbed in 8-column increments as long as a tab will  replace  two or
  31. more spaces.
  32.  Mode Options 
  33.  
  34.   Only one mode option should be given.   If more than one is given,  the last
  35. one found will be used.
  36.  
  37.      S    Source code.  Quoted strings are not retabbed, but even 
  38.           single spaces are replaced by tabs until a semi-colon 
  39.           is encountered.
  40.  
  41.      A    ASCII Text.  This is the default mode (see above).
  42.  
  43.      W    WordStar, no dot commands.  Lines beginning with a period
  44.           (dot commands) are removed, but ".pa" commands are replaced
  45.           by form feeds and existing form feeds are retained.  Soft 
  46.           carriage returns and binding spaces are converted to normal.
  47.           Soft hyphens at the end of a line are made normal, but other
  48.           soft hyphens (which are control characters) are removed.
  49.  
  50.      D    WordStar, with dot commands.  Identical to option W, above,
  51.           except that lines beginning with a period (dot commands) are
  52.           retained and ".pa" commands are not replaced by form feeds.
  53.  Other Options 
  54.  
  55.      T    Don't use tabs.  Tabs are expanded to spaces, but the 
  56.           file is not retabbed.
  57.  
  58.      Q    Quiet mode toggle.  If the ZCPR3 quiet flag is on, FILT 
  59.           defaults to quiet mode.  In that case, this option puts 
  60.           FILT in verbose mode.  If the quiet flag is off, this 
  61.           option puts FILT into quiet mode.  In quiet mode all 
  62.           screen output is suppressed except error messages and 
  63.           the usage screen.
  64.  
  65.    All options can be configured as the defaults using ZCNFG and the FILTn.CFG
  66. file.
  67. :2
  68.  Screen Display 
  69.  
  70.    By default, an incrementing line count is displayed while  FILT is working.
  71. The final summary screen varies  depending  on  the  current  file  mode.  The
  72. default summary shows counts of the total lines in the file,  original spaces,
  73. original tabs,  current spaces,  current tabs,  form feeds deleted,  high bits
  74. zeroed, control characters deleted,  orphan line  feeds  fixed,  and  trailing
  75. spaces deleted.
  76.  
  77.    In WordStar mode, the display shows the number of form feeds present, since
  78. they are not deleted.   It  also adds counts for dot  commands  deleted  (with
  79. option W), dot commands retained (with option D), soft carriage returns fixed,
  80. soft hyphens fixed, and binding spaces fixed.
  81.  
  82.    Under ZSDOS or ZDDOS, FILT will  transfer the  create  date  stamp from the
  83. source file to the new file.   If the source  file has  no  create  date,  the
  84. source file's modify date will be used instead.
  85.  
  86.    On error,  such as an invalid directory or a file not found,  FILT sets the 
  87. program error flag to the standard codes listed in Z34ERR.LIB  and invokes the
  88. error handler.   Even  a user  abort via  ^C  invokes  the  error handler so a
  89. pending SUB or ZEX operation can be aborted.
  90. :3
  91.  FILT Notes 
  92.  
  93.    a. Vs 8.1 updates (9/30/91, Gene Pizzetta):
  94.       - FILT did not check for  ambiguous  filenames  (and  never has),  which
  95.         could cause a small disaster.  It checks now.
  96.       - Made display of line count progress reports a configurable option.
  97.  
  98.    b. Vs 8.0 updates (9/10/91, Gene Pizzetta):
  99.       - Disassembled enough to change to a relocatable file (it was easy after
  100.         working on JUSTIFY).  
  101.       - Changed to Z80 opcodes to partially compensate for space used  by add-
  102.         itional features.  
  103.       - Replaced some routines with library routines.  
  104.       - Now allows destination directory without destination filename.  
  105.       - Changed key options to command line entry.  
  106.       - Changed some messages to make them more descriptive.  
  107.       - Added DU support,  intelligent usage screen, error flag setting, error
  108.         handler invocation, quiet mode, and ZCNFG configuration.  
  109.       - Under  ZSDOS and  ZDDOS file create date stamps are transferred to the
  110.         new file.  
  111.       - Incorporates some of the code efficiencies suggested for JUSTIFY.  
  112.  
  113.  
  114.