home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 8 / CDASC08.ISO / VRAC / FNAME10.ZIP / FINDNAME.DOC < prev    next >
Encoding:
Text File  |  1993-08-30  |  5.9 KB  |  152 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════╗
  3.  ║                                                                  ╟─┐
  4.  ║                   FINDNAME - VERSION 1.0ß                        ║ │
  5.  ║                                                                  ║ │
  6.  ║           BY RUDY LACCHIN -  G C TECHNICAL SERVICES              ║ │
  7.  ║                                                                  ║ │
  8.  ║                     ALL RIGHTS RESERVED                          ║ │
  9.  ║                                                                  ║ │
  10.  ║                                                                  ║ │
  11.  ╚══╤═══════════════════════════════════════════════════════════════╝ │
  12.     └─────────────────────────────────────────────────────────────────┘
  13.  
  14.  
  15.  FINDNAME may be freely copied and distributed, provided that:
  16.  
  17.      (1) it is distributed under the name "FINDNAME"
  18.  
  19.      (2) you make a reasonable attempt to ensure that this documentation
  20.          file always accompanies it
  21.  
  22.      (3) no charge is made apart from a nominal amount to cover the
  23.          cost of the distribution itself.
  24.  
  25.  FINDNAME is freeware".  If you find this program useful, then pass it
  26.  on to someone else.
  27.  
  28.  
  29.  WHAT IS FINDNAME?
  30.  ─────────────────
  31.  
  32.  FINDNAME will scan a name index (as prepared from Census extract
  33.  records) for a specified name.  It's as simple as that.  The reason the
  34.  DOS "FIND" command will not perform this task adequately is because the
  35.  name index consists of multi-line records, i.e. a name/county line
  36.  followed by a number (none or more) county lines).
  37.  
  38.  There's a small name index (NAME_IDX.SMI) included with FINDNAME which
  39.  you can use to familiarise yourself with the way the program works.
  40.  
  41.  
  42.  HOW DO I USE FINDNAME?
  43.  ──────────────────────
  44.  
  45.  Typing "FINDNAME on its own will display a quick help screen.
  46.  
  47.  The full syntax is as follows:-
  48.  
  49.       FINDNAME  [<filename>]  [/]<string>
  50.  
  51.  where [] indicates an optional parameter and <> indicates a parameter
  52.  to be replaced with a real value.  <Filename> is the name index file
  53.  and can be omitted, in which case NAME_IDX.TXT is asumed.  <String> is
  54.  the string of characters to be searched for.  The "/" option is
  55.  explained below.
  56.  
  57.  1. To search for a string of characters anywhere in the file:-
  58.  
  59.       FINDNAME SMITH
  60.  
  61.     Note that searches are *not* case sensitive, so "SmiTh" and "smITh"
  62.     (etc.) will produce identical results.
  63.  
  64.     This search method will locate *all* occurrences of "SMITH", i.e.
  65.     including "GOLDSMITH", "SMITHERS", etc.
  66.  
  67.  2. To perform a whole name search, precede <string> with an oblique
  68.     stroke, e.g.:-
  69.  
  70.       FINDNAME /SMITH
  71.  
  72.     This will find only complete names "SMITH" (i.e. no "GOLDSMITH",
  73.     "SMITHERS", etc.)
  74.  
  75.  3. If your name index file is *not* called NAME_IDX.TXT, you may
  76.     specify the filename explicitly *before* the string to be searched
  77.     for.  So examples (1) and (2) above would be:-
  78.  
  79.       FINDNAME MY_INDEX.TXT SMITH
  80.  
  81.     and:-
  82.  
  83.       FINDNAME MY_INDEX.TXT /SMITH
  84.  
  85.  4. The results of the search will be written to the screen by default,
  86.     but can be redirected in the usual way, e.g.:-
  87.  
  88.       FINDNAME SMITH >RESULTS.TXT
  89.  
  90.  
  91.  ABORTING A SEARCH
  92.  ─────────────────
  93.  
  94.  When you initiate a search, FINDNAME will display the results for that
  95.  name, then continue searching.  It will not assume that the index is in
  96.  alphabetical order and stop when it has found the specified name.
  97.  
  98.  If you have initiated a search on a lengthy index and wish to abort the
  99.  operation at any stage (e.g., because the required information has
  100.  already been shown, press ESCAPE.  You may wish to do this if you know
  101.  that the entry you are searching for is unique, or you just want to
  102.  find the first matching entry.
  103.  
  104.  
  105.  FUTURE DEVELOPMENTS
  106.  ───────────────────
  107.  
  108.  FINDNAME was knocked together very quickly as a result of a brief
  109.  conversation with someone who was having trouble handling the name
  110.  indexes from the census extracts quickly and easily.  It was never
  111.  meant to be a particularly complex program, but I am considering adding
  112.  more functionality, such as a switch to tell it to terminate a
  113.  "complete name" search after the first "hit", or automatically
  114.  expanding the county abbreviations.  Basically, anything *might* be
  115.  possible.  So if you have any ideas, please let me know.
  116.  
  117.  
  118.  BUG REPORTING
  119.  ─────────────
  120.  
  121.  Although I have made every effort to make FINDNAME as bug-free and
  122.  predictable in use as I possibly can, as an ex-programmer I am only too
  123.  aware of the little irregularities can creep into even the best
  124.  designed programs from time to time.  Also, since this is a beta
  125.  release of FINDNAME, the chances of its containing a bug are that much
  126.  greater (particularly since I have had to make certain assumptions
  127.  regarding the structure of a name index).  Consequently, I would like
  128.  to be advised of any problems you have with this program.
  129.  
  130.  You can contact me via "snail mail" at 179 Longford Lane, Gloucester
  131.  GL2 9HD (UK), or by NetMail at 2:253/188.11 - a point off "Wishful
  132.  Thinking", for the hospitality of which I should like to express my
  133.  thanks to the Sysop, Rosemary Lockie.
  134.  
  135.  
  136.  DISCLAIMER
  137.  ──────────
  138.  
  139.  I am sorry, but it has to be done...
  140.  
  141.  GCTS hereby disclaims all warranties relating to this product whether
  142.  express or implied, including without limitation any implied warranties
  143.  of merchantability or fitness for a particular purpose.  GCTS will not
  144.  be liable for any special, incidental, consequential, indirect or
  145.  similar damages due to loss of data or any other reason, even if GCTS
  146.  or an agent of GCTS has been advised of the possibility of such
  147.  damages. In no event shall GCTS's liability for any damages ever exceed
  148.  the price paid for the license to use software, regardless of the form
  149.  of the claim.  The person using the software bears all risk as to the
  150.  quality and performance of the software.
  151.  
  152.