home *** CD-ROM | disk | FTP | other *** search
/ The Education Master 1994 (4th Edition) / EDUCATIONS_MASTER_4TH_EDITION.bin / files / texttors / hsweed / hsweed.doc < prev    next >
Text File  |  1994-01-23  |  12KB  |  279 lines
  1.                 HSWEED version 1.0 for DOS - Users Manual
  2.               All Rights Reserved including visual displays.
  3.                                      
  4.                                      
  5.                             Huenefeld Software
  6.                               P.O. Box 58321
  7.                           Renton, Washington 98058
  8.                               (206)-813-8665
  9.                                      
  10.                     Program Author - John S. Huenefeld
  11.  
  12.  
  13.  
  14.  
  15.                                Introduction
  16.  
  17.        This program works on pure ascii text files and will eliminate
  18.   lines that match those in a "weed" file.  It is great in cutting the
  19.   chaff out of files created by recording, or doing screen captures of,
  20.   on-line sessions.  I tried one of these programs from another
  21.   shareware author and decided to write my own.  This program works in
  22.   either manual or automatic mode and shows you what it is doing.
  23.  
  24.  
  25.                       FILES INCLUDED WITH HSWEED 1.0
  26.  
  27.   HSWEED.EXE     This is the program file.
  28.  
  29.   HSWEED.DOC     This is an ASCII version of this document.
  30.  
  31.   HELP.EXE       This file provides basic information and instructions
  32.                  about the disk.
  33.  
  34.   HSWEED.INI     This is a sample file for automatic operation mode,
  35.                  more details are given below under PROGRAM OPERATION.
  36.  
  37.  
  38.           OTHER FILES THAT WILL BE CREATED THROUGH USING HSWEED:
  39.  
  40.        The only files that HSWEED will create are the ASCII text output
  41.   files.  These files will be the results of the weeding process and
  42.   contain the cleaned up text.  HSWEED allows you to name these files
  43.   any legal DOS file name.
  44.  
  45.  
  46.                           HARDWARE REQUIREMENTS:
  47.  
  48.           - PC/XT/AT or Clone
  49.           - DOS/MS-DOS 3.0 or higher
  50.           - 512k RAM Minimum - 640k Recommended
  51.           - 360k Floppy - Hard Drive Recommended
  52.           - 25x80 Monitor - B&W/MONO/COLOR
  53.  
  54.  
  55.                              GETTING STARTED
  56.  
  57.        Make a backup copy of the program disk sent with this
  58.   documentation and place it in a safe location if you wish to protect
  59.   your registered copy of HSWEED from loss or damage.  HSWEED may be
  60.   installed onto your hard (if you have one) or run directly from a
  61.   floppy disk.
  62.  
  63.          To install HSWEED onto a hard drive, place your HSWEED disk (or
  64.   the copy) into your floppy disk drive.  Use a file management program
  65.   (like Dos Shell, Xtree, etc.), or the DOS "COPY" command to place the
  66.   file "HSWEED.EXE" into the same directory where you will be working
  67.   with the text files that you wish to weed.  If you prefer, HSWEED may
  68.   be placed into a "UTILITY" directory.  In either case, HSWEED should
  69.   be in a directory that is included in the PATH statement in your
  70.   AUTOEXEC.BAT file.
  71.  
  72.        To view the contents of your AUTOEXEC.BAT file from the DOS
  73.   prompt type "TYPE AUTOEXEC.BAT" then press enter.
  74.  
  75.        To use the COPY command to install HSWEED.EXE refer to the
  76.   following example.
  77.  
  78.        COPY A:\HSWEED.* C:\UTILITY\HSWEED.*
  79.  
  80.  
  81.  
  82.                             PROGRAM OPERATION
  83.  
  84.        HSWEED runs in two modes, automatic and manual.  To run HSWEED in
  85.   automatic mode just type "HSWEED" from the dos prompt or put HSWEED as
  86.   a line in a batch file.  To run HSWEED in manual mode type "HSWEED /M"
  87.   from the dos prompt or put HSWEED /M as a line in a batch file.
  88.  
  89.  
  90.  
  91.                               AUTOMATIC MODE
  92.  
  93.        When HSWEED runs in automatic mode, it looks for the file
  94.   "HSWEED.INI".  HSWEED.INI is a three line ASCII text file that
  95.   contains file names or full path names IN THIS ORDER ; the INPUT file,
  96.   the WEEDS file and the OUTPUT file .  You can use EDIT, EDLIN or any
  97.   ASCII text editor to customize this file to your needs.
  98.  
  99.        If any file is missing from HSWEED.INI you will be prompted to
  100.   supply a file name.  This can be handy.  For example, if you always
  101.   use the same INPUT and WEEDS file but like to provide a new OUTPUT
  102.   file name each time, simply leave the third line blank in HSWEED.INI.
  103.  
  104.        Once the program has the correct INPUT, WEEDS, and OUTPUT file
  105.   names, it takes each line of text from the INPUT file and compares it
  106.   to each line of text in the WEEDS file.  If the INPUT file line does
  107.   not match any line of the WEEDS file it is written to the OUTPUT file.
  108.   If a match is found the line is omitted from the OUTPUT file.  Neither
  109.   the INPUT file nor the WEEDS file are altered.  The OUTPUT file will
  110.   contain the cleaned up text.  NOTE: If there is an existing file with
  111.   the same name and path as the OUTPUT file, it will be over written.
  112.  
  113.        As the program runs it will display on the screen which line of
  114.   the INPUT file it is currently checking and which line of the WEEDS
  115.   file it is checking it against.  It also keeps a running count of how
  116.   many good lines it has copied into the OUTPUT file and how many lines
  117.   have been weeded.
  118.  
  119.  
  120.                                MANUAL MODE
  121.  
  122.        Manual mode works the same way as automatic mode except you will
  123.   be prompted to supply the names or the full path names for the INPUT
  124.   file, the WEEDS file and the OUTPUT file.  The contents of HSWEED.INI
  125.   will be ignored.
  126.  
  127.                                 FILE NAMES
  128.  
  129.        Any legal DOS file name or full DOS path name may be used to
  130.   identify the INPUT, OUTPUT, and WEEDS files.  This is true when either
  131.   listing the files in the HSWEED.INI file or when keying in the file
  132.   names as prompted.  However, HSWEED will not accept any file names
  133.   with a standard extension that represents a non ASCII or batch file
  134.   like ".EXE", ".SYS", ".COM", ".BAT" and several more.  This will help
  135.   protect these files from being altered by HSWEED (INPUT and WEEDS
  136.   files are not altered).  Unpredictable results could happen if a non
  137.   ASCII file is specified for either the INPUT or the WEEDS file.
  138.  
  139.  
  140.                               THE INPUT FILE
  141.  
  142.        The input file can be any ASCII text file that contains unwanted
  143.   lines.  Usually these files are auto-log records of on line sessions,
  144.   screen captures, or E-Mail down loads.  If you commonly use auto-log
  145.   files or down load E-Mail you may wish to set up your system so that
  146.   these files always have the same name like "NEWMAIL.DOC".
  147.  
  148.  
  149.                               THE WEEDS FILE
  150.  
  151.        This is an ASCII file of sample lines that you want to have
  152.   HSWEED extract from the INPUT file.  The easiest way to create this
  153.   file is to edit a typical INPUT file and delete every thing EXCEPT the
  154.   garbage.  Then save the garbage under the name of your WEEDS file (I
  155.   use WEEDS.TXT).  You can then continually build up your WEEDS file by
  156.   adding any new sample line you may happen to encounter.
  157.  
  158.        HSWEED allows the use of the "*" symbol as a wild card in a
  159.   sample line so that you can have lines with some variability weeded.
  160.   For example, if there is a line that you don't want that contains time
  161.   or date information, replace each character of the time or date with
  162.   "*".
  163.  
  164.   EXAMPLE,  The weed line:
  165.  
  166.   FAA Weather Synopsis for 02/23/1993   10:35 AM
  167.  
  168.   Becomes:
  169.  
  170.   FAA Weather Synopsis for **/**/****   **:** **
  171.  
  172.        Now any line matching this one will be weeded no matter what the
  173.   time and date values are.
  174.  
  175.  
  176.                              THE OUTPUT FILE
  177.  
  178.        The OUTPUT file will be an ASCII text file that has the file name
  179.   or full path name that you specify.  One of the nice things about
  180.   being able to specify a full path name is that you could possibly run
  181.   HSWEED from a UTILITY directory to weed an INPUT file on drive A:
  182.   using a WEEDS file in your word processor directory on drive C: and
  183.   have it create an OUTPUT file in a sub directory on drive B:!
  184.  
  185.  
  186.                                  SUPPORT
  187.  
  188.        This program should be fairly straight forward and easy to use.
  189.   If you have problems with set up or installation, I will be glad to
  190.   assist you if you call the number at the top of this document Monday
  191.   thru Friday between the hours of 9:00 AM and 5:00 PM CST.  Thank you
  192.   for using our software.
  193.  
  194.  
  195. ******************************************************************************
  196.  
  197.                       ********************************** 
  198.                       *  HSWEED     REGISTRATION FORM  * 
  199.                       ********************************** 
  200.   
  201.   
  202.         PLEASE ENTER THE FOLLOWING INFORMATION: 
  203.   
  204.         1. NAME: ___________________________________________________________ 
  205.   
  206.         2. ADDRESS: ________________________________________________________ 
  207.   
  208.                     ________________________________________________________ 
  209.   
  210.                     ________________________________________________________ 
  211.   
  212.         3. HOW DID YOU OBTAIN YOUR COPY OF HSWEED? _________________________ 
  213.   
  214.         ____________________________________________________________________ 
  215.   
  216.         4. WHAT TYPE OF COMPUTER DO YOU HAVE? ______________________________ 
  217.   
  218.         ____________________________________________________________________ 
  219.   
  220.         5. ANY PROBLEMS OR SUGGESTIONS YOU HAVE: ___________________________ 
  221.   
  222.         ____________________________________________________________________ 
  223.   
  224.         ____________________________________________________________________ 
  225.   
  226.         6. WHAT OTHER TYPES OF PROGRAMS DO YOU LIKE TO USE? ________________ 
  227.   
  228.         ____________________________________________________________________ 
  229.   
  230.         ____________________________________________________________________ 
  231.   
  232.         PLEASE ENCLOSE $10 FOR THE LATEST UPDATE TO THE ADDRESS LISTED BELOW: 
  233.         ( MAKE CHECKS PAYABLE TO: JOHN HUENEFELD - OR - HUENEFELD SOFTWARE ) 
  234.   
  235.   
  236.   
  237.                               HUENEFELD SOFTWARE 
  238.                               P.O. BOX 58321
  239.                               RENTON, WA 98058  USA 
  240.   
  241.   
  242.               THANK YOU FOR REGISTERING AND USING OUR SOFTWARE! 
  243.   
  244.                               MEDIA PREFERENCE 
  245.   
  246.        _________ 5.25 INCH DISK          _________ 3.5 INCH DISK   
  247.   
  248.   
  249.        _________ CHECK HERE IF INTERESTED IN A LIST OF OUR OTHER PRODUCTS. 
  250.  
  251.  
  252. ******************************************************************************
  253.  
  254.  
  255.                                  ABOUT SHAREWARE      
  256.       
  257.       Shareware is a concept that was started to help individual programmers
  258.   get their software into circulation with as little expense as possible.  
  259.   Programmers place trial copies of their software onto BBS systems, with 
  260.   Shareware catalog vendors, or just give them away hoping that they will be
  261.   passed along and seen by to a large number of computer users.
  262.  
  263.       The more reputable shareware programs are fully functional versions of
  264.   the "released" or "registered" versions.  It is left up to the honesty of 
  265.   the user whether or not to register.  There are usually some benefits to 
  266.   registration.  First of all it is the right thing to do.  Second, if the 
  267.   program is good the author should be compensated for the effort or writing
  268.   it so that he will be able to create more good programs for those who would
  269.   rather use software than write it.  Other benefits include printed users
  270.   manuals, program support, and a clear conscience.  Also, in general, the 
  271.   registered versions are continually updated and will have more features and
  272.   fewer bugs than the shareware trial programs.
  273.  
  274.       This software product is distributed as "shareware".  You may try the 
  275.   program out at no charge and distribute complete and unaltered copies for 
  276.   evaluation or use by others.  If you are still using it after 60 days, 
  277.   you must pay a licensing fee.  The HSWEED program itself will provide 
  278.   you with a registration form and details.
  279.