home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / fileutil / kws111.arj / KWS.DOC < prev    next >
Encoding:
Text File  |  1992-02-27  |  7.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      KWS V1.11 Copyright (c) 1991-1992 Copy Con Incorporated         Page 1
  5.  
  6.  
  7.      TO PRINT THIS FILE, TYPE "COPY KWS.DOC PRN" AT THE DOS PROMPT.
  8.  
  9.  
  10.      OVERVIEW
  11.      --------
  12.      KWS (KeyWord Search) is a small, fast program that performs logical
  13.      AND/OR searches for keywords within one or more text files. Output can
  14.      be displayed onscreen, or sent to any output device via standard DOS
  15.      redirection. KWS excels in searching huge text files, such as BBS file
  16.      lists, and works equally as well with average and small text files.
  17.  
  18.  
  19.      DISCLAIMER
  20.      ----------
  21.      KWS is distributed on an "AS IS" basis without warranty, expressed or
  22.      implied. Considerable testing effort has been expended, but the user
  23.      is advised to check the program's suitability before relying on it.
  24.      The user assumes full risk as to the results of using this program.
  25.      Any liability of the author will be limited exclusively to product
  26.      replacement. In no event shall the author be liable for any
  27.      consequential damages arising from the use, or inability to use this
  28.      program.
  29.  
  30.  
  31.      REGISTRATION
  32.      ------------
  33.      KWS is NOT free - it is being offered to you as Shareware. If you
  34.      plan to continue using KWS, you are obligated to pay the modest
  35.      registration fee of $15. Registered users will receive the latest
  36.      version of KWS with the "nag" messages removed, one free upgrade upon
  37.      request, and half-priced subsequent upgrades.
  38.  
  39.      All registration information is contained in the REGISTER.TXT file. If
  40.      that file is missing, register by sending a check or money order for
  41.      $15 in U.S. dollars, drawn on a U.S. bank, to:
  42.  
  43.         Copy Con Incorporated
  44.         P.O. Box 23255
  45.         Baltimore, MD 21203-5255
  46.  
  47.      Please specify 3.5" or 5.25" diskette. MD residents add 5% sales tax.
  48.      We thank you for your support.
  49.  
  50.  
  51.  
  52.      KWS V1.11 Copyright (c) 1991-1992 Copy Con Incorporated         Page 2
  53.  
  54.  
  55.      OPERATION
  56.      ---------
  57.      KWS is activated from the command line, using the format
  58.  
  59.      KWS filename search_string [search_string...] [options] [>output_device]
  60.  
  61.        filename       file(s) to be searched (can contain wildcards)
  62.        search_string  text string(s) to search for
  63.        output_device  redirection target
  64.        /C             case-sensitive search
  65.        /H             include hidden/system files
  66.        /L[n]          display line numbers [optional width of 1-9]
  67.        /N             display lines not meeting search criteria
  68.        /P             pause after each screen
  69.        /S             subdirectory search
  70.        /T             display totals
  71.        /W             whole word search
  72.  
  73.      Each search string is comprised of keywords separated by semicolons.
  74.      At least one keyword from each search string must be present in a
  75.      given line for it to be printed.
  76.  
  77.      For example, "KWS ALLFILES.LST FIXED;HARD DISK;DRIVE >HD.LST" will
  78.      take the lines in file ALLFILES.LST that contain either words FIXED or
  79.      HARD (or both), and also contain either words DISK or DRIVE, and send
  80.      them to file HD.LST. Up to 10 search strings are allowed, with up to
  81.      10 keywords per string.
  82.  
  83.  
  84.      OPTIONS
  85.      -------
  86.      Options can appear anywhere on the command line after the filename.
  87.      They can be in any order, and are not case-sensitive. Options can be
  88.      separated by spaces (/L3 /P /T) or strung together (/L3/P/T or /L3PT).
  89.  
  90.      Option   Description
  91.  
  92.        /C     Search will be case-sensitive. Case-sensitive searches are
  93.               approximately 15% faster than case-insensitive searches.
  94.  
  95.        /H     Hidden and/or system files will also be searched.
  96.  
  97.        /L[n]  Line numbers will be displayed with output. If no width is
  98.               specified, the numbers will be left-justified, with a colon
  99.               between the number and the text; otherwise, the numbers will
  100.               be right-justified and zero-padded to the left, followed by
  101.               the colon and text. If the specified width is too small for a
  102.               number to fit, the number will NOT be truncated.
  103.  
  104.        /N     Lines that do NOT fit the search criteria are displayed,
  105.               instead of the ones that do.
  106.  
  107.        /P     Pause between each screen of text. The program will auto-
  108.               detect your screen size, and pause accordingly. This option
  109.               should not be used if the output is to be redirected.
  110.  
  111.  
  112.  
  113.      KWS V1.11 Copyright (c) 1991-1992 Copy Con Incorporated         Page 3
  114.  
  115.  
  116.      OPTIONS (continued)
  117.      -------------------
  118.      Option   Description
  119.  
  120.        /S     Subdirectories will also be searched. This option is valid
  121.               only with wildcard searches.
  122.  
  123.        /T     Display total lines found per file. For wildcard file
  124.               searches, a grand total will also be displayed.
  125.  
  126.        /W     Only exact words will be searched for; words that are not
  127.               keywords, but have keywords in them, will not be displayed.
  128.  
  129.  
  130.      RETURN CODES
  131.      ------------
  132.      The DOS errorlevel will be set if a search is unsuccessful:
  133.  
  134.      Level  Description
  135.  
  136.        1    Invalid command line options
  137.  
  138.        2    None of the files contain the search string(s)
  139.  
  140.        3    Ctrl-Break interrupt
  141.  
  142.        4    Invalid directory specified
  143.  
  144.        5    No files match filespec
  145.  
  146.  
  147.      EXAMPLES
  148.      --------
  149.      KWS catalog.lst dvorak keyboard /p
  150.        will take the lines in file CATALOG.LST that contain the words
  151.        DVORAK and KEYBOARD, and display them one screen at a time.
  152.  
  153.      KWS catalog.lst arc;lzh shell /l5 >prn
  154.        will take the lines in file CATALOG.LST that contain either ARC or
  155.        LZH, and also contain SHELL, and send them to the printer, along
  156.        with their line numbers.
  157.  
  158.      KWS allfiles.lst /c /n .ZIP >nozip.lst
  159.        will make a file called NOZIP.LST, which will contain all of the
  160.        lines in ALLFILES.LST that do NOT contain the word .ZIP in caps.
  161.  
  162.      KWS \dl\*.lst MIDI /ptc
  163.        will search all .LST files in the DL directory for the word MIDI in
  164.        capital letters, and displays the filenames and lines onscreen, one
  165.        screen at a time, with totals for each file.
  166.  
  167.      KWS *.bak the /w
  168.        will search the backup files for lines that contain the word THE,
  169.        but will not display them if THE is part of another word (as in
  170.        THESIS or OTHER).
  171.  
  172.  
  173.  
  174.      KWS V1.11 Copyright (c) 1991-1992 Copy Con Incorporated         Page 4
  175.  
  176.  
  177.      EXAMPLES (continued)
  178.      --------------------
  179.      KWS allfiles.lst C /wc >com1
  180.        will send the lines in ALLFILES.LST that contain a lone capital C
  181.        (as in 'learn C' or 'C-language') to the device connected to COM1.
  182.  
  183.      KWS c:\*.bat del;era /s/h
  184.        will search all of the batch files on the C: drive, including those
  185.        with their hidden and/or system attributes set, to see if any of
  186.        them delete/erase files.
  187.  
  188.  
  189.      CORRESPONDENCE
  190.      --------------
  191.      If you have comments, suggestions or bug reports, please write to:
  192.  
  193.        Copy Con Incorporated
  194.        P.O. Box 23255
  195.        Baltimore, MD 21203-5255
  196.  
  197.      If you would like a reply, please include a self-addressed, stamped
  198.      envelope.  We look forward to hearing from you.
  199.