home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / dhg_106a.zip / DHGREPPM.DOC < prev    next >
Text File  |  1998-03-06  |  7KB  |  170 lines

  1. I. Overview
  2.  
  3. This document contains some basic getting started information,
  4. general information, and registration information.
  5.  
  6. Most of the usage information is available as online context
  7. sensitive help.  Pressing the F1 key will bring up the help
  8. information about the current menu selection.
  9.  
  10. Grep stands for "Get Regular Expression and Print" and is a
  11. text searching tool that was first developed for unix systems and has
  12. been ported to most operating systems. 
  13.  
  14. This PM version of grep is designed as a user friendly application. 
  15. It is designed for a multitasking environment and the search takes place
  16. on a separate thread to minimize the time that the wait icon 
  17. is displayed. It will also run in a low priority idle mode to 
  18. reduce the impact the search has on the other active programs.
  19.  
  20. The often cryptic command line options have been replaced with easy to
  21. use menu selections.  The output of the search is sent to a PM window
  22. and the user has easy access to all of the information that was found
  23. by the program.
  24.  
  25. To reduce the overhead, the results are buffered until the search is
  26. completed and then written to the results window.  To indicate that
  27. the search is still active, the small icon at the left of the
  28. title bar will change color as an activity indicator. The color change
  29. depends on the search results, so it does not change at a fixed rate.
  30.  
  31. This version of grep does not support the full set of
  32. "regular expressions" that most of the command line versions of grep
  33. support.  It does support two wild-card characters.  The '*' character
  34. represents multiple characters and the character '?' represents one
  35. character. Thus a search pattern of "h*e"  would match both "house" and
  36. "horse". A search pattern of "ho?se" would also match both words. The 
  37. wildcard action of the '*' character is not limited to a single
  38. character or word, it can represent multiple words. The limit in the
  39. search is that the search pattern must found in a single line.  The
  40. program reads one line at a time from the source file, with a line being
  41. terminated by a newline character or characters.
  42.  
  43. DH-Grep-PM is a shareware program and if you continue to use the
  44. program you should register it.  DH-Grep-PM  does not have any
  45. code to check on how long the program has been in use, so it is
  46. up to the user to determine a reasonable trial period.
  47.  
  48. The shareware version of DH-Grep-PM is fully functional, but a
  49. registration prompt will be displayed when the program is started 
  50. and when it is closed.  
  51.  
  52. II.  Installation
  53.  
  54. A REXX CMD file (install.cmd) is provided to install DH-Grep-PM. 
  55.  
  56. The install file will prompt the user for the destination
  57. directory and will copy the files to that directory and will
  58. create a desktop object for DH-Grep-PM. 
  59.  
  60. The registered version of DH-Grep-PM comes with three versions
  61. of DH-Grep-PM. The three versions were compiled with the different
  62. CPU optimizations enabled and the user should select the appropriate
  63. installation option for his/her PC. A 386 CPU PC will be able to run
  64. all three versions, but the 386 version will give the best
  65. performance on a 386 CPU.
  66.  
  67. The installation routine will copy the desired executable and create
  68. a program object on the desktop.
  69.  
  70. If the user wants to use an editor other than the system editor
  71. E.EXE, the editor CMD file (edit_cmd.cmd) must be modified.  This
  72. file must be located in the working directory and the editor must be
  73. in the search path or the path must be included with the editor name.
  74. The default edit_cmd.cmd file consists of the line shown below.
  75.  
  76. e %1
  77.  
  78.  
  79. III.  Uninstalling DH-Grep-PM
  80.  
  81. If you find it necessary to remove DH-Grep-PM, simply delete the
  82. unzipped files, program object, and directory. DH-Grep-PM makes no
  83. entries in the OS/2 System INI files.
  84.  
  85.  
  86. IV.  Getting Started
  87.  
  88. DH-Grep-PM was designed to be easy to use and there is context
  89. sensitive help available for most if not all of the menu selections.
  90. Pressing the F1 key will bring up the help information.
  91.  
  92. The user must enter the search parameters before the search can be
  93. started.  The Enter Search Parameters selection is located under the
  94. Configure Search selection on the menu bar.  Once the user has entered
  95. the search parameters, the search may be started. The Start selection
  96. on the menu bar is disabled until the search parameters are entered.
  97.  
  98. The Stop selection on the menu bar is disabled until the search has
  99. been started.  Selection Stop will bring up a dialog box that prompts
  100. the user to verify the stop request.  If a file is opened for
  101. searching when the stop request is made, the search will terminate
  102. after the file has been processed.  Then the results of the search
  103. will be displayed in the results window.
  104.  
  105. If the user places the cursor (not the mouse pointer) on a file name
  106. in the results window and then double clicks with the right mouse
  107. button, that file will be loaded into the editor specified in the
  108. edit_cmd.cmd file.  The easiest way to move the cursor to the desired
  109. line or file name is to double click on the line or file name with
  110. the left mouse button.
  111.  
  112. The number of files that may be opened is not limited by DH-Grep-PM,
  113. but may have a practical limit due to the memory used by each
  114. instance of the editor.
  115.  
  116. This utility will only run on OS/2 Warp and later releases.
  117.  
  118.  
  119. V. Why & How to Register
  120.  
  121. Registered users feel good about supporting OS/2 developers and enjoy
  122. these additional benefits:
  123.  
  124. Registered users of DH-Grep-PM will have access to two additional
  125. executable files that were compiled with the 486 and 586 compiler
  126. options.  These versions will offer some performance improvement
  127. for users with 468, Pentium, or equivalent CPUs. 
  128.  
  129. Registered users are supported via e-mail.  Send help requests and
  130. good ideas to me at dwhawk@southwind.net.
  131.  
  132. There are two places to register DH-Grep-PM.  Through BMT Micro and
  133. directly with the author.
  134.  
  135. Registration through BMT Micro:
  136.  
  137. BMT Micro will accept credit cards and will be more convenient for
  138. OS/2 users outside the United States.  BMT Micro's price to register
  139. DH-Grep-PM is $10.00 (US Dollars).  BMT Micro also has an FTP area
  140. where the registered version can be obtained after registration. 
  141.  
  142. BMT Micro is also setup to distribute DH-Grep-PM on floppy disk for
  143. those users who do not have internet access.  There will be an
  144. additional fee for shipping and handling of floppy disk requests.
  145.  
  146. Direct registration:
  147.  
  148. Stuff small bills, gold coins, diamonds or even checks (US banks
  149. only, please) valued at $10.00 (US dollars) into an envelope and mail
  150. to:
  151.  
  152. Don Hawkinson
  153. 4555 N Hillcrest
  154. Wichita KS, 67220-3832
  155. USA
  156.  
  157. Please don't send $100 bills (or larger) in the mail without
  158. purchasing full postal insurance.  Also, no change will be
  159. returned because it is absolutely unsafe, and unwise, to send cash
  160. through the mail.
  161.  
  162. The registered version of DH-Grep-PM will distributed via a download
  163. link on my web page, so make certain that your e-mail address is included
  164. with your registration fee. I will need it to send you the user name and
  165. password required for the download.
  166.  
  167. Registered users will be notified of updates via e-mail.
  168.  
  169. Registration covers all 1.xx versions of DH-Grep-PM.  
  170.