home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / RA / BBSDOR25.ZIP / BBS_TOOL.DOC < prev    next >
Text File  |  1994-04-03  |  10KB  |  245 lines
  1.  
  2.  
  3.         BBS_TOOL.EXE ; Accessory Utilities for BBS_DOOR.EXE version 2.5
  4.         Version 2.5
  5.         by Mark L. Sarnov
  6.         April 1994
  7.  
  8. This program provides useful utilities to allow the sysop who uses BBS_DOOR.EXE
  9. version 2.5 to perform valuable functions from the DOS command line!
  10.  
  11.         These include:
  12.  
  13.         * Generation of a TEXT FILE LISTING either in COMPLETE form or
  14.                 SEARCHED form with the use of a PRE-DEFINED <SEARCH FILE>
  15.  
  16.         * RENUMBER the listing in case the numbering system gets corrupted.
  17.  
  18.         * IMPORT entries from another BBS's BBS_DOOR.BBS file OR a TEXT FILE
  19.                 Listing using a TEMPLATE definition file.
  20.  
  21. The Execution of this program is as follows:
  22.  
  23. Command Line Parameters :
  24.  
  25. ----------- GENERATING A TEXT FILE LISTING FROM THE COMMAND LINE!!
  26.  
  27.  BBS_TOOL LISTING <textname.ext> <search file>
  28.   where..
  29.   <textname.ext> : the name of the text file to create.
  30.   <search file>  : the name of the file with the Search Information.
  31.     If you do not include a <search file>, all entries will be listed!
  32.  
  33.  BBS_TOOL SEARCHFILE
  34.  
  35.   to create a Search Information File, use this parameter ALONE!
  36.  
  37.  
  38. In order to create a search limited listing, you must first run
  39. BBS_TOOL SEARCHFILE to create a search file! The search file will contain
  40. the criteria used by BBS_TOOL limit the entries written to the text file.
  41.  
  42. After you run BBS_TOOL SEARCHFILE, you will be asked for the name of the
  43. <search file> you wish to create, (e.g. ALBERTA.CFG). You will then be
  44. presented with a simple menu to enter the search criteria. You may then [S]AVE
  45. the info to file and exit or [E]XIT without saving the info.
  46.  
  47.         You may wish to create multiple search files for BBS_TOOL LISTING
  48.         to use and can do so by running BBS_TOOL SEARCHFILE repeatedly.
  49.  
  50. you then use the command line :
  51.  
  52.  BBS_TOOL LISTING <textname.ext> <search file>
  53.  
  54.         to create your text files. If you omit the <search file>, BBS_TOOL will
  55. generate a complete listing.
  56.  
  57. For Example
  58.  
  59.         BBS_TOOL LISTING C:\RA\TXTFILES\ALBERTA.LST C:\BBS_DOOR\ALBERTA.CFG
  60.  
  61. will produce a list called "ALBERTA.LST" in your "C:\RA\TXTFILES" directory
  62. and use the search file "C:\BBS_DOOR\ALBERTA.CFG" to limit the entries listed.
  63.  
  64. or..
  65.  
  66.         BBS_TOOL LISTING C:\RA\TXTFILES\COMPLETE.LST
  67.  
  68. to generate the complete listing.
  69.  
  70.  
  71. ---------- IMPORTING ENTRIES FROM ANOTHER "BBS_DOOR.BBS" FILE!
  72.  
  73.    * This program will also allow the sysop to IMPORT entries from another
  74.      BBS_DOOR.BBS file! This is done as follows:
  75.  
  76.         BBS_TOOL BBS_DOOR c:\Temp\bbs_Door.new /P=MARK_SARNOV
  77.                           |-   Import File  -| |-sysop name-|
  78.  
  79.    BBS_TOOL.EXE will know where your BBS_DOOR.BBS file is located if you
  80.    have set your BBS_DOOR environment variable correctly to the directory
  81.    where your BBS_DOOR system files are located. It will then read the
  82.    entries in "BBS_DOOR.NEW" and insert them in order into your own listing!
  83.  
  84.    In order to allow you as the sysop to [E]dit those entries, the /P=
  85.    parameter will "stamp" those entries with your name, allowing you to
  86.    [E]dit them in BBS_DOOR.EXE.
  87.  
  88.    NOTE: This can take a while to perform based on the speed of your machine
  89.    and the size of the listing since the program is constantly maintaining
  90.    an alphabetized listing and will take longer to search the file as more
  91.    entries are added. DO NOT INTERRUPT THE PROGRAM BECAUSE YOU MAY CORRUPT YOUR
  92.    BBS_DOOR.BBS file. I reccommend you back up your existing BBS_DOOR.BBS file
  93.    in case of a power failure or God Only Knows what else! ;)
  94.  
  95.  
  96. ---------- IMPORTING ENTRIES FROM A FORMATTED TEXT FILE!
  97.  
  98.    This function is perhaps the most useful feature of BBS_TOOL.EXE. You can
  99.    "teach" BBS_TOOL how to read a text file listing based on a "TEMPLATE" file
  100.    which has information on how to read a BBS Listing from a TEXT FILE!
  101.  
  102.    I have included "TEMPLBDR.250" to illustrate how you can read the TEXT FILE
  103.    created by BBS_DOOR.EXE version 2.5 into your own BBS_DOOR.BBS file. You
  104.    may wish to do this if you downloaded a listing from another BBS that
  105.    also wisely chose to use BBS_DOOR.EXE version 2.5! :)
  106.  
  107. Step 1: The Template File
  108.  
  109.      The template file is a text file that contains reserved words followed
  110.      by co-ordinates and lengths of fields. These settings will allow BBS_TOOL
  111.      to locate the desired information and create the entries that will be
  112.      added to your present BBS_DOOR.BBS.
  113.  
  114. The reserved words are:
  115.         BBSNAME        SOFTWARE         COMMENTS1
  116.         NUMBER         BAUD_RATES       COMMENTS2
  117.         SYSOPNAME      NETWORKS         COMMENTS3
  118.         LOCATION       HOURS
  119.  
  120.   which are followed by a :<Line Number>-<Column Number>#<Field Length>
  121.  
  122.         The reserved words are rather self explanatory!
  123.  
  124. For example, look at this fragment of a local BBS listing. (NON BBS_DOOR.EXE)
  125.  
  126. ; City   BBS Name               Number   Software  Networks
  127. ;                                          \vv/
  128.   E Hfd  Alien Nation           290-8615  9 TA 1   F320,D105
  129.   Nwgtn  ARRL FS HQ lines 1-4   666-0578  9 WC 1   F205,A555
  130.   Nwgtn  ARRL FS HQ upload node 665-0090  9 WC 1   A120,F205
  131.   E Hfd  Bit Bucket (HUGE)      568-6663  9 GB 45  P232,F278
  132. ;
  133. ;
  134.         In the above listing, EACH entry is located on a single line, and not
  135.         all fields available in BBS_DOOR.EXE are represented. What to do?
  136.         Just create a file called "TEMPL01.HMB" with the following lines:
  137.  
  138. BBSNAME:01-10#22
  139. NUMBER:01-33#08
  140. LOCATION:01-03#05
  141. SOFTWARE:01-45#02
  142. NETWORKS:01-52#15
  143.  
  144.         Notice each reserved word has a ":" followed by a 2 digit number which
  145.          designates the LINE NUMBER for the entry.
  146.         Then there is a "-" followed by another 2 digit number which designates
  147.          the COLUMN NUMBER to start reading the information from!
  148.         Then there is a "#" followed by another 2 digit number which designates
  149.          the number of characters to read from the COLUMN NUMBER.
  150.  
  151. REMEMBER!! All digits must be represented in TWO DIGIT FORM! so ONE is "01",
  152.                 TWO is "02", etc..
  153.  
  154.         Since the HIGHEST Line Number designated in the template file is "01",
  155.         BBS_TOOL will only read ONE LINE AT A TIME FOR EACH ENTRY'S
  156.         INFORMATION!
  157.  
  158.         But suppose you have a fancy listing that uses multiple lines when
  159.         creating a listing of its entries.. like BBS_DOOR.EXE?
  160.         Take the following fragment from a BBS_DOOR.EXE text file:
  161. ;
  162. BBS Name  : Fozzy's Place                  Number    : 203-678-0751
  163. Location  : Avon, CT
  164. Sysop     : Fozzy Bear                     Software  : Remote Access                 
  165. Baudrates : 2400-14400                     Hours     : all day long!
  166. Networks  : Fidonet, Adultlinks, CATNET, RESHET, OURNET
  167. Comments  :
  168. Great ONLINE Games, Files, Message Bases!
  169. Unique and Interesting stuff as well!
  170. Large Adult Section, with CD-ROM!!
  171. ;
  172.  
  173.  You would create a template file like "TEMPLBDR.250" with the following:
  174.  
  175. BBSNAME:01-13#25
  176. NUMBER:01-56#13
  177. SYSOPNAME:03-13#25
  178. LOCATION:02-13#25
  179. SOFTWARE:03-56#20
  180. BAUD_RATES:04-13#25
  181. NETWORKS:05-13#25
  182. HOURS:04-56#20
  183. COMMENTS1:07-13#60
  184. COMMENTS2:08-13#60
  185. COMMENTS3:09-13#60
  186.  
  187.                                 IMPORTANT!
  188.         The above template file would instruct BBS_TOOL.EXE where to search
  189.         for the correct information to place into an entry. Since "09" is the
  190.         highest LINE NUMBER listed, BBS_TOOL.EXE would read BLOCKS of NINE
  191.         Lines to "digest" and convert into an entry! You are allowed up to
  192.         ELEVEN (11) lines per block (one line per each entry field)
  193.  
  194. NOTE! All lines starting with a ";" in the BBS TEXT FILE LISTING will
  195.       be ignored! HOWEVER, once BBS_TOOL finds a line that does not start
  196.       with a ";", it will read the MAX NUM LINES identified in the template
  197.       file seqentially into the BLOCK, regardless of ";". THEREFORE : there
  198.       should be no ";" between the lines of a single entry, only put ";" in
  199.       lines BETWEEN entries!! Get it?
  200.  
  201.  
  202.         Step 2 : Using the TEMPLATE FILE!
  203.  
  204.         The template file must be named : "TEMPLxxx.xxx". The "TEMPL" part of
  205.         the filename tells BBS_TOOL.EXE that you are attempting to import
  206.         a TEXT FILE! Thus you may have oodles of template files, as long as
  207.         they all start with "TEMPL"
  208.  
  209.   The command line for the second example is :
  210.  
  211.         BBS_TOOL TEMPLBDR.250 C:\DOWNLOAD\RA-USA.LST
  212.  
  213.         BBS_TOOL will IMPORT the new entries into your BBS_DOOR.BBS file and
  214.         SKIP entries with IDENTICAL BBS Names found in your listing. (non-case
  215.         sensetive)
  216.  
  217. Note: The Text file created by BBS_DOOR.EXE version 2.0 is slightly different
  218.       than version 2.5.. So I have included both TEMPLBDR.200 for textfiles
  219.       created with BBS_DOOR.EXE version 2.0, and TEMPLBDR.250 for textfiles
  220.       created with BBS_DOOR.EXE version 2.5 or BBS_TOOL.EXE version 2.5. Please
  221.       check the top of the listing to learn the program version that created
  222.       the listing.
  223.  
  224. ----------------  RENUMBERING the LISTING!!
  225.  
  226.         If for some reason, your BBS Listing becomes numerically corrupted,
  227.         just run :
  228.  
  229.         BBS_TOOL RENUMBER
  230.  
  231.         to renumber the entries in your BBS_DOOR.BBS file.
  232.  
  233. --------------------------------------------------------------------
  234.                                   DISCLAIMER!!
  235.       This program is not guaranteed to do anything but take up space on your
  236.       hard drive. It has been tested fairly extensively and should not corrupt
  237.       any of your RA files, however.. Backup your files consistently and often,
  238.       a rule that applies to any computer user!!
  239.  
  240.         That's IT! If you can think of other options to add to this Tools
  241.         program for BBS_DOOR.EXE, just netmail me or leave me an Echo Mail
  242.         message in RA Utilities!
  243.  
  244.         
  245.