home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / PWAECD11.ZIP / ECDIZ.DOC < prev    next >
Encoding:
Text File  |  1995-09-03  |  7.6 KB  |  166 lines
  1. +----------------------------------------------------------------------------+
  2. | Enhanced CleanDIZ v1.1                                                     |
  3. | Written by Drew [PWA]                                                      |
  4. | Docs last updated 09-03-95                                                 |
  5. +----------------------------------------------------------------------------+
  6.  
  7.  
  8. +-----------------------------------------------------------------------------+
  9. | 0. Table of Contents                                                        |
  10. +-----------------------------------------------------------------------------+
  11.     1. Introduction
  12.     2. Packaging
  13.     3. Installation
  14.     4. Configuration
  15.     5. Included Batch Files
  16.     6. Other Program Information
  17.     7. Contacting the Author
  18.  
  19.  
  20. +----------------------------------------------------------------------------+
  21. | 1. Introduction                                                            |
  22. +----------------------------------------------------------------------------+
  23.     Enhanced CleanDIZ (ECDIZ) is a utility which will strip unnecessary
  24. and unwanted lines from the FILE_ID.DIZ description files.  Although it was
  25. designed with FILE_ID.DIZ in mind, in actuality, it works with *any* type of
  26. file.  That means you can strip any set of lines from any type of file.
  27.  
  28.     Its selectable features include:
  29.  
  30.         - Keeping original FILE_ID.DIZ timestamp
  31.         - Ignoring upper/lower case
  32.         - Strip blank lines
  33.         - Strip PCBoard @-color codes (ie: @X1F)
  34.         - Strip Forum Pipe color codes (ie: |14)
  35.         - Strip exact line matches (default: key)
  36.         - Strip high-ascii characters
  37.         - Strip lines with no text
  38.         - Truncate lines to specified width
  39.  
  40.     Other attractions:
  41.  
  42.         - Extremely fast execution (386 or better required)
  43.         - No built-in limit to the number of lines to strip
  44.         - All command-line driven; no config files to muck with
  45.         - Keeps pkzip & pkunzip calls external (so you have more
  46.           control over the pkzip/pkunzip options, or even if you
  47.           want to use some other archive compressor)
  48.  
  49.     This documentation will be focused on FILE_ID.DIZ and PCBoard.  Any
  50. other particular combination will be up to your imagination.
  51.  
  52.  
  53. +-----------------------------------------------------------------------------+
  54. | 2. Packaging                                                                |
  55. +-----------------------------------------------------------------------------+
  56.     Your zip file should contain the following files:
  57.  
  58.         ECDIZ.EXE      Main executable for 386's and up.
  59.         ECDIZ2.EXE     Executable for 286's.
  60.         EZDIZ.DOC      Documentation (you are reading it now).
  61.         STRIP.DIZ      Data file containing tag lines for stripping.
  62.         TEST.BAT       Sample batch file used for testing.
  63.         UPLOAD.BAT     Sample batch file for upload processing.
  64.         HISTORY.DOC    Revision history.
  65.         OTHERDJP.DOC   Other stuff I've written.
  66.         FILE_ID.DIZ    File (zip) description.
  67.         PWA.NFO        PWA info file.
  68.         TSP.NFO        My bbs ad.
  69.  
  70.     If any of these files are missing, be warned that you may have a copy
  71. that has been tampered with.  If you have any extra files, they are
  72. extraneous and unnecessary.
  73.  
  74.     Typically, my bbs ad may not be there, which is not a problem.  However,
  75. the idiots who contribute this to the fidonet backbone (usually originating
  76. from the Clipper Workshop BBS) edit the FILE_ID.DIZ, remove PWA.NFO and
  77. OTHERDJP.DOC, and insert their own bbs ad which is bigger than most ppe's.
  78. Just be aware, since who knows what other stupidities they may pull.
  79.  
  80.  
  81. +----------------------------------------------------------------------------+
  82. | 3. Installation                                                            |
  83. +----------------------------------------------------------------------------+
  84.     The best place to install this would be just after a successful CRC
  85. test somewhere during processing an uploaded file.  Refer to UPLOAD.BAT for
  86. an example of what to do.
  87.  
  88.     ECDIZ.EXE is compiled for 386 and better processors.  ECDIZ2.EXE is for
  89. 286's.  Pick the one that is most applicable.  If you have anything less than
  90. a 286, you are in the stone age. :)
  91.  
  92.  
  93. +----------------------------------------------------------------------------+
  94. | 4. Configuration                                                           |
  95. +----------------------------------------------------------------------------+
  96.     Typing "ECDIZ" on the command line will provide you with all the
  97. various options available:
  98.  
  99.     They should all be self-explanatory and if not, the best way to find
  100. out what an option does is to try it (see TEST.BAT).
  101.  
  102.     "STRIP.DIZ" contains the file used for removing unwanted lines.  By
  103. default, lines in this file match lines contained within lines in the diz
  104. file being processed by "key".  That means if a diz line contains (but not
  105. necessarily matching exactly) a line in STRIP.DIZ, the diz line will be
  106. removed.  If you want to use exact matches, use the "-E" option.
  107.  
  108.  
  109. +----------------------------------------------------------------------------+
  110. | 5. Included Batch Files                                                    |
  111. +----------------------------------------------------------------------------+
  112.     Two batch files have been included as examples of possible usages
  113. of ECDIZ.  All batch files are for DOS 6.x.
  114.  
  115. UPLOAD.BAT
  116.  
  117.     Shows how and where to install ECDIZ as part of the upload processing
  118.     sequence.  Uses PCBoard with PKZip as an example.
  119.  
  120. TEST.BAT
  121.  
  122.     Used for testing new ECDIZ options.  Saves you from typing everything
  123.     on the command line. :)
  124.  
  125.  
  126. +----------------------------------------------------------------------------+
  127. | 6. Other Program Information                                               |
  128. +----------------------------------------------------------------------------+
  129.     This utility is FREEWARE.  No registration is required and there are
  130. no nag screens.  However, comments, suggestions and donations will certainly
  131. be accepted. :)  If you find this little utility useful, feel free drop me a
  132. quick note.
  133.  
  134.     I only know of three other programs in the past which did something
  135. similar to this.  One was from Q-Tip, another from Aegis, and the third from 
  136. some public domain(?) person.  All of them either simply did not have enough
  137. options to meet the extremely annoying (lame) tag lines that people add to
  138. diz's nowadays, or they were limited to only *.ZIP files.  Even though most
  139. systems and most archive files are in ZIP format anyway, I felt that the
  140. presence of this flexibility was worthwhile to have archive procedures not
  141. built-in.
  142.  
  143.     ECDIZ was written and compiled using Borland C++ v3.1.  It has been
  144. tested on DOS 6.x, OS/2 v3.0, and Novell Netware 3.12.  It should also work
  145. on other DOS compatible operating systems.
  146.  
  147.     (Author's node: Actually, ECDIZ is an extremely trimmed down version
  148. of my DIR-shrinker, which may or may not be released in the future).
  149.  
  150.  
  151. +----------------------------------------------------------------------------+
  152. | 7. Contacting the Author                                                   |
  153. +----------------------------------------------------------------------------+
  154.     I am rarely on IRC, so don't be a dork and bother other PWA members.
  155. Don't ask for source, and don't ask to be a distribution site, because we
  156. don't have any.
  157.  
  158. You can reach me in the following ways:
  159.  
  160.     Internet email : drew@xinet.com
  161.  
  162.     Other          : Attitude Net
  163.  
  164. Peace,
  165. --Drew
  166.