home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / util2 / ph-utils.lzh / CLEANZ.DOC < prev    next >
Text File  |  1989-07-11  |  23KB  |  715 lines

  1.  
  2.  
  3.                   CleanZ
  4.  
  5.  
  6.  
  7.                   Control-Z Strip or Replace Utility
  8.  
  9.  
  10.  
  11.                   Version  1.00
  12.                   Released 05-17-89
  13.  
  14.  
  15.  
  16.  
  17.                   Herron Software
  18.                   P.O. Box 1288
  19.                   Battle Ground, Washington  98604
  20.  
  21.  
  22.  
  23.  
  24.          COPYRIGHT 1988, 1989 Phil Herron.  ALL RIGHTS RESERVED.
  25.  
  26.  
  27.                   DISCLAIMER OF WARRANTY
  28.             __________________________________________
  29.  
  30.  
  31.             THIS PRODUCT IS LICENSED AS IS AND WITHOUT
  32.             WARRANTY OF ANY KIND.  THE AUTHOR MAKES NO
  33.             EXPRESS OR IMPLIED WARRANTIES WITH REGARD
  34.             TO THIS PRODUCT, INCLUDING BUT NOT LIMITED
  35.             TO MERCHANTABILITY OR FITNESS FOR ANY
  36.             PURPOSE.  IN NO EVENT SHALL THE AUTHOR BE
  37.             LIABLE FOR LOSS OF PROFIT OR ANY OTHER
  38.             COMMERCIAL DAMAGE ARISING FROM EITHER THE
  39.             USE OF OR THE INABILITY TO USE THIS PRODUCT.
  40.  
  41.  
  42.             This product should be thoroughly evaluated
  43.             using backed up or noncritical data and files.
  44.  
  45.  
  46.  
  47.  
  48.  
  49.    _________________________________________________________________
  50.  
  51.    Table of Contents                                         Section
  52.    _________________________________________________________________
  53.  
  54.    Shareware.................................................. 0.1.0
  55.       What it is.............................................. 0.1.1
  56.       License Terms........................................... 0.1.2
  57.       Registration............................................ 0.1.3
  58.  
  59.    Evaluation................................................. 0.2.0
  60.       Evaluation Version...................................... 0.2.1
  61.       Evaluation Menu......................................... 0.2.2
  62.       Virus Prevention........................................ 0.2.3
  63.  
  64.    CleanZ..................................................... 1.0
  65.       Introduction............................................ 1.1
  66.       Explanation............................................. 1.2
  67.       System Requirements..................................... 1.3
  68.          Installing........................................... 1.3.1
  69.       Help.................................................... 1.4
  70.       Syntax.................................................. 1.5
  71.       Replacement characters.................................. 1.6
  72.       Examples................................................ 1.7
  73.       Applications............................................ 1.8
  74.       Version History......................................... 2.0
  75.  
  76.    Support.................................................... 9.0
  77.       Problem Resolution...................................... 9.1
  78.       Before Reporting........................................ 9.2
  79.       Reporting a problem..................................... 9.3
  80.       Custom Modifications.................................... 9.4
  81.       Correspondence.......................................... 9.5
  82.  
  83.    Product Catalog........................................... 10.0
  84.  
  85.  
  86.  
  87.  
  88. _________________________________________________________________
  89.  
  90. 0.1.0          Shareware
  91. _________________________________________________________________
  92.  
  93.  
  94.  
  95.  
  96. 0.1.1   The SHAREWARE Concept
  97. _____________________________
  98.  
  99.    "Shareware" is a software distribution method which enables
  100.    the potential user to obtain software at very low initial
  101.    cost, for evaluation on a trial basis.
  102.  
  103.    You can evaluate the software in your own environment, on your
  104.    own machine, with the programs and data that you normally use.
  105.    You're not required to make payment and become a registered
  106.    user unless the software meets your needs.
  107.  
  108.    Another benefit of Shareware is lower pricing.  By minimizing
  109.    the marketing and advertising expenses associated with more
  110.    traditional software distribution methods, Shareware products
  111.    can be priced lower.  You don't pay for what you don't need or
  112.    use.
  113.  
  114.    You are encouraged to share the evaluation version of this
  115.    software with others, so long as you follow the limitations
  116.    set forth in the LICENSE TERMS section below.
  117.  
  118.  
  119.  
  120.  
  121. 0.1.2   LICENSE TERMS
  122. _____________________
  123.  
  124.    This product and its documentation are copyrighted and owned
  125.    solely by the author, who reserves all rights to any benefits
  126.    derived from it.  It is distinctly separate from, and should
  127.    not be confused with, those categories of software known as
  128.    "public domain" or "freeware."
  129.  
  130.    You are granted without charge a limited license to use the
  131.    evaluation version of this software on a trial basis, for
  132.    purposes of deciding whether to continue using (and therefore
  133.    whether to register) the product, and to transmit this
  134.    evaluation version to associates by copying on diskette or
  135.    uploading to electronic bulletin board services, so long as
  136.    the following CONDITIONS are met:
  137.  
  138.       (a) The program and its documentation file must be
  139.           distributed together.
  140.  
  141.       (b) The program and its documentation must not be
  142.           altered in any way.  If you wish to include
  143.           notes for other evaluators, please add them in
  144.           a separate file and include that file along
  145.           with the program and documentation files.
  146.  
  147.  
  148.  
  149.  
  150. 0.1.3   REGISTRATION
  151. ____________________
  152.  
  153.       When you send in the registration form and fee, you'll
  154.       receive by return mail a diskette containing the latest
  155.       REGISTERED version of the program and documentation.
  156.  
  157.  
  158.    BENEFITS OF REGISTRATION
  159.  
  160.       The registered version WILL NOT include the Evaluation Menu
  161.       front-end or the forms-printing section of this version.
  162.       Thus it will be more convenient to use, from either the DOS
  163.       prompt or from batch files.  It will also be about 16K
  164.       bytes smaller, for more efficient disk storage and faster
  165.       loading.
  166.  
  167.       The registered version WILL include any new functions
  168.       or enhancements made to date.
  169.  
  170.       You will receive notification of future updates and
  171.       new products.
  172.  
  173.       You will be able to upgrade to newer versions at a
  174.       reduced cost.
  175.  
  176.  
  177.    REGISTRATION FORM
  178.  
  179.       The registration form and a pre-addressed mailing cover
  180.       can be printed from the "Forms Printing" selection of
  181.       the Evaluation menu, discussed in section 0.2.2 below.
  182.  
  183.  
  184.    FEES
  185.  
  186.       The single-quantity registration fee is displayed on the
  187.       initial Evaluation Menu screen.  Higher quantities are
  188.       discussed below.
  189.  
  190.  
  191.    QUANTITY DISCOUNTS
  192.  
  193.       Each registered copy of this software will be licensed for
  194.       operation at only one location (on only one machine) at any
  195.       one time.  If this software will be in use at more than one
  196.       location at the same time, the appropriate number of
  197.       registrations must be made.
  198.  
  199.       Multiple-quantity registration fees are displayed in the
  200.       "QUANTITY DISCOUNT" section of the Evaluation menu.
  201.  
  202.       You can take advantage of quantity discounts by ordering
  203.       multiple registrations of one program or single
  204.       registrations of several different programs at the same
  205.       time.  You also save on shipping and handling charges
  206.       by registering several products together.
  207.  
  208.  
  209.    GROUP REGISTRATIONS
  210.  
  211.       You can also get quantity discounts by combining orders with
  212.       associates:
  213.  
  214.          (1)   Complete a separate registration form for each person.
  215.                   Each person's name, address and programs to be
  216.                   registered are needed for support and update
  217.                   notification purposes.
  218.  
  219.          (2)   Include only one standard shipping and handling charge.
  220.                   Cross out the "Shipping & handling" amounts on
  221.                   all but one registration form; the combined
  222.                   order will be sent to the name and address on
  223.                   that form.
  224.  
  225.          (3)   Send all the forms together in one envelope or mailing
  226.                   cover, with a single check or money order.
  227.  
  228.  
  229.  
  230.  
  231. _________________________________________________________________
  232.  
  233. 0.2.0          Evaluation
  234. _________________________________________________________________
  235.  
  236.  
  237.  
  238.  
  239. 0.2.1   EVALUATION VERSION
  240. __________________________
  241.  
  242.    This software contains the complete and fully functional version
  243.    of the program, the latest available at the time of this release.
  244.  
  245.    The program itself is identical to the REGISTERED version.
  246.    An Evaluation Menu and forms-printing section were added
  247.    to ensure that:
  248.  
  249.       (a)   Registration information and forms will not
  250.             become separated from the program file.
  251.  
  252.       (b)   Users who might be unfamiliar with the process
  253.             of displaying a file's contents on the screen or
  254.             printer will have no difficulty learning about,
  255.             evaluating or registering this product.
  256.  
  257.  
  258.  
  259.  
  260. 0.2.2   EVALUATION MENU
  261. _______________________
  262.  
  263.    The program is invoked from the DOS prompt by typing its name
  264.    and pressing the RETURN or ENTER key.
  265.  
  266.  
  267.    The initial screen displays the warranty section and some
  268.    information about the program:
  269.  
  270.       Program name,
  271.       Version number,
  272.       Release date,
  273.       Single-quantity registration fee.
  274.  
  275.  
  276.    It next displays the Shareware Product EVALUATION MENU.
  277.    A single key press will select the following functions
  278.    from the menu:
  279.       _________________________________________
  280.  
  281.       ESC - EXIT to DOS without evaluating this program
  282.  
  283.        R  - READ the documentation (THIS file)
  284.  
  285.        x  - EVALUATE this program
  286.  
  287.        Q  - QUANTITY Discount information
  288.  
  289.        F  - FORMS printing menu - registration & mailer
  290.       _________________________________________
  291.  
  292.  
  293.    When you press "R" to READ the documentation, this file will
  294.    be shown one screen at a time.  The display pauses whenever the
  295.    screen becomes full, and prompts...
  296.  
  297.                      <downArrow> or Esc
  298.  
  299.    The <downArrow> character is similar to the "MORE" prompt in
  300.    other DOS utilities.  It indicates that more is available.
  301.    Press ESCape to exit back to the Evaluation Menu, or any normal
  302.    typing key to continue (space bar is a convenient key to use).
  303.  
  304.  
  305.  
  306.  
  307. 0.2.3   VIRUS PREVENTION
  308. ________________________
  309.  
  310.    If you'd like to evaluate this software but you're not sure
  311.    where it's been, you can get a copy straight from the source
  312.    for a $4.00 charge to cover the cost of the diskette, shipping
  313.    and handling.  If your address is outside the U.S. and Canada,
  314.    add an additional $3.00 (total $7.00, in U.S. funds).
  315.  
  316.    Include your mailing address and the name of the program.
  317.    By return mail you'll receive the latest evaluation version
  318.    of that program and as many others as will fit on a 5.25
  319.    inch diskette.
  320.  
  321.  
  322.  
  323.  
  324. ______________________________________________________________
  325.  
  326.                CleanZ
  327. 1.0
  328.                Control-Z Strip or Replace Utility
  329. ______________________________________________________________
  330.  
  331.  
  332.  
  333.  
  334. 1.1   INTRODUCTION
  335. __________________
  336.  
  337.    The personal computer can be a convenient note-taker and organizer;
  338.    with a small pop-up notepad utility or text editor, you can save
  339.    ideas, research notes and lists of things in small text files, and
  340.    have them immediately available.  You can separate different
  341.    subjects into different filenames.
  342.  
  343.    Another related use for small text files is in saving selected
  344.    messages extracted from BBS (bulletin board system) capture files.
  345.  
  346.  
  347.    Sooner or later you might want to consolidate some of these files
  348.    into larger ones, to gather related notes or to save disk space.
  349.  
  350.    A convenient way to combine files is to use the DOS TYPE command,
  351.    with the special characters >> to redirect output and append it to
  352.    an existing file.  For example, to add the contents of fileTwo.Doc
  353.    to the end of fileOne.Doc, issue
  354.  
  355.             TYPE fileTwo.Doc >>fileOne.Doc
  356.  
  357.    from the DOS prompt.
  358.  
  359.  
  360.    The need for a utility such as CleanZ arises when you load the
  361.    combined file into your text editor; you see the text from the
  362.    first file, but the second file is missing!  Yet, if you look at
  363.    the file in a DIR listing, its size indicates that it does contain
  364.    the text from both files.
  365.  
  366.  
  367.  
  368.  
  369. 1.2   EXPLANATION
  370. _________________
  371.  
  372.    Many text editors and word processors (including the DOS EDLIN
  373.    utility) indicate the end of a text file by automatically writing
  374.    a control-Z (1A hex, 26 decimal; also written as ^Z) as the final
  375.    character in that file.  Some word processors write a whole series
  376.    of ^Z characters at the end of a file.
  377.  
  378.    The control-Z character is also known as EOF, since it
  379.    indicates "End Of File."
  380.  
  381.  
  382.    If you later append more text after the ^Z, then try to edit
  383.    the file, you won't find the appended text.  The editor
  384.    cannot "see" beyond the "End-Of-File" character.
  385.  
  386.    A way around this limitation is to delete the ^Z character,
  387.    or change it to some other character, so your editor will
  388.    read beyond it to the appended text.
  389.  
  390.    CleanZ performs this function by reading the specified file,
  391.    then writing a new file without the ^Z characters (or optionally
  392.    changing them to another selected character).  It saves the
  393.    original file with the extension .BAK.
  394.  
  395.  
  396.  
  397.  
  398. 1.3   SYSTEM REQUIREMENTS
  399. _________________________
  400.  
  401.    PC, XT, AT or compatible.
  402.    DOS version 2.1 or later.
  403.    80K free memory.
  404.  
  405.  
  406.  
  407.  
  408. 1.3.1   INSTALLING
  409. __________________
  410.  
  411.    The program can be run from floppy diskette or from hard
  412.    disk.  No installation is necessary, other than copying
  413.    the files to a drive and directory of your choosing.
  414.  
  415.  
  416.  
  417.  
  418. 1.4   HELP
  419. __________
  420.  
  421.    Can't remember the command line syntax?
  422.    Issue the program's name without any parameters; it
  423.    will display a help screen, then return to the DOS prompt.
  424.  
  425.  
  426.  
  427.  
  428. 1.5   SYNTAX
  429. ____________
  430.  
  431.  
  432.                                optional replacement character
  433.                                /
  434.       CleanZ [filespec] [/replChar]
  435.  
  436.  
  437.          Where [filespec] is the string needed to reference a file;
  438.          can also be shown as [d:][path][filename.ext].
  439.  
  440.          The minimum filespec needed is filename.ext. If the file
  441.          is in another directory and/or on another drive, the
  442.          drive name and/or pathname must also be given.
  443.  
  444.          The complete filespec for a file named ThisFile.Doc
  445.          residing in drive A: in a subdirectory named ThisSub is
  446.  
  447.                A:\ThisSub\ThisFile.Doc
  448.  
  449.          For further information on filespecs, see your DOS manual.
  450.  
  451.  
  452.  
  453.  
  454. 1.6   REPLACEMENT CHARACTER
  455. ___________________________
  456.  
  457.    The replacement character is optional, and serves as a place marker
  458.    in the cleaned file.  You might use a replacement character if you
  459.    want to later find the position in the text where a particular file
  460.    began or ended.
  461.  
  462.    If no replacement character is entered on the command line, all
  463.    control-Z characters found in the file will be simply stripped out.
  464.  
  465.  
  466.    A replacement character, if used, must be preceded by a slash.
  467.  
  468.    The replacement character should not be any of these three:
  469.  
  470.             <  >  |
  471.  
  472.    which are used by DOS for redirection and piping.  Nothing
  473.    catastrophic will occur if you do use one of the three; the
  474.    program will terminate with an error message:
  475.  
  476.          CleanZ filename.ext /|   -  "Syntax Error"
  477.          CleanZ filename.ext />   -  "File creation error"
  478.          CleanZ filename.ext /<   -  "File not found"
  479.  
  480.    In addition, you should not use the forward slash ( / ) for a
  481.    replacement character; it will be ignored, and the program will
  482.    strip out all ^Z's instead of replacing them.
  483.  
  484.    Aside from the above restrictions, any other characters can be
  485.    used, including special characters entered with the ALT key, in
  486.    ALT-nnn format.
  487.  
  488.  
  489.  
  490.  
  491. 1.7   EXAMPLES
  492. ______________
  493.  
  494.       CleanZ a:\docSub\myfile.doc
  495.  
  496.             Reads myfile.doc on drive A: in subdirectory docSub;
  497.             strips all ^Z characters from the file, then stores
  498.             the cleaned version in the same subdirectory.
  499.  
  500.       CleanZ a:\docSub\myfile.doc /~
  501.  
  502.             Same actions as above, except that ^Z characters are
  503.             replaced by ~.
  504.  
  505.  
  506.  
  507.  
  508. 1.8   APPLICATIONS
  509. __________________
  510.  
  511.    A sample application is shown below.  Combine.Bat can be used
  512.    to combine several files into one.
  513.  
  514.    Command-line syntax:
  515.  
  516.          Combine [FirstFile] [SecondFile]
  517.  
  518.  
  519.    Usage:
  520.  
  521.       Combine Main.Doc Temp.Txt
  522.  
  523.          will append Temp.Txt onto the end of Main.Doc, then run
  524.          CleanZ on the result to convert all control-Z characters
  525.          to tilde (~) characters.
  526.  
  527.  
  528.    Listing of Combine.Bat:
  529.  
  530.       :::: TextFile combining utility - uses CleanZ.Exe
  531.       echo off
  532.       If "%2"=="" goto NoSpec
  533.       If "%1"=="" goto NoSpec
  534.       echo Will combine files in order: %1 + %2
  535.       echo Ctrl-Break to terminate now, or
  536.       Pause
  537.       Type %2 >>%1
  538.       CleanZ %1 /~
  539.       goto End
  540.       :NoSpec
  541.       echo Syntax:  %0 fileSpec1 fileSpec2
  542.       echo   Appends file2 to end of file1.
  543.       echo   Calls CleanZ.exe to convert any embedded ^Z EOF marks to ~
  544.       echo    (to indicate where first file ends & second begins).
  545.       :END
  546.  
  547.  
  548.    Notes:
  549.       1 - There are several ways to convert the above listing
  550.           into batch file form.  One is to copy this entire file
  551.           to another named "Combine.Bat", delete everything except
  552.           the listing, then delete the leading spaces on the left
  553.           side so each line begins in column one.
  554.           Another is to display the listing on screen and use a
  555.           memory-resident notepad to "cut and paste" it into a
  556.           batch file.
  557.  
  558.       2 - Multiple colons in the listing are used for comment
  559.           lines.
  560.  
  561.  
  562.  
  563.  
  564. 2.0   VERSION HISTORY
  565. _____________________
  566.  
  567.    1.00  Initial release.
  568.  
  569.  
  570.  
  571.  
  572. _________________________________________________________________
  573.  
  574. 9.0            Support
  575. _________________________________________________________________
  576.  
  577.  
  578.  
  579.  
  580. 9.1   PROBLEM RESOLUTION
  581. ________________________
  582.  
  583.    Please document and report any anomaly in program operation,
  584.    whether it's a genuine "bug" or just some feature of the
  585.    program that particularly "bugs" you.
  586.  
  587.    If you're the first person to document and report a problem
  588.    that we agree needs attention, you'll receive a free upgrade
  589.    with the correction when it's been made.  If you're a
  590.    registered user, you'll get the upgraded registered version;
  591.    if you haven't yet registered, you'll get the upgraded
  592.    evaluation version.
  593.  
  594.  
  595.  
  596.  
  597. 9.2   BEFORE REPORTING
  598. ______________________
  599.  
  600.    Things to try prior to reporting a problem:
  601.  
  602.       1 - Reread the documentation to make sure you understand
  603.           what we thought we understood when we wrote it.
  604.  
  605.       2 - If the system reports "Bad command or file name" when
  606.           you attempt to run the program, its executable file
  607.           (or at least the file name you specified) was not found.
  608.  
  609.           First, make sure no typos or misspellings have crept
  610.           into your command line; next, try changing your PATH
  611.           setting, or make the drive & directory where the program
  612.           resides the "current" drive & directory.
  613.  
  614.       3 - If the program is being run from a batch file, try
  615.           deleting lines previous to the line that actually
  616.           invokes the program, to see if some prior activity
  617.           is causing the problem.
  618.  
  619.       4 - If you have any memory-resident or "TSR" utilities
  620.           installed (pop-up calculators/note pads, keyboard
  621.           enhancements, etc.), try removing them from memory
  622.           and running the program again to see if the problem
  623.           reoccurs.
  624.  
  625.  
  626.  
  627.  
  628. 9.3   REPORTING A PROBLEM
  629. _________________________
  630.  
  631.    If the problem persists, please document it as completely and
  632.    accurately as possible; we have to be able to duplicate it
  633.    before we can begin to resolve it.
  634.  
  635.    Include at least the following:
  636.  
  637.       1 - Version of DOS you are using.
  638.       2 - Machine type, drives, memory, etc.
  639.       3 - Programs executed prior to the problem.
  640.       4 - Problem program's name and version number.
  641.       5 - Where and how you obtained the problem program.
  642.       6 - Address and/or phone number where you can be contacted.
  643.       7 - Anything you can think of that might relate to the problem;
  644.           for example, listings of your AUTOEXEC.BAT and CONFIG.SYS
  645.           files, or any batch files used to run the program.
  646.       8 - Any relevant printouts.
  647.  
  648.  
  649.    NOTE: If you're a registered user, you'll find the utility
  650.          UserResp.Exe on the distribution diskette; it can be used
  651.          to print a pre-addressed mailer and a problem report.
  652.  
  653.          If you have not yet registered, send problem reports to the
  654.          address below (or print the pre-addressed mailer from the
  655.          Evaluation Menu).
  656.  
  657.  
  658.  
  659.  
  660. 9.4   CUSTOM MODIFICATIONS
  661. __________________________
  662.  
  663.    If you need custom modifications to this software for your
  664.    particular application, please write to the below address
  665.    with complete details of your requirements.
  666.  
  667.  
  668.  
  669.  
  670. 9.5   CORRESPONDENCE
  671. ____________________
  672.  
  673.    We welcome any comments or suggestions you might have
  674.    concerning improvements and future enhancements to this
  675.    product.  Send all correspondence to:
  676.  
  677.              Phil Herron
  678.              P.O. Box 1288
  679.              Battle Ground, Washington  USA  98604
  680.  
  681.  
  682.  
  683.  
  684. _________________________________________________________________
  685.  
  686. 10.0           Product Catalog
  687. _________________________________________________________________
  688.  
  689.  
  690.    This section contains a list of products available or near
  691.    completion as of this release date; it will be updated
  692.    whenever new products are added.
  693.  
  694.  
  695.  
  696.       ChkD     - Drive  Total/Free/Used report by value & percent
  697.       ChkM     - Memory Total/Free/Used report by value & percent
  698.       CleanOut - Selective file deletion, with confirmation
  699.       CleanTxt - WordStar to Ascii convert, ctrl char strip, tab expand
  700.       CleanZ   - Ctrl-Z End Of File char strip or replace
  701.       FindF    - Find File(s) in any directory of current drive
  702.       Gen      - Generate files for testing printer, storage or timing
  703.       KeySet   - CapsLock-NumLock-ScrollLock-PrtSc key setup
  704.       PrinTest - Parallel Printer Test & Status reporting
  705.       Qscn     - Convert text to executable file for Quick Screen display.
  706.       ScanF    - Scan File   for text strings
  707.       ScanM    - Scan Memory for text strings
  708.       Split    - File splitter
  709.       StoRm    - STorage RooM needed for files on any disk/any DOS ver.
  710.  
  711.  _______________________________________________________________
  712. |                                                               |
  713. |        COPYRIGHT 1989 Phil Herron.  ALL RIGHTS RESERVED.      |
  714. |_______________________________________________________________|
  715.