home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 24 / CD_ASCQ_24_0995.iso / vrac / cfind17.zip / CFIND.DOC next >
Text File  |  1995-06-10  |  16KB  |  364 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                                  CFind
  28.                                  ─────
  29.                                  v 1.7
  30.  
  31.                              Copyright 1995
  32.                         CraigerWare Enterprises
  33.  
  34.  
  35.    CFind                                                           Page 1
  36.  
  37.                            Table of Contents
  38.                            ─────────────────
  39.    Introduction ....................................................... 2
  40.    Installation ....................................................... 2
  41.    Syntax ............................................................. 3
  42.    Examples ........................................................... 4
  43.    Registration Policy ................................................ 5
  44.    About CraigerWare .................................................. 6
  45.    Acknowledgements ................................................... 6
  46.    Revision History ................................................... 7
  47.    Registration Form .................................................. 8
  48.  
  49.  
  50.    CFind                                                           Page 2
  51.  
  52.                               Introduction
  53.                               ────────────
  54.    CFind was originally a program I wrote for work, to help some of our
  55.    employees find data within large database files, while maintaining
  56.    simplicity and virtually no learning curve.  We wanted anybody to
  57.    be able to find data based on looking at a one page "syntax" sheet.
  58.    I know there are many, many utilities that perform these same
  59.    functions, but most are either shareware or commercial, and this
  60.    utility was to be used on 30+ computers, so I wrote CFind to
  61.    eliminate both the need for carrying a diskette around, and to
  62.    avoid registering/buying 30+ copies of identical software.  CFind
  63.    is easy to use, accurate, and, I think, intuitive.  CFind has
  64.    evolved quite a bit since it's inception, and will probably go
  65.    through one more release.  Upgrade plans include: the ability to
  66.    search for hex or binary data; interactive entry of options; and
  67.    possibly increased performance.  I also tutor C programming, so it's
  68.    unlikely that I will ever incorporate assembler into CFind, therefore
  69.    it's also unlikely that CFind's performance will drastically improve.
  70.    I feel it is quite quick as it sits, so there isn't much room for
  71.    improvement anyway <grin>.  Please feel free to use it for as long as
  72.    you like, free of charge.  I will accept donations, mostly to
  73.    encourage me to write more utilities of this kind, but also because
  74.    programmers always need to purchase more tools, and it gets expensive
  75.    writing 'freeware' <grin>.  If you do decide to register CFind, I
  76.    will supply you with a key file that will eliminate the "unregistered
  77.    version" message upon program startup, and allow you to rest assured
  78.    that your software karma will remain on the positive side.
  79.  
  80.                               Installation
  81.                               ────────────
  82.    Installation is simple enough.  To be able to use CFind from any
  83.    DOS prompt, merely copy it into a directory that's already included
  84.    in your path.  I use C:\UTILS, which is where I keep lots of these
  85.    sorts of programs.  If you decide to register, you MUST copy the
  86.    CFIND.KEY file into the same directory as CFIND.EXE, so that CFind
  87.    will be able to locate it's registration information.
  88.  
  89.  
  90.    CFind                                                           Page 3
  91.  
  92.                                  Syntax
  93.                                  ──────
  94.    As stated before, CFind is intuitive and very easy to use.  The
  95.    complete syntax is:
  96.  
  97.       CFIND <filename.exe> "text to search for" [/S] [/N] [/C]
  98.  
  99.       CFIND /?         or        CFIND
  100.          will provide a brief help/syntax screen.
  101.  
  102.    We will now discuss each of these options in detail.
  103.  
  104.    <filename.exe> should be fairly obvious.  One note in particular
  105.       is that you may use DOS wildcards (*/?) to include groups of files
  106.       in the search.
  107.  
  108.    "text to search for" is, of course, the text you are looking for in
  109.       the above selected files.  You should get in the habit of using
  110.       the quotation marks to enclose the text, because they will be
  111.       required if you ever need to search for a string of text that
  112.       contains a space character.  DOS uses the space character to
  113.       find program options, but anything enclosed within quotes is
  114.       considered only one option.  The quotes are entirely optional,
  115.       provided you do not search for text containing spaces.
  116.  
  117.    [/S] is an optional parameter that will cause CFind to search all
  118.       subdirectories that are 'under' the current directory.
  119.  
  120.    [/N] is an optional parameter that will remove any prompts CFind
  121.       may generate.  Normally, CFind will pause after each successful
  122.       text find, and allow you to stop or continue.  This option
  123.       disables this pause so you may use the DOS redirection ">" to
  124.       route the report to a file or printer.  Think of it as a batch,
  125.       or 'NoPrompt' switch.
  126.  
  127.    [/C] is the last optional parameter which will turn on case
  128.       sensitive searching.  In other words, if you want to find "Text",
  129.       but not "text", use the /C option.  When you use the /C option,
  130.       the report output is in lowercase, but do not be alarmed, CFind
  131.       is not modifying any files, just converting everything to small
  132.       letters to make it quicker and easier to find matching text.
  133.  
  134.  
  135.    CFind                                                           Page 4
  136.  
  137.                                 Examples
  138.                                 ────────
  139.    CFIND *.EXE "COPY"
  140.       Will find all instances of "Copy", "copy", "COPY", etc., in any
  141.       .EXE files in the current directory.
  142.  
  143.    CFIND *.EXE "COPY" /S
  144.       Will find all instances of "Copy", "copy", "COPY", etc., in any
  145.       .EXE files in the current directory and all child subdirectories.
  146.  
  147.    CFIND *.* "Copy" /S /C
  148.       Will find all instances of "Copy" in any files in the current
  149.       directory and all child subdirectories.  Will NOT find "COPY" or
  150.       "copy", as it is a case-sensitive search.
  151.  
  152.    CFIND *.* "Copy" /S /C /N > FINDCOPY.TXT
  153.       Will find all instances of "Copy" in any files in the current
  154.       directory and all child subdirectories.  Also, the /N option
  155.       suppresses all prompts, and the "> FINDCOPY.TXT" on the end
  156.       redirects the output to file FINDCOPY.TXT in the current directory.
  157.  
  158.    CFIND *.C "Craig" /N > LPT1
  159.       Will find all instances of "craig" (regardless of case) in all
  160.       files with an extension of C in the current directory, and prints
  161.       them on LPT1.
  162.  
  163.    CFIND *.TXT "Craig" /C > LPT1
  164.       Will find all instances of "Craig" in all files with an extension
  165.       of TXT in the current directory, and prints them on LPT1.  Note
  166.       the lack of the /N option.  This means that you will have to press
  167.       a key after each find, even though the report is going to LPT1.
  168.  
  169.       Note: All options/switches are insensitive to case.  You may use
  170.       /N or /n interchangeably.  Also, the order of the switches is
  171.       unimportant, although they MUST be the last thing on the command
  172.       line.  The first parameter must always be filename, second must
  173.       always be search string, then the switches can be in any order.
  174.  
  175.  
  176.    CFind                                                           Page 5
  177.  
  178.                               Registration
  179.                               ────────────
  180.    CFind is free for private, personal use on your own computer, provided
  181.    you are not using it for business or corporate gain.  Sysops are
  182.    encouraged to distribute CFind on BBS's, and everyone is encouraged
  183.    to share CFind, provided all documentation is included within the
  184.    archive.  I use LZH for distribution, but any archive format is
  185.    acceptable.  ZIP comments and advertisement files are OK, too, for
  186.    if people didn't pass BBS numbers around, nobody would know where
  187.    to call.  Distribution of CFind key files is strictly prohibited,
  188.    however, and is a violation of United States copyright law.  This
  189.    will hopefully not be a problem, as I'm releasing the executable
  190.    version of the program as freeware.  Any registrations will also
  191.    provide the benefit of free lifetime upgrades, and tech support via
  192.    the CraigerWare support BBS.  Corporations, businesses, and
  193.    individuals who wish to encourage "starving programmers" are
  194.    encouraged to register CFind per the following rates.  If you
  195.    are a FidoNet member, I will be happy to "crash" your key to you.
  196.    You may call my BBS after sending your payment, leave me a note, and
  197.    after I receive payment, I will attach a key file to a message to
  198.    you. Alternatively, if you run a BBS, please indicate if you would
  199.    like me to upload the key to you.  Last resort is that I will mail
  200.    the key to you, on a 3.5" low density disk.
  201.  
  202.    Private/noncommercial:   $3 US
  203.       This is merely a donation registration.  I will provide you
  204.       with a key file that indicates that you are the legal owner
  205.       of this copy of CFind, and you may use it anywhere you wish,
  206.       provided you do not use it in a commercial environment, and
  207.       you do not distribute the key file.
  208.  
  209.    Individual Commercial:   $5 US
  210.       You may use CFind on any one computer.  CFind may not be
  211.       copied within your organization without purchasing the site
  212.       license below.  You are expected to treat CFind as you would
  213.       treat any other commercial software application.
  214.  
  215.    Site Commercial:       $100 US
  216.       You may use CFind on an unlimited number of computers within
  217.       your organization.  You are not allowed to transfer CFind
  218.       outside of your organization, but you may freely copy and
  219.       distribute CFind among your own, company owned computers.
  220.  
  221.    C Tutoring:            $50 US
  222.       This option not only includes a key file to identify you as
  223.       a legal user of CFind, but you will also be provided with
  224.       the TurboC source code to the program.  This is not a complex
  225.       program, but it does have many good examples of MS DOS specific
  226.       C programming techniques.  It is invaluable for any beginning
  227.       C programmer who has questions about recursive function calls,
  228.       file sharing, multitasker awareness, and is a very good example
  229.       of readable and acceptable C programming style.
  230.  
  231.  
  232.    CFind                                                           Page 6
  233.  
  234.                      About CraigerWare Enterprises
  235.                      ─────────────────────────────
  236.    CraigerWare Enterprises was founded in 1989, when I began to teach
  237.    myself C during slow periods at work.  At the time, I was programming
  238.    on both an IBM S/38 and an IBM AS/400, using RPG3, RPG400, and COBOL.
  239.    I quickly tired of those languages because of assorted limitations
  240.    inherit in each language.  My first language on a PC was BASIC, as is
  241.    most people's, but I also soon tired of it's bloated and slow .EXE
  242.    files, not to mention it's lack of versatility at the time.  PCC, by
  243.    Mark DeSmet, was my first compiler for C programming, and it provided
  244.    me with an excellent foundation of how C works.  I also learned a lot
  245.    from the Waite series of books on TurboC, which are easy to read,
  246.    provide lots of examples, and are very intuitive.  I, personally, am
  247.    currently 30, work professionally as a programmer/technician, and
  248.    run a BBS in Sioux City, IA.  I also write many doors for the
  249.    excellent TriBBS Bulletin Board System by Mark Goodwin, and do
  250.    occasional contract programming.  I strongly support the shareware
  251.    concept, and believe that if we completely removed all major
  252.    software companies from existence, the world would be a better
  253.    place...<grin>
  254.  
  255.       You may contact me via:
  256.  
  257.          FidoNet         1:288/24        (FREQ CFIND for latest version)
  258.          Internet        craig.miller@f24.n288.z1.fidonet.org
  259.          BBS:            Temples of Syrinx  (712) 276-6219
  260.          Snail Mail:     CraigerWare Enterprises
  261.                          P.O. Bo 2672
  262.                          Sioux City, IA  51106
  263.  
  264.  
  265.                    Acknowledgements & Thanks-to List
  266.                    ─────────────────────────────────
  267.    Many thanks to the following companies or individuals for both
  268.    encouraging me to write quality software, and providing me with a
  269.    means to do so:
  270.  
  271.    TSE ............. Semware Corporation ......... worlds best editor
  272.    TurboC .......... Borland International ....... worlds best compiler
  273.    Compaq .......... Compaq Computer Corporation . worlds best PC's
  274.    Trevor .......... My son ...................... letting me finish these
  275.                                                    docs....<grin>
  276.    DeDe ............ My wife ..................... letting me finish the
  277.                                                    program...<bigger grin>
  278.    PCC ............. Mark DeSmet ................. keeping me interested
  279.                                                    enough in C to finally
  280.                                                    learn it well
  281.    TurboC Bible .... The Waite Group ............. providing me with an
  282.                                                    excellent reference
  283.                                                    & tutorial
  284.  
  285.  
  286.    CFind                                                           Page 7
  287.  
  288.                             Revision History
  289.                             ────────────────
  290.    1.7      Removed chances made in v1.6, as the DIETing caused
  291.             occasional problems in DESQview.
  292.  
  293.    1.6      Removed CRC self-check and started distributing DIETed
  294.             executables.
  295.  
  296.    1.5      No changes. <g>
  297.  
  298.    1.4      Visual enhancements.
  299.  
  300.    1.3      Found a major bug in the searching algorithm.  Fixed.
  301.  
  302.    1.2      Found a bug in the command line parser, fixed.
  303.             Changed some of the recursing logic to make it slightly
  304.             faster, and more standardized.  Also changed command
  305.             line parser to allow the '-' switch character in addition
  306.             to the '/' character.
  307.  
  308.    1.1      Released hours after 1.0, modified to recursively search
  309.             hidden subdirectories, in addition to normal subdirs.
  310.  
  311.    1.0      First public release.
  312.  
  313.  
  314.    CFind                                                            Page 8
  315.  
  316.                       Registration Form for CFind
  317.                       ───────────────────────────
  318.  
  319.  
  320.  
  321.    Name ________________________________________
  322.  
  323.    Address _____________________________________
  324.  
  325.    City _____________________________________  State ____  Zip _________
  326.  
  327.    Registered To: ___________________________________________
  328.                      (This is for generating your key)
  329.  
  330.    Your BBS number, if you would like key uploaded to you:
  331.                      ________________________________________
  332.  
  333.    Your FIDOnet node address, if you would like the key crashmailed.
  334.                      ________________________________________
  335.  
  336.  
  337.    How did you hear about CFind? _______________________________________
  338.    _____________________________________________________________________
  339.    _____________________________________________________________________
  340.  
  341.  
  342.    What improvements would you make to the program or documentation?
  343.    _____________________________________________________________________
  344.    _____________________________________________________________________
  345.    _____________________________________________________________________
  346.    _____________________________________________________________________
  347.  
  348.  
  349.  
  350.  
  351.                Registration type: ______________________________________
  352.  
  353.                  Amount Enclosed: ______________________________________
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.    Please feel free to return this form without any payment, should you
  361.    have any suggestions or improvements, and thank you for giving
  362.    CraigerWare a try!
  363.                                                   Craig
  364.