home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / help / helper.lbr / SRCHHELP.TZT / SRCHHELP.TXT
Encoding:
Text File  |  1988-08-30  |  6.0 KB  |  169 lines
  1. ^Z                              SEARCH topics:
  2.  
  3. 1)  Files, items and separators
  4. 2)  Search phrases
  5. 3)  Specifying arguments
  6. 4)  The search process
  7. 5)  Sending output to a file
  8. 6)  Customizing SEARCH
  9.  
  10. ~l0
  11. Which would you like help with (Q to quit)? ~s
  12. ~c1
  13. ~b
  14. ^z                        Files, items and separators
  15.  
  16.     SEARCH works with line-oriented ASCII text files.  SEARCH treats the 
  17. file as being made up of ITEMS, where an item is one or more lines that 
  18. "logically" belong together.  An item could be a single line, a paragraph, 
  19. or some other grouping.  A file is broken up into items by a SEPARATOR; 
  20. this is a line that occurs at the end of each item in the file.  An example 
  21. would be a blank line between paragraphs.  A separator is always a whole 
  22. line.
  23.  
  24.                    More information is available about:
  25.  
  26. 1)  File types
  27. 2)  Examples of items
  28. ~uchoose
  29. ~s
  30. ~c1
  31. ^z    To be usable with SEARCH, a file must be pure ASCII (no embedded word 
  32. processor codes) and have a CR/LF pair at the end of each line.
  33.  
  34.     Squeezed and crunched versions of such a file are also usable.  SEARCH 
  35. determines whether a file is plain-text, squeezed or crunched by looking at 
  36. the first few bytes of the file rather than by looking for a C or Q in the 
  37. filename extension.  This means that a plain-text file called MYPROG.AZM 
  38. would be correctly read, and a crunched file called RCPM.LST would be 
  39. correctly identified.
  40.  
  41.     SEARCH can also read files out of libraries.
  42. ~c2
  43.     An item can be a single line:
  44.  
  45. John Doe      1221 Main St.       Hometown, IL  60000  (312)555-1988
  46. ...
  47. Jane Roe      13 Plymouth Ct.     Providence, RI ?     (800)111-1111
  48.  
  49.     It could be a paragraph:
  50.  
  51.        Text retrieval software can be divided into two categories: programs 
  52. based on directly searching the text and programs based on preparing an 
  53. index to the text..........
  54.  
  55.        SEARCH falls into the first category.  Like all such programs, it is 
  56. slower than an index-based program, but it requires no setup.....
  57.  
  58.     Or it could be a sequence of lines separated by an arbitrary line:
  59.  
  60. SEARCH21.LBR (CP/M)
  61.   A free-format text retrieval system.
  62.  
  63.   Uploaded by Eric Bohlman
  64.  
  65. ----
  66. VDE266.LBR (CP/M)
  67.   The final version of the public-domain text editor.
  68. ----
  69.  
  70.  
  71.     In the first example, there is really no separator; we call this 
  72. "line-by-line."  In the second one, the separator is a blank line and in 
  73. the third, the separator is a line consisting of four dashes.
  74.  
  75.     A separator is always a line by itself (except for line-by-line).  You 
  76. cannot use a period as a separator in order to make each sentence an item; 
  77. items must consist of whole lines.
  78. ~cq
  79. ~q
  80. ~cp
  81. ~t
  82. ~e
  83. ~p~a
  84. ~c2
  85. ~b
  86. ^z                              Search phrases
  87.  
  88.     SEARCH can look for any sequence of characters within the text.  You 
  89. can search for a word, a phrase, a punctuation character, or any logical 
  90. combination of these.  You can specify whether a word must stand alone or 
  91. whether it can be embedded in another word.  Comparison is 
  92. case-insensitive.  SEARCH always treats a sequence of spaces in the text as 
  93. being equal to a single space.  A line-ending is treated as a space, unless 
  94. it's immediately preceded by a hyphen, in which case both the hyphen and 
  95. the line end are ignored.  SEARCH also ignores leading spaces on a line.  
  96. This means that a word will be matched even if it was hyphenated at the end 
  97. of a line, and a multiple-word phrase will match across line boundaries, 
  98. even if there's a left margin.
  99.  
  100.                    More information is available about:
  101.  
  102. 1)  Phrases
  103. 2)  Embedding control
  104. 3)  Logical combinations
  105. ~uchoose
  106. ~s
  107. ~c1
  108. ^z
  109.     A word or phrase is any sequence of characters that is to be searched 
  110. for in the text.  The total length of all unique words or phrases that you 
  111. wish to search for must be less than 256 characters, and you can use at 
  112. most 16 unique words or phrases in a logical combination of search phrases.
  113. ~c2
  114. ^z
  115.     By default, a word will be matched ANYWHERE in the text.  For example, 
  116. "ion" would match itself.  It would also match "emotion," "ionic" and 
  117. "emotionally."  Sometimes it is desirable to restrict the matching of 
  118. embedded words.  You can do this by putting the special character "^^" at 
  119. the beginning or end of a word or phrase.  When this character is present, 
  120. it signifies that the match can occur only at a word boundary.  For 
  121. example, "^^ion" would match only those words beginning with "ion" and 
  122. "ion^^" would match only words ending with "ion."  "^^ion^^" would match 
  123. only the word "ion."
  124. ~c3
  125. ^z
  126.     SEARCH can do more than detect the mere presence of a single word or 
  127. phrase.  It can also check for the presence of LOGICAL COMBINATIONS of 
  128. words or phrases.  There are three kinds of logical combinations.  First, 
  129. you can specify that a word or phrase must NOT be present in an item.  
  130. Second, you can require that two or more phrases BOTH be present in an 
  131. item.  This is known as an AND combination.  Finally, you can require that 
  132. EITHER of several phrases be present.  This is an OR combination.
  133.  
  134.     To require that a word or phrase NOT be present, you simply precede it 
  135. with the NOT character, which is an exclamation mark.  If you need to match 
  136. a phrase that begins with a literal exclamation mark, you precede it with a 
  137. backslash.  The exclamation mark has special significance only when it is 
  138. at the very beginning of a word or phrase; otherwise it is treated 
  139. literally.
  140.  
  141.     How you specify an AND combination or an OR combination depends on 
  142. whether you are entering arguments by the command line or by prompt.  This 
  143. is covered in the section on how to specify arguments, and examples of 
  144. logical combinations are available there.
  145. ~cq
  146. ~q
  147. ~cp
  148. ~t
  149. ~e
  150. ~p~a
  151. ~c3
  152. ~c4
  153. ~c5
  154. ~c6
  155. ~cq
  156. ~q
  157. ~d
  158. ~ubadchoice
  159. ~g0
  160. ~e
  161. ~t
  162. ~lchoose
  163.  
  164. Pick one or press Q to quit, P to see the previous section: ~r
  165. ~lbadchoice
  166. "~o" isn't on the menu.  Try again
  167. ~r
  168.  
  169.