home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / m / mastlkt.zip / DOCS.EXE / pak / FSRCH.DOC < prev    next >
Text File  |  1988-01-02  |  5KB  |  116 lines
  1. R
  2.  
  3.  
  4.                FSRCH - FILE SEARCH UTILITY
  5.  
  6.  
  7.                Copyright (c) 1988, Stan Leeson
  8.                     All Rights Reserved
  9.  
  10.  
  11.  
  12. FSRCH is a text file search utility that allows you to search through a
  13. collection of files for lines that contain a target string or for lines
  14. that relate to a pair of target strings in a prescribed manner.  It 
  15. provides you with a simple but powerful user interface to aid you in
  16. locating text items quickly and easily.
  17.  
  18. Programmers often work with programs made up of a collection of source
  19. language files.  When the applications are large and complex, it is often
  20. easy to misplace the definition of a variable, the source of a function,
  21. calls to a given subroutine, etc.  FSRCH can help you locate these items 
  22. quickly.  Other users may want to find a given text string in a set of 
  23. ASCII documentation files.  Again, FSRCH can easily do that for you.
  24.  
  25. FSRC is called from the command line with no parameters or with an optional
  26. output file specification parameter.  The two forms of the call are:
  27.     FSRCH     or    FSRCH outfile_spec
  28. where "outfile_spec" is the file specification where the listing of the
  29. files that were search and the matching lines that were found should be
  30. written.  If the output file specification parameter is omitted, the list 
  31. is written to "FSRCH.OUT" in the current default directory.
  32.  
  33. Once FSRCH begins execution, it presents a form with 6 fields on the screen.
  34. This form is used to control the type of search that is performed.  Context
  35. sensitive help can be obtained by highlighting the field of interest with
  36. the cursor arrow keys on the numeric keypad and pressing the F1 key.  You
  37. may fill in the fields in order pressing ENTER or TAB to move from one field
  38. to the next, or you may use the cursor arrow keys to move the highlighting 
  39. and fill in the fields in any order that you like.  Once you have completely
  40. specified the search that you would like performed, you indicate that the
  41. parameters are complete by holding down the Control key (Ctrl) and pressing
  42. he enter key.  The individual fields are desrcribed below:
  43.  
  44. FIELD 1 - FILE PATTERN
  45.      The file pattern is used to indicate which files are to be
  46.      searched.  It may contain a drive specification, a directory 
  47.      specification, and a file naming pattern with wild card
  48.      characters.  A typical pattern would be in the form:
  49.        \"*.C\" to indicate all files with a .C extension.  A
  50.      full pattern could be \"B:\\DIREC\\MY*.XY*\" to indicate
  51.      all files in directory \\DIREC on drive B: with a name
  52.      that begins with MY and an extension that begins with
  53.      XY are to be searched.
  54.  
  55. FIELD 2 - OBJECT 1
  56.      The object strings are those items that are to be searched
  57.      for.  The first object string is required and the second is
  58.      optional.  If the second string is empty, the relationship
  59.      is ignored, and FSRCH simply searches for occurrences of the
  60.      first string.  If both strings are specified, FSRCH finds text
  61.      lines with the proper relationship of the two strings."};
  62.  
  63. FIELD 3 - RELATION
  64.      This field tells how the two object strings are
  65.      related in text lines that are reported.  Choices:
  66.       AND  - Both object strings must appear
  67.       OR   - Either object string must appear
  68.       NOT  - The first string must appear and NOT the second
  69.       XOR  - Either string may appear but not both
  70.       SOLO - Only the first is searched for
  71.      The relationships may be abbreviated to just the initial character.
  72.      If the relationship is omitted, it is assumed to be SOLO if the
  73.      second object string is NULL and AND if it is not.
  74.  
  75. FIELD 4 - OBJECT 2
  76.      The object strings are those items that are to be searched
  77.      for.  The first object string is required and the second is
  78.      optional.  If the second string is empty, the relationship
  79.      is ignored, and FSRCH simply searches for occurrences of the
  80.      first string.  If both strings are specified, FSRCH finds text
  81.      lines with the proper relationship of the two strings."};
  82.  
  83.  
  84. FIELD 5 - CASE SENSITIVE
  85.      This field should be filled with a Y or N to indicate whether
  86.      or not the search should be case sensitive.  If this field is left
  87.      blank or set to N, upper case and lower case letters are considered
  88.      to be equivalent.
  89.  
  90. FIELD 6 - PAUSE
  91.      This field is set to Y or N to indicate whether FSRCH should
  92.      pause after each match that is found.  If pause is selected, FSRCH 
  93.      stops after each matching line and waits for you to press a key
  94.      before continuing.
  95.  
  96.  
  97.  
  98.  
  99.  
  100. As each search is down, the results are written to the indicated output
  101. file and displayed on the screen.  Optionally, FSRCH will pause after 
  102. each match and wait for you to confirm that it is to proceed.  When the
  103. search is complete, FSRCH will ask if you want to perform additional
  104. searches or terminate.  If you choose to change parameters and search
  105. again, FSRCH displays the parameters used in the last search and allows
  106. you to change any that might require change.  Results of subsequent
  107. searches are appended onto the output file produced by the intial search.
  108.  
  109.  
  110.      FSRCH is a "Shareware" product and may be copied and
  111.      distributed for trial use so long at it is not changed
  112.      in any way.  If you find it useful please send $5.00 to:
  113.      Stan Leeson, 1111 Edgewater, Arden Hills, MN 55112      
  114.  
  115.  
  116.