home *** CD-ROM | disk | FTP | other *** search
/ The California Collection / TheCaliforniaCollection.cdr / his012 / smdoor2s.exe / lha / SEARCHME.DOC < prev    next >
Text File  |  1990-04-12  |  8KB  |  197 lines

  1. =============================================================================
  2. SEARCHME 2.00b  (Mar. 90)
  3. By: John A. Qualtrough
  4. 1989,90 Q-Ware Las Cruces, NM
  5.  
  6. Originally developed for:  Art Pike at Waterfront West Wildcat!
  7.                               Las Cruces, NM  (505)-523-4528
  8.                                   24hrs 3/12/24/96 N,8,1
  9.  
  10. These programs can be used free of charge by any and all WildCat! sysops for
  11. on-line or off-line purposes.  The same goes for Sysops of other systems, but
  12. I doubt if it will work.  SEARCHME is dependant upon the structure of the
  13. WildCat! CALLINFO.BBS file which is unique to WildCat!. (sorry Opus)
  14.  
  15. This archive should contain the following files:
  16.  
  17. SEARCHME.EXE           (main Door program)
  18. SEARCHME.CFG           (Door config. file)
  19. SEARCHME.TXT           (Opening screen text file)
  20. SEARCHME.DOC           (this file)
  21. SAMPLE.DB              (Sample database file)
  22. DBMOD.EXE              (Database Modifier pgm)
  23. DBUNMOD.EXE            (Database UN-Modifier pgm)
  24. DBSCAN.EXE             (UNDER DEVELOPMENT)
  25.  
  26. =============================================================================
  27.  
  28.   SEARCHME was written as a Live program (door) for the WILDCAT! BBS.  It will
  29. search through ASCII database files for user specified word(s), phrase(s), or
  30. word fragment(s).  The current search rate is about 30000 lines/minute on a
  31. 10Mhz XT!  DB files must be in the same directory with  SEARCHME.CFG, and
  32. SEARCHME.TXT.  SEARCHME.EXE can be located in the default directory, or in any
  33. subdirectory in the DOS PATH.  The caller information file (CALLINFO.BBS)
  34. can be located anywhere as its' path is specified in the SEARCHME.CFG file.
  35. For more details on pathing of the files, see the section on RUNNING SEARCHME
  36. FROM WILDCAT!
  37.  
  38.  
  39. =============================================================================
  40.  
  41. DATABASE REQUIREMENTS:
  42. ----------------------
  43.  
  44.    SEARCHME will search up to 32 ASCII data files automatically when run.
  45. The database file(s) must be composed of ASCII <cr><lf> terminated lines.
  46. Each entry can be one or more lines which are delimited with the "~" character.
  47. This character must be at the beginning of each entry, and at the end of the
  48. file(s).  Here is an example of a PROGRAMS database:
  49.  
  50.  
  51. ~File Name:  NDD.EXE Norton Disk Doctor
  52. Author   :  Peter Norton
  53. Available:  Part of Norton Advanced Utilities
  54. ~File Name:  DM.EXE Disk Manager
  55. Author   :  On-Track Software
  56. Available:  Puchased alone, or with some Hard Disk units.~
  57.  
  58.  
  59. The above "database" is an example of two entries of three lines each.  All
  60. entries in a database DO NOT have to have the same number of lines. This will
  61. depend upon where you place the delimiter character (~) in the file(s). Be
  62. sure there is one delimiter at the beginning, and one at the end of each file.
  63. A sample database "SAMPLE.DB" should be included with this SEARCHME packet.
  64.  
  65. Included with SEARCHME is a program called: DBMOD.EXE.  This program will
  66. automatically insert the delimiter (~) in the proper positions within your
  67. database files.  It requires the database filename, and a character or string
  68. which is unique to the first line of every entry of your database. In the above
  69. example, the words "File Name:" are unique to the 1st line of each entry. From
  70. this, DBMOD can insert the delimiter at the proper position.  If the file is
  71. formatted to have only one line per entry, just press [ENTER] when asked for
  72. this unique first-line identifier.  If unsure, experiment with the SAMPLE.DB
  73. file provided with this packet.
  74.  
  75. DBUNMOD.EXE is also included.  This program simply reverses the process
  76. performed by DBMOD.  If in the future you decide you no longer wish to use
  77. SEARCHME, you can run DBUNMOD on all the database files to restore them to
  78. original.
  79.  
  80. =============================================================================
  81.  
  82.  
  83. SEARCHME CONFIGURATION FILE:
  84. ---------------------------
  85.  
  86. SEARCHME.CFG format: (6+ line ASCII file)
  87.  
  88. BBS NAME
  89. SYSOP NAME
  90. DRV:\PATH\CALLINFO.BBS
  91. DATABASE CONTENTS               (Movies, Files, etc..)
  92. DOOR TIME LIMIT IN MINUTES.     (optional)
  93. FILE1                           (name of 1st database file)
  94. FILE2                           (name of 2nd database file)
  95. .
  96. .
  97. FILEx                           (name of last database file)
  98.  
  99.  
  100. Sample SEARCHME.CFG (10 lines) :
  101.  
  102. Waterfront West Wildcat!
  103. Art Pike
  104. C:\CAT\CALLINFO.BBS
  105. pd/shareware files list
  106. 15
  107. ATOC
  108. DTOF
  109. GTOL
  110. MTOQ
  111. RTOZ
  112.  
  113.  
  114. If the time limit (line 5) is a "0", the door time limit will be set to
  115. the amount of time the user has remaining. There maybe up to 32 files in the
  116. file list, or as few as one (minimum).
  117.  
  118. NOTE: The sample .CFG MAY have comments in () on the right-hand end of each
  119.       line. If you use this file, DELETE these comments BEFORE use.
  120.  
  121. =============================================================================
  122.  
  123.  
  124. RUNNING SEARCHME FROM WILDCAT!:
  125. -------------------------------
  126.  
  127. SEARCHME is called by running a DOOR batch file which passes the search
  128. path as the command line parameter.  SEARCHME will use this path to locate
  129. the .CFG, .TXT, and the database files used during the run.  In this way,
  130. you need only ONE copy of SEARCHME.EXE to run multiple databases!
  131.  
  132. NOTE:  SEARCHME.EXE must be in the default directory (usually \WILDCAT) OR
  133. ----   located somewhere in the DOS PATH.
  134.  
  135. Sample DOOR batch file which searches a database in C:\DATA1\ directory:
  136.  
  137. ECHO OFF
  138. SEARCHME C:\DATA1\
  139. CAT
  140.  
  141. =============================================================================
  142.  
  143. SEARCHME.TXT FILE:
  144. ------------------
  145.  
  146.    This file is a 1-4 line ASCII text file which is displayed at the opening
  147. screen.  In it you can place any special instructions, notes, etc. which
  148. pertain to the database being searched. SEARCHME.TXT needs to be in the same
  149. directory as the .CFG, and database files.  This is the same directory which
  150. is passed as the command line parameter during a run.
  151.  
  152. =============================================================================
  153.  
  154.  
  155. Note to SYSOPS:
  156. ---------------
  157.  
  158.           SEARCHME may be run off-line by omitting the command line
  159.                    search path. But, you MUST be in the directory with the
  160.                    .CFG, .TXT, and database files when running off-line.
  161. Example:
  162. --------
  163.                C:\>SEARCHME
  164.  
  165. =============================================================================
  166. NEW FEATURE(S) IN 2.00 :
  167.  
  168. Version 2.00b has been "slowed down" to a maximum character output rate of
  169. 240 cps.  The system BAUD rate can be anywhere from 1-115,000 (as usual),
  170. but since some "AT" class machines can (and do) overrun the searial transmit
  171. buffer, I have added this down-shift to prevent the "missing characters"
  172. syndrome.
  173.  
  174. =============================================================================
  175. CONCLUSION:
  176. ----------
  177.  
  178.    I know this documentation is not very good, and the operation is a little
  179. complex.  However, after you get 'er running, I think you'll have a nice door
  180. which you can use for many applications.  If you've tried and tried, and just
  181. can't make it work, drop me a line on Waterfront West WildCat! (see below).
  182.  
  183. =============================================================================
  184. =============================================================================
  185.  
  186. If you have questions, comments, or wish custom modifications, send them to:
  187.  
  188.                        John A. Qualtrough
  189.                        315 Linda Vista Rd.
  190.                        Las Cruces, NM 88005
  191.  
  192. Or leave a [M]essage on Waterfront West Wildcat! (24 Hrs - 3/12/24/96) N,8,1
  193. (505)-523-4528  I am user:   John Qualtrough
  194.  
  195. =============================================================================
  196. P.S.   I also do custom WildCat! doors. (but I DON'T do windows!)
  197.