home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / BBSDOR33.ZIP / BBS_TOOL.DOC < prev    next >
Text File  |  1994-12-28  |  15KB  |  356 lines
  1.  
  2.  
  3.         BBS_TOOL.EXE ; Accessory Utilities for BBS_DOOR.EXE version 3.3
  4.         Version 3.30
  5.         by Mark L. Sarnov
  6.         November 1994
  7.  
  8. This program provides useful utilities to allow the sysop who uses BBS_DOOR.EXE
  9. version 3.3 to perform valuable functions from the DOS command line!
  10.  
  11.         These include:
  12.  
  13.         * Generation of Detailed or Brief BBS TEXT FILE LISTINGS in either
  14.                COMPLETE form or SEARCHED form with the use of a PRE-DEFINED
  15.                <SEARCH FILE>
  16.  
  17.         * RENUMBER the listing in case the numbering system gets corrupted.
  18.  
  19.         * IMPORT entries from another BBS's BBS_DOOR.BBS file OR a TEXT FILE
  20.                 Listing using a TEMPLATE definition file.
  21.  
  22. NEW!!   * POSTERS will produce a text file listing of the each entry's author
  23.           "poster".
  24.  
  25. NEW!!   * COLORS will launch a Color Configuration Screen that will create
  26.           BBS_DOOR.CLR for use with BBS_DOOR.EXE version 3.3.
  27.  
  28. The Execution of this program is as follows:
  29.  
  30. Command Line Parameters :
  31.  
  32. ----------- GENERATING A TEXT FILE LISTING FROM THE COMMAND LINE!!
  33.  
  34.  BBS_TOOL LISTING <textname> <search file>
  35.   or
  36.  BBS_TOOL SHORTLIST <textname> <search file>
  37.   where..
  38.   <textname> : the name of the text file to create, do not include the
  39.                 EXTENSION.
  40.   <search file>  : the name of the file with the Search Information.
  41.     If you do not include a <search file>, all entries will be listed!
  42.  
  43. Note: LISTING will only produce a TEXTNAME.ASC whereas SHORTLIST will
  44.         produce 2 files, TEXTNAME.ANS and TEXTNAME.ASC.
  45.  
  46.  BBS_TOOL SEARCHFILE
  47.  
  48.   to create a Search Information File, use this parameter ALONE!
  49.  
  50.  
  51. In order to create a search limited listing, you must first run
  52. BBS_TOOL SEARCHFILE to create a search file! The search file will contain
  53. the criteria used by BBS_TOOL limit the entries written to the text file.
  54.  
  55. After you run BBS_TOOL SEARCHFILE, you will be asked for the name of the
  56. <search file> you wish to create, (e.g. ALBERTA.CFG). You will then be
  57. presented with a simple menu to enter the search criteria. You may then [S]AVE
  58. the info to file and exit or [E]XIT without saving the info.
  59.  
  60.         You may wish to create multiple search files for BBS_TOOL LISTING
  61.         to use and can do so by running BBS_TOOL SEARCHFILE repeatedly.
  62.  
  63. you then use the command line :
  64.  
  65.  BBS_TOOL LISTING <textname> <search file>
  66.  
  67.         to create your detailed text file listing. If you omit the
  68.         <search file>, BBS_TOOL will generate a complete detailed listing.
  69.  
  70. This is a fragment of a Detailed listing text file:
  71.  
  72. -----------------------------------------------------------------------------
  73. ;                                  BBS Listing
  74. ;Created by BBS_TOOL.EXE, BBS Accessory Tools for BBS_DOOR v3.30 by Fozzy INC.
  75. ;
  76. BBS Name  : -={ The Warp Zone BBS }=-      Number    : (504)868-777 
  77. Location  : Houma, La.                    
  78. Sysop     : Marvin Morrison                Software  : Ra 2.01+                      
  79. Baudrates : 2400 - 14,4 Bds                Hours     : 24 Hours            
  80. Networks  : FidoNet 1:384/16                                            
  81. Comments  :
  82. .\\usic .\\usic .\\usic... Over 10,000 Music Sound Files Onl
  83. CMF   SND   WAV   MID   VOC   ROL   MOD   CMS               
  84. ;                                
  85. ;
  86. ;
  87. -----------------------------------------------------------------------------
  88.  
  89. For Example
  90.  
  91.         BBS_TOOL LISTING C:\RA\TXTFILES\ALBERTA C:\BBS_DOOR\ALBERTA.CFG
  92.  
  93. will produce a list called "ALBERTA.ASC" in your "C:\RA\TXTFILES" directory
  94. and use the search file "C:\BBS_DOOR\ALBERTA.CFG" to limit the entries listed.
  95.  
  96. or..
  97.  
  98.         BBS_TOOL LISTING C:\RA\TXTFILES\COMPLETE
  99.  
  100. to generate the complete listing called "COMPLETE.ASC".
  101.  
  102.  
  103.         BBS_TOOL SHORTLIST <textname> <search file>
  104.  
  105.        If you only desire a listing which has the BBS NAME, NUMBER, and
  106.        LOCATION on each line, you may use the BBS_TOOL SHORTLIST function!
  107.  
  108. The Following is a sample from a SHORTLIST text file:
  109.  
  110. -----------------------------------------------------------------------------
  111. ;                             Short BBS Listing
  112. ;Created by BBS_TOOL.EXE, BBS Accessory Tools for BBS_DOOR v3.30 by Fozzy INC.
  113. ;
  114. ;     BBS NAME                    Number            Location
  115. A.C.M.E. BBS                    317-640-9295   Anderson, Ind.                
  116. Agri-Specialists Bbs            918-255-6542   Wann, OK                      
  117. Ansi-Mation Alley               910-346-6543   Jacksonville, NC              
  118. Apex BBS                        602-860-2947   Scottsdale, AZ                
  119. ARC ANGEL EXPRESS               417-864-4573   SPRINGFILED, MO               
  120.  
  121. -----------------------------------------------------------------------------
  122.         As you can see, this entry is much more compact than the text file
  123.         created with BBS_TOOL LISTING and is useful for displaying or when
  124.         keeping local BBS lists!
  125.  
  126. The 2 files created are <textname>.ANS and <textname>.ASC.. The ANS file will
  127. be in ANSI colors adopted from the BBS_DOOR.CLR file if found, otherwise it
  128. will use the default colors. The ASC file will be a plain old text file, no
  129. colors involved!
  130.  
  131.  
  132. NEW!!------------  Displaying each entry's POSTERS!
  133.  
  134.         If you have some harrassing users that post BOGUS entries, they are
  135.         no longer anonymous to you! You now have a WEAPON!
  136.  
  137.         To create a text file with the authors of ALL the entries in your
  138.         BBS_DOOR.BBS file type the following:
  139.  
  140.         BBS_TOOL POSTERS <postlist>
  141.  
  142.                 where <postlist> is the name of the textfile WITHOUT THE
  143.                 EXTENSION (.ASC will be added) that will be generated.
  144.  
  145.         I.E.
  146.              BBS_TOOL POSTERS c:\ra\postlist
  147.  
  148.                 will create the textfile "POSTLIST.ASC" wit the poster's names
  149.                 next to the BBS NAME and BBS NUMBER similar to the format to
  150.                 the SHORTLIST command.
  151.  
  152. NEW!!-------  Creating the Color Configuration File for BBS_DOOR.EXE
  153.  
  154.         BBS_DOOR.EXE version 3.3 now can be color configured. This is done
  155.         with a color configuration file called : BBS_DOOR.CLR that BBS_TOOL.EXE
  156.         now creates. To create the file, type the following:
  157.  
  158.         BBS_TOOL COLORS
  159.  
  160.         and you will be presented with the COLOR CONFIGURATION SCREEN. The
  161.         screen will have a TOP WINDOW with a sample BBS LISTING SCREEN.
  162.         You will note the numbers in yellow on black in <#> that stand for
  163.         each element of the display. The BOTTOM WINDOW is the COLOR CHART
  164.         with numbers representing their respective colors. The CENTER of
  165.         the screen is the PROMPT. You may change individual elements of the
  166.         display and see their impact immediately or you may select from the
  167.         BUILT IN DEFAULTS that are presented at the Prompt. (Default, Cinnamon,
  168.         Wingtips, Rugby, Ice) These too are displayed for you viewing. Once
  169.         you are satisfied with the result, you can <Q>uit the program.. The
  170.         program will ask if you want to "Save the Color Settings?" and you hit
  171.         Y for YES and N for NO. (I know, difficult concept)
  172.  
  173.         The file BBS_DOOR.CLR will be created in your BBS_DOOR directory. If
  174.         you run the program with an existent BBS_DOOR.CLR, the program will
  175.         first ask if you would like to use the colors stored in that file
  176.         or start at the default colors. To that question you answer Yes or
  177.         No.
  178.  
  179.  
  180. ---------- IMPORTING ENTRIES FROM ANOTHER "BBS_DOOR.BBS" FILE!
  181.  
  182.    * This program will also allow the sysop to IMPORT entries from another
  183.      BBS_DOOR.BBS file! This is done as follows:
  184.  
  185.         BBS_TOOL IMPORT BBS_DOOR c:\Temp\bbs_Door.new /P=MARK_SARNOV
  186.                                  |-   Import File  -| |-sysop name-|
  187.  
  188.    BBS_TOOL.EXE will know where your BBS_DOOR.BBS file is located if you
  189.    have set your BBS_DOOR environment variable correctly to the directory
  190.    where your BBS_DOOR system files are located. It will then read the
  191.    entries in "BBS_DOOR.NEW" and insert them in order into your own listing!
  192.  
  193.    In order to allow you as the sysop to [E]dit those entries, the /P=
  194.    parameter will "stamp" those entries with your name, allowing you to
  195.    [E]dit them in BBS_DOOR.EXE.
  196.  
  197.    NOTE: This can take a while to perform based on the speed of your machine
  198.    and the size of the listing since the program is constantly maintaining
  199.    an alphabetized listing and will take longer to search the file as more
  200.    entries are added. DO NOT INTERRUPT THE PROGRAM BECAUSE YOU MAY CORRUPT YOUR
  201.    BBS_DOOR.BBS file. I reccommend you back up your existing BBS_DOOR.BBS file
  202.    in case of a power failure or God Only Knows what else! ;)
  203.  
  204.  
  205. ---------- IMPORTING ENTRIES FROM A FORMATTED TEXT FILE!
  206.  
  207.    This function is perhaps the most useful feature of BBS_TOOL.EXE. You can
  208.    "teach" BBS_TOOL how to read a text file listing based on a "TEMPLATE" file
  209.    which has information on how the BBS Listing File is formatted!
  210.  
  211.    I have included "TEMPLBDR.250" to illustrate how you can read the TEXT FILE
  212.    created by BBS_DOOR.EXE version 3.3 into your own BBS_DOOR.BBS file. You
  213.    may wish to do this if you downloaded a listing from another BBS that
  214.    also wisely chose to use BBS_DOOR.EXE version 3.3! :)
  215.  
  216. Step 1: The Template File
  217.  
  218.      The template file is a text file that contains RESERVED WORDS followed
  219.      by co-ordinates and lengths of fields. These settings will allow BBS_TOOL
  220.      to locate the desired information and create the entries that will be
  221.      added to your present BBS_DOOR.BBS file.
  222.  
  223. The RESERVED WORDS are:
  224.  
  225.         BBSNAME        SOFTWARE         COMMENTS1
  226.         NUMBER         BAUD_RATES       COMMENTS2
  227.         SYSOPNAME      NETWORKS         COMMENTS3
  228.         LOCATION       HOURS
  229.  
  230.   which are followed by a :<Line Number>-<Column Number>#<Field Length>
  231.  
  232.         The reserved words are rather self explanatory!
  233.  
  234. For example, look at this fragment of a local BBS listing. (NON BBS_DOOR.EXE)
  235.  
  236. ; City   BBS Name               Number   Software  Networks
  237. ;                                          \vv/
  238.   E Hfd  Alien Nation           290-8615  9 TA 1   F320,D105
  239.   Nwgtn  ARRL FS HQ lines 1-4   666-0578  9 WC 1   F205,A555
  240.   Nwgtn  ARRL FS HQ upload node 665-0090  9 WC 1   A120,F205
  241.   E Hfd  Bit Bucket (HUGE)      568-6663  9 GB 45  P232,F278
  242. ;
  243. ;
  244.         In the above listing, EACH entry is located on a single line, and not
  245.         all fields available in BBS_DOOR.EXE are represented. What to do?
  246.         Just create a file called "TEMPL01.HMB" with the following lines:
  247.  
  248. BBSNAME:01-10#22
  249. NUMBER:01-33#08
  250. LOCATION:01-03#05
  251. SOFTWARE:01-45#02
  252. NETWORKS:01-52#15
  253.  
  254.         Notice each reserved word has a ":" followed by a 2 digit number which
  255.          designates the LINE NUMBER for the entry.
  256.         Then there is a "-" followed by another 2 digit number which designates
  257.          the COLUMN NUMBER to start reading the information from!
  258.         Then there is a "#" followed by another 2 digit number which designates
  259.          the number of characters to read from the COLUMN NUMBER.
  260.  
  261. REMEMBER!! All digits must be represented in TWO DIGIT FORM! so ONE is "01",
  262.                 TWO is "02", etc..
  263.  
  264.         Since the HIGHEST Line Number designated in the template file is "01",
  265.         BBS_TOOL will only read ONE LINE AT A TIME FOR EACH ENTRY'S
  266.         INFORMATION!
  267.  
  268.         But suppose you have a fancy listing that uses multiple lines when
  269.         creating a listing of its entries.. like BBS_DOOR.EXE?
  270.         Take the following fragment from a BBS_DOOR.EXE text file:
  271. ;
  272. BBS Name  : Fozzy's Place                  Number    : 717-671-1065
  273. Location  : Harrisburg, PA
  274. Sysop     : Fozzy Bear                     Software  : Remote Access                 
  275. Baudrates : 2400-14400                     Hours     : all day long!
  276. Networks  : Fidonet, Adultlinks, CATNET, RESHET, OURNET
  277. Comments  :
  278. Great ONLINE Games, Files, Message Bases!
  279. Unique and Interesting stuff as well!
  280. Large Adult Section, with CD-ROM!!
  281. ;
  282.  
  283.  You would create a template file like "TEMPLBDR.250" with the following:
  284.  
  285. BBSNAME:01-13#25
  286. NUMBER:01-56#13
  287. SYSOPNAME:03-13#25
  288. LOCATION:02-13#25
  289. SOFTWARE:03-56#20
  290. BAUD_RATES:04-13#25
  291. NETWORKS:05-13#25
  292. HOURS:04-56#20
  293. COMMENTS1:07-13#60
  294. COMMENTS2:08-13#60
  295. COMMENTS3:09-13#60
  296.  
  297.                                 IMPORTANT!
  298.         The above template file would instruct BBS_TOOL.EXE where to search
  299.         for the correct information to place into an entry. Since "09" is the
  300.         highest LINE NUMBER listed, BBS_TOOL.EXE would read BLOCKS of NINE
  301.         Lines to "digest" and convert into an entry! You are allowed up to
  302.         ELEVEN (11) lines per block (one line per each entry field)
  303.  
  304. NOTE! All lines starting with a ";" in the BBS TEXT FILE LISTING will
  305.       be ignored! HOWEVER, once BBS_TOOL finds a line that does not start
  306.       with a ";", it will read the MAX NUM LINES identified in the template
  307.       file seqentially into the BLOCK, regardless of ";". THEREFORE : there
  308.       should be no ";" between the lines of a single entry, only put ";" in
  309.       lines BETWEEN entries!! Get it?
  310.  
  311.  
  312.         Step 2 : Using the TEMPLATE FILE!
  313.  
  314.         The template file must be named : "TEMPLxxx.xxx". The "TEMPL" part of
  315.         the filename tells BBS_TOOL.EXE that you are attempting to import
  316.         a TEXT FILE! Thus you may have oodles of template files, as long as
  317.         they all start with "TEMPL"
  318.  
  319.   The command line for the second example is :
  320.  
  321.         BBS_TOOL IMPORT TEMPLBDR.250 C:\DOWNLOAD\RA-USA.LST
  322.  
  323.         BBS_TOOL will IMPORT the new entries into your BBS_DOOR.BBS file and
  324.         SKIP entries with IDENTICAL BBS Names found in your listing. (non-case
  325.         sensetive)
  326.  
  327. Note: The Text file created by BBS_DOOR.EXE version 2.0 is slightly different
  328.       than version 3.3.. So I have included both TEMPLBDR.200 for textfiles
  329.       created with BBS_DOOR.EXE version 2.0, and TEMPLBDR.250 for textfiles
  330.       created with BBS_DOOR.EXE version 3.3 or BBS_TOOL.EXE version 3.3. Please
  331.       check the top of the listing to learn the program version that created      the listing.
  332.  
  333. ----------------  RENUMBERING the LISTING!!
  334.  
  335.         If for some reason, your BBS Listing becomes numerically corrupted,
  336.         just run :
  337.  
  338.         BBS_TOOL RENUMBER
  339.  
  340.         to renumber the entries in your BBS_DOOR.BBS file.
  341.  
  342.  
  343.  
  344. --------------------------------------------------------------------
  345.                                   DISCLAIMER!!
  346.       This program is not guaranteed to do anything but take up space on your
  347.       hard drive. It has been tested fairly extensively and should not corrupt
  348.       any of your RA files, however.. Backup your files consistently and often,
  349.       a rule that applies to any computer user!!
  350.  
  351.         That's IT! If you can think of other options to add to this Tools
  352.         program for BBS_DOOR.EXE, just netmail me or leave me an Echo Mail
  353.         message in RA Utilities!
  354.  
  355.         
  356.