home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 6 File / 06-File.zip / scanx106.zip / STDOC.TXT < prev   
Text File  |  1996-02-22  |  6KB  |  179 lines
  1. Contents
  2. ========
  3.  
  4.  [INTRODUCTION]
  5. *[WHATS NEW]*
  6. *[HOW TO REGISTER (FREE!)]*
  7.  [SYNTAX]
  8.  [OPTIONS]
  9.  [EXAMPLES]
  10.  [CAPTURING RESULTS]
  11.  [NOTE ON 286/8088]
  12.  [CREDITS]
  13.  [VERSION HISTORY]
  14.  [CONTACT AUTHORS]
  15.  
  16.  
  17. [INTRODUCTION]
  18. ==============
  19.  
  20. ScanText v1.06 Manual
  21.  
  22.  
  23. ScanText is a program that counts the number of lines in a file or directory 
  24. in which there are occurrences of a single word or a string of words. 
  25.  
  26. [WHATS NEW]
  27. ===========
  28.  
  29. ScanText v1.06's code has been optimized for additional speed. The help
  30. screen and documentation has been improved as well.
  31.  
  32. This is the djgpp (Beta 3) version of ScanText. It now uses a 32-bit  
  33. DOS-extender and is therefore able to use ALL of your available memory,  
  34. and not just the tiny little 640K's. It is also much faster. The additional  
  35. speed is very noticeable.
  36.  
  37. If you are running 32bit ScanText from MS-DOS, you have to have CWSDPMI.EXE  
  38. in your path or loaded in memory to provide DPMI for the program. This is  
  39. not required if you are running 32bit ScanText from a DOS session in Windows 
  40. 3.1, Windows95 or OS/2 Warp, because they already provide DPMI for all 
  41. programs. See the CWSDPMI documentation (included in the ScanText ZIP)  
  42. for details.
  43.  
  44. [HOW TO REGISTER (FREE!)]
  45. =========================
  46.  
  47. Here's how to get your OWN PERSONAL VERSION OF SCANTEXT:
  48.  
  49. ScanText is CARDWARE. This means that if you use ScanText, and would like 
  50. to register it, you are required to send a postcard with a picture of your 
  51. city on it to the authors. What should you write? Send comments, 
  52. suggestions, whatever you like. Send postcards to:
  53.  
  54.         Jawed Karim
  55.         2360 Linwood Ct.
  56.         Maplewood, MN 55119 - 5851
  57.         U.S.A.
  58.  
  59. --> Please make sure to include your full name and email address. Upon
  60.     receiving your postcard, a special version of ScanText with your name 
  61.     in it (in place of "EVALUATION COPY!") will be emailed to you.
  62.  
  63. That's all you have to do, imagine that! You don't even have to pay, as you
  64. would for SHAREWARE.
  65.  
  66. [SYNTAX]
  67. ========
  68.  
  69. ScanText runs in two modes: searching a single file for a word or string; 
  70. and searching a directory for a word or string.  These modes are just  
  71. different enough to require two general command-line syntactical diagrams. 
  72. The options will be described in more detail after the diagrams. 
  73.  
  74. This is the general command-line syntax you must use when searching a single 
  75. file for a word or string:
  76.  
  77. ST [drive:][path]<filename>  <word>|"<string>" [-s] [-l] [-n] 
  78.  
  79. And this is the general command-line syntax used for searching a directory 
  80. for a word or string:
  81.  
  82. ST [drive:]<path>  <word>|"<string>" [-s] [-l] [-n]
  83.  
  84. [OPTIONS]
  85. =========
  86.  
  87. [-s] causes the program to perform a case-sensitive search. The default is 
  88. case-insensitive.
  89.  
  90. [-l] causes the program to display the lines of the file in which the search 
  91. string (or word) occurs. The default is to simply count the number of 
  92. occurrences.
  93.  
  94. [-n] prevents the program from putting line numbers in front of each line
  95. that it displays when option -l is active.
  96.  
  97. [EXAMPLES]
  98. ==========
  99.  
  100. C:\> ST books.txt "Stephen King" -sl
  101.  
  102. - Will display and count all lines in books.txt containing ``Stephen King'' 
  103.   (case sensitive).
  104.  
  105. C:\> ST \documents 1994
  106.  
  107. - Will scan for files containing ``1994'', and count the number of times 
  108.   it occurs in each file.
  109.  
  110. [CAPTURING RESULTS]
  111. ===================
  112.  
  113. If you want to write the search results directly to a file, simply use the 
  114. redirection character, '>'. For example:
  115.  
  116. ST \BOOKS " Horror Stories" -sln > logfile.log
  117.  
  118. This will create a file "logfile.log" in the directory that you are running 
  119. ScanText from, and redirect the screen-output to the file. This is especially 
  120. useful for scanning large directories.
  121.  
  122. [NOTE ON 286/8088]
  123. ==================
  124.  
  125. ST will NOT run on a 286/8088 machine, since the program is 32bit, and 
  126. 286/8088 are only 16bit computers. If you have an older system, but would 
  127. still like to use ScanText, you may aquire a 16bit version of ScanText 
  128. directly from the author via email. To do so, write email to Jawed Karim 
  129. with the following line in the SUBJECT:
  130.                    
  131. "REQUEST: ST16"
  132.  
  133. The executable will be sent to you UUencoded.
  134.  
  135. [CREDITS]
  136. =========
  137.  
  138.    v0.9xbeta (base)                 : Jawed Karim & Andrew Tsai
  139.    
  140.    v1.00+ (all additional features) : Jawed Karim
  141.     -port to djgpp from TurboC
  142.     -documentation, distribution
  143.  
  144. Thanks to Ron Smith for pointing out errors in the code.
  145.  
  146. [VERSION HISTORY]
  147. =================
  148.  
  149. 1.06 : Optimized code, improved help screen/documentation.
  150. 1.05 : Significant exe-size reduction. Should run slightly faster. Option
  151.        -l is now available in directory search mode. New option: -n.
  152.        Option -w removed.
  153. 1.041: Non-beta release. Optimized for 486.
  154. 1.04 : (beta) Improved speed, new syntax, options and new look. Compiled with 
  155.        djgpp beta 3.
  156. 1.032: Internal revision.
  157. 1.03 : Total revision. Compiled with djgpp beta 2, 32bit.
  158. 1.02c: Fixed memory allocation faults. Windows 3.1 port available, but not 
  159.        distributed.
  160. 1.02b: Internal revision.
  161. 1.02a: Minor case sensitivity bug in [drive]:\[path] fixed. Improved 
  162.        documentation.
  163. 1.02 : Fixed serious bug, wouldn't let user scan single files, completely 
  164.        rewrote half of code.
  165. 1.01b: Fixed directory bug, alternative drive wouldn't switch back to default 
  166.        directory. Changed output, looks better.
  167. 1.01a: Fixed alternate drives bug; before, if entered would scan c:\ 
  168. 1.01:  New feature: entire paths can now be scanned.
  169. 1.00:  First release version.  Visible bugs worked out of 0.9x 0.9x:
  170.        Beta versions; various options added.
  171.  
  172. [CONTACT AUTHORS]
  173. =================
  174.  
  175. Jawed Karim
  176. Jawed.Karim-1@umn.edu or kari0022@gold.tc.umn.edu
  177.  
  178. Look for updates on: http://umn.edu/~kari0022
  179.