home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / BBSDOR33.ZIP / BBS_DOOR.DOC < prev    next >
Text File  |  1994-12-28  |  17KB  |  391 lines
  1.  
  2.  
  3.         BBS_DOOR version 3.30
  4.         The Premiere BBS Listing Door!
  5.         by Mark L. Sarnov, Fozzy INC.
  6.         December 1994
  7.  
  8. The BBS_DOOR system includes :
  9.  
  10.        BBS_DOOR.EXE    : the executable door file.
  11.        BBS_TOOL.EXE    : Command Line program to generate listings, RENUMBER
  12.                          the entries, and IMPORT entries from another
  13.                          BBS_DOOR.BBS file or a TEXT file Listing into your
  14.                          listing!
  15.        BBS_DOOR.XFR    : Protocol/Archive Definition file for Downloading.
  16.        BBS_DOOR.CLR    : Color Configuration File.. See BBS_TOOL.DOC for info
  17.        BBS_LOGO.RIP    : Intro screen for BBS_DOOR.EXE in RIP format.
  18.        BBSDOOR1.RIP    : Main Menu Control Panel in RIP format, No Nuking.
  19.        BBSDOOR2.RIP    : Main Menu Control Panel in RIP format with Nuking!
  20.        BBSEARCH.RIP    : Search Control Panel in RIP format.
  21.        BBSHELP1.ANS/ASC/RIP
  22.                        : Help Screens for callers without Nuking Security
  23.        BBSHELP2.ANS/ASC/RIP
  24.                        : Help Screens for callers with Nuking Security.
  25.        BBSHELP3.ANS/ASC/RIP
  26.                        : Help Screen for Search Function.
  27.  
  28.        BBS_DOOR.DOC    : This File!
  29.        BBS_TOOL.DOC    : Doccumentation for BBS_TOOL.EXE
  30.        BBS_DOOR.REG    : The BBS_DOOR registration form! <hint, hint!>
  31.  
  32. supplemental files :
  33.  
  34.         11TO33.EXE     : Use this file to update your BBS_DOOR.BBS from
  35.                           version 1.0, 1.1 to 3.3.
  36.         20TO33.EXE     : Use this program to update your old BBS_DOOR.BBS
  37.                           file if you have used BBS_DOOR version 2.0.
  38.         TEMPLBDR.250   : Sample TEMPLATE file to be used with BBS_TOOL.EXE
  39.                           when importing a TEXT FILE LISTING created by
  40.                           BBS_DOOR.EXE v2.5-3.3 or BBS_TOOL.EXE v2.5-3.3.
  41.         TEMPLBDR.200   : Sample TEMPLATE file to be used with BBS_TOOL.EXE
  42.                           when importing a TEXT FILE LISTING created by
  43.                           BBS_DOOR.EXE v2.0 or above.
  44.  
  45. Extra files in archive :
  46.  
  47.         BBS_DOOR.NEW   : What is new in the current and preceeding versions of
  48.                           BBS_DOOR.EXE.
  49.         BBS_TOOL.NEW   : What is new in the current and preceeding versions of
  50.                           BBS_TOOL.EXE.
  51.         README.1ST     : File you should read first, definately!
  52.         FILE_ID.DIZ    : Description file of BBSDOR32.ZIP
  53.  
  54.  
  55. What BBS_DOOR.EXE does!
  56.  
  57.         This door will create and maintain a BBS listing for your BBS. This
  58.         program features :
  59.  
  60.         * RIP Graphics Support!
  61.         * Color Configurable by SYSOP! (NEW!)
  62.         * DESQVIEW Awareness! (a wonderful thing)
  63.         * Compatibility with any system using a RA DORINFO1.DEF drop file!
  64.         * Easy execution as Type 7 (External Door) menu option
  65.         * Alphabetized listing of the BBS's
  66.         * Brief Display of BBS name, number, location as well as ability
  67.           to examine details of an entry.
  68.         * Detailed entry lookup including
  69.             BBS Name, Number, Sysop, Location,
  70.             Software, Baud Rates, Hours of operation,
  71.             Networks the BBS is on, and 3 lines of additional comments!
  72.         * Almost Unlimited number of listings! ([9999] numbered lisings)
  73.         * Checking for Duplicate entries, regardless of how user enters
  74.           BBS name (i.e. "FOZZY'S PLACE" will not be added if "Fozzy's Place"
  75.           is already listed)
  76.         * Editing of specific entries provided the user editing is the user
  77.           who posted the listing OR is the SYSOP of the BBS!
  78.         * Ability to NUKE (Delete) listings if security level is above the
  79.           security level indicated on the command line.
  80.         * Ability to CREATE ARCHIVED LISTINGS for Download!!
  81.         * Generation of BBS listings in TEXT FILE FORMAT!
  82.         * Ability to DOWNLOAD the Entire or Limited Listing from within the
  83.                 door! (External transfer program required)
  84.         * Ability to Search desired entries based on specific field criteria!
  85.                 ** Now Advanced Cross Indexing!! **
  86.         * Help screens in ANSI/ASCII/RIP format called from within program!
  87.         * more stuff too! Try the program and see!!
  88.  
  89. How to setup and use this door for your BBS!
  90.  
  91. SETUP:
  92.         First create a directory where you would like the BBS_DOOR program
  93.         files to reside, then copy all the archive files to that directory!
  94.  
  95.         For example, create the directory "C:\RA\BBS_DOOR", then copy all
  96.         files from the BBS_DOOR archive to "C:\RA\BBS_DOOR".
  97.  
  98.         Then... make sure the following environment variables are set up.
  99.  
  100.   The program will search for a unique environment variable called
  101.      BBS_DOOR so please include :
  102.  
  103.          SET BBS_DOOR=drive:\dir\ <path to BBS_DOOR files>
  104.            in your batch file or your AUTOEXEC.BAT
  105.  
  106.         For example, if you have your files in "C:\RA\BBS_DOOR" then place
  107.  
  108.         SET BBS_DOOR=C:\RA\BBS_DOOR
  109.  
  110.                 in your AUTOEXEC.BAT file!
  111.  
  112.        This is VITAL for BBS_DOOR to find the files BBS_DOOR.XFR,
  113.           BBSHELP*.ANS/ASC/RIP, BBSDOOR*.RIP, BBSEARCH.RIP, and
  114.           BBS_DOOR.BBS program files!
  115.  
  116.   The program will also search for the RA environment variable..
  117.  
  118.      (i.e. SET RA=c:\ra in AUTOEXEC.BAT)
  119.  
  120.      to locate the DORINFO1.DEF drop file from your BBS program in order to
  121.      operate properly, IF you are running single node.. If you are operating
  122.      multi-node, then the program will search the current directory for
  123.      DORINFO1.DEF. (RA 2.0X users! RIP graphics are enabled when the
  124.      EXITINFO.BBS file is in the same directory as DORINFO1.DEF.. as it should
  125.      be!)
  126.  
  127.           Make sure the environment variables are set correctly!
  128.  
  129. Note!   If you find that you do not have enough environment space and get an
  130.         "Out of Environment Space" error from DOS, you may increase your
  131.         environment size with the following line in your CONFIG.SYS
  132.  
  133. SHELL=C:\DOS\COMMAND.COM C:\DOS\ /e:512 /p
  134.  
  135.         The /e:512 will allocate 512 bytes for environment space. DOS allocates
  136.         256 bytes by default. This command line will DOUBLE your environment!
  137.         (So will tons of Twinkies!)
  138.  
  139.  
  140. Execution
  141.  
  142.         This program requires the installation of a FOSSIL driver prior to
  143.         its execution. If your BBS does not require the use of a FOSSIL, this
  144.         program has been tested with Ray Guinns X00.SYS driver and BNU.COM by
  145.         someone else. These should be loaded into memory prior to running
  146.         BBS_DOOR.EXE.
  147.  
  148. X00 users! If you are running MULTI LINE and find a CTS timeout error, you need
  149.            to keep the FOSSIL HOT when you shell to the door! Don't forget to
  150.            include a *H on the Optional Data Field Line to keep the program
  151.            from giving you this error! (Thanx to Joe Delvecchio for that one!)
  152.  
  153. Note! These methods are for RemoteAccess Systems! Your BBS package may use
  154.         different menu types to execute a door.. If you got other doors
  155.         working, you should have no problems with this one! :)
  156.  
  157.  [Method 1]
  158.  
  159.  
  160. Run this program as a Type 7 external door with the command line :
  161.  
  162.  c:\RA\BBS_DOOR\BBS_DOOR.EXE /S=<sec level> /N=*N /L=Filename /R<+/-> *M *D
  163.  
  164.    the /S=<sec level> will be the minimum level a person can
  165.              Nuke (delete) a BBS listing.. Handy if you want to allow only
  166.              Visiting sysops to delete listings or set it to the SYSOP security
  167.              level to insure only the SYSOP can nuke a listing. This option
  168.              is MANDATORY!
  169.  
  170.    the /N is for the node you are launching from.. default is
  171.              node 1. This parameter is optional.
  172.  
  173.    the /L=Filename determines if you would like the program
  174.              to allow the DOWNLOADING of the TWO types of BBS LISTINGS!
  175.  
  176.        **NOTE : Do not include the filename's EXTENSION! See the DOWNLOAD
  177.        section under PROGRAM FEATURES below for details!
  178.  
  179.    the /R+ will FORCE RIP GRAPHICS ON!
  180.        /R- will FORCE RIP GRAPHICS OFF! (Disable RIP Graphics in BBS_DOOR.EXE)
  181.  
  182.         The /R switch  is intended for NON-RA 2.0X BBSs to manage the
  183.         RIP Graphics.. RA 2.0X systems do not need this switch since
  184.         BBS_DOOR will check the EXITINFO.BBS to see if the caller is RIP
  185.         capable. If you are running a NON-RA 2.0x system but CAN create a
  186.         RA 2.01 EXITINFO.BBS file, you may OMIT this parameter and rely on
  187.         the information provided by EXITINFO.BBS.
  188.  
  189.         /R+ will FORCE RIP Graphics regardless of:
  190.                1. what is stated in EXITINFO.BBS and
  191.                2. whether the EXITINFO.BBS file is found.
  192.  
  193.         /R- will OVERRIDE the information in the RA 2.0X compatible EXITINFO.BBS
  194.           drop file and thereby DISABLE RIP Graphics.
  195.  
  196.         If this switch is not included, BBS_DOOR.EXE will search for an
  197.         EXITINFO.BBS file in the current directory and attempt to get the
  198.         callers RIP capability. If an EXITINFO.BBS file is not found, BBS_DOOR
  199.         will NOT use RIP graphics.
  200.  
  201.      *M will allow RemoteAccess to swap itself to EMS/XMS (one of the
  202.         two) so BBS_DOOR will occupy conventional memory and also have room
  203.         for the External File Transfer Protocols to run properly!
  204.  
  205.      *D will force RemoteAccess to produce a DORINFO1.DEF without the "-R"
  206.         denoting error correction after the baud rate.
  207.  
  208. For Example :
  209.  
  210.         Type 7 (Run External Door)
  211.         BBS_DOOR.EXE /S=100 /N=*N /L=C:\RA\BBSLIST *M *D
  212.         Hot Key : L
  213.         AutoExecute : No
  214.  
  215.         will only allow users equal or over a security of 100 to nuke entries
  216.         and Downloading is enabled with the files "C:\RA\BBSLIST.LST"
  217.         transferred as the COMPLETE listing and "C:\RA\BBSLIST.SCH" as the
  218.         SEARCHED listing. BBS_DOOR.EXE will search for an EXITINFO.BBS file
  219.         and if found, will use the users information regarding RIP graphics
  220.         to enable or disable the RIP Screens.
  221.  
  222. OR..    Type 7 (Run External Door)
  223.         BBS_DOOR.EXE /S=100 /N=*N /L=C:\RA\BBSLIST /R- *M *D
  224.         Hot Key : L
  225.         AutoExecute : No
  226.  
  227.         will do the same as above, HOWEVER RIP Graphics will not be used
  228.         regardless of what the EXITINFO.BBS drop file contains <if found>.
  229.  
  230.  [Method 2]
  231.  
  232.         Run this program after a Type 15, Exit with Errolevel
  233.  
  234.         You can run this program from a batch file like any other Door program.
  235.  
  236.         Just use the same format as noted above in your batch file.
  237.         If you are using BBS software that does not create a DORINFO1.DEF drop
  238.         file, you can run a CONVERTER like QDOOR.EXE, or DM.EXE (Door Master)
  239.         that can create one for you! You may have to fiddle around with
  240.         where you put the DORINFO1.DEF file, but in most cases, put it in
  241.         the directory you are running the batch file from! This goes for
  242.         EXITINFO.BBS as well!
  243.  
  244.  
  245.                ------------ PROGRAM FEATURES!! ---------------
  246.  
  247. [A]dd a BBS:
  248.  
  249.      The program will allow ALL users to Add entries. The Adding of a entry
  250.      is menu driven and the user may edit the entry before saving it to the
  251.      listing.
  252.  
  253.  
  254. [E]dit a BBS:
  255.  
  256.      Users can Edit existing entries provided they are the one who
  257.      entered it in the first place. (Sysops can Edit ANY entry).
  258.  
  259.  
  260. [I]nfo on BBS:
  261.  
  262.      Users can obtain more details on an entry than initially displayed.
  263.      The general listing only shows BBS Name, number, location, and whether
  264.      the current caller entered the entry. The caller can enter the number of
  265.      the BBS entry and gain other details.
  266.  
  267.  
  268. [S]earch:
  269.  
  270.      This option in BBS_DOOR version 3.30 presents you with a menu to activate
  271.      certain fields to search and the keywords associated with those fields.
  272.      The fields available for searching and limiting the listings are NAME,
  273.      NUMBER, LOCATION, SYSOP, NUMBER, BAUD RATES, SOFTWARE, and NETWORKS.
  274.      The program will display the number of entries that match the entered
  275.      criteria each time you change a setting. The caller may then
  276.      <D>isplay the List, <R>eset all fields, or <E>xit and do not search.
  277.  
  278.     ** If a <D>isplay Entries is selected when ZERO entries match the criteria
  279.        the [S]earch is disabled but the criteria is saved for modification.
  280.  
  281.        When the [S]earch is activated, the Menu Item for [S]earch will be
  282.        capitalized ([S]earch) and FLASH! <blink, blink>. To disable the
  283.        SEARCH, the caller must choose the [S]EARCH again and [E]xit and
  284.        do not Search from the SEARCH SCREEN.
  285.  
  286.  
  287. [D]OWNLOAD:
  288.  
  289.     Users may download the entire listing (details on each BBS included)
  290.     or a subset of the listing (see below) provided the program has access
  291.     to an external transfer program like CEXYZ.EXE. The program requires a
  292.     "protocol definition file" called BBS_DOOR.XFR and one is included with
  293.     documentation in the file. To use the Download option, you must also use
  294.     the /L=<Filename> parameter when calling the door in order to tell
  295.     BBS_DOOR.EXE  the name of the file listing to transfer! If you have other
  296.     external file transfer programs and set them up correctly, please send me
  297.     a note with the program's command line structure via netmail!
  298.  
  299.     You may use the *B and *P parameter to designate Baud and Port #
  300.     respectively in the BBS_DOOR.XFR file for you multi-line sysops!
  301.  
  302.    BBS_DOOR utilizes the SEARCH feature for the downloadable BBS
  303.       Listing as well. IF the user has the SEARCH ACTIVATED, the caller
  304.       will be asked if he/she would like to download :
  305.  
  306.                 [1] COMPLETE BBS Listing
  307.                 [2] SEARCHED Listing
  308.  
  309.        If the caller selects the COMPLETE Listing, the text file created
  310.           will be named : FILENAME.LST.
  311.  
  312.        If the caller selects the SEARCHED Listing, the text file created
  313.           will be named : FILENAME.SCH
  314.  
  315.        IF the SEARCH is NOT ACTIVATED, BBS_DOOR will default to the COMPLETE
  316.         listing and not prompt the user for a choice of BBS Listings.
  317.  
  318. **   BBS_DOOR now can archive the listing created above into NINE definable
  319.      archive types, such as ZIP, ARJ, LZH. The setup for these archive
  320.      definitions is explained and examples are given in the BBS_DOOR.XFR
  321.      file with adequate doccumentation. The caller will be prompted to choose
  322.      an ARCHIVE format or [N]one, If no ARCHIVE definitions are present in the
  323.      BBS_DOOR.XFR file the uncompressed listing will be transferred.
  324.  
  325.      Then the caller will be prompted for the type of protocol defined in
  326.       the BBS_DOOR.XFR file.
  327.  
  328.  
  329. [N]uke:
  330.  
  331.       Callers can DELETE a file entry provided their security is equal to or
  332.       higher than the value you set in the command line with the
  333.       /S=<sec level> parameter. (optional data field in the RA menu structure!)
  334.  
  335.  
  336. [H]elp!
  337.  
  338.         BBS_DOOR version 3.3 has built in HELP screens that must be located
  339.         in the directory pointed to by the SET BBS_DOOR=drive:\directory
  340.         environment variable.. (Am i harping on this point?) The help files
  341.         have the names of BBSHELP*.ANS/ASC/RIP.
  342.  
  343.  
  344. [M]ore
  345.  
  346.         Advance One Page (15 listings)
  347.  
  348.  
  349. [B]ack 1 page
  350.  
  351.         umm. Back one page.. (15 listings back!)
  352.  
  353.  
  354. [R]elist
  355.  
  356.         Displayed at the END of the listing, the List will restart from Entry
  357.         Number ONE!
  358.  
  359.  
  360. [Q]uit
  361.  
  362.         Quit the program and return to the BBS.
  363.  
  364.  
  365.                                  DISCLAIMER!!
  366.       This program is not guaranteed to do anything but take up space on your
  367.       hard drive. It has been tested fairly extensively and should not corrupt
  368.       any of your RA files, however.. Backup your files consistently and often,
  369.       a rule that applies to any computer user!!
  370.  
  371.    This program will display una UNREGISTERED EVALUATION VERSION at the top
  372.    of the caller screen if you are not registered! The program is not crippled
  373.    in any way, but if you use this program for more than 21 days, it would
  374.    be nice to show your appreciation and register this fine door for a paltry
  375.    $15 US! :) The program won't go boom or anything, but you may wind up with
  376.    a guilty conscience!
  377.  
  378. To encourage future versions of this program please register by sending $15
  379. to:
  380.  
  381.            Mark Sarnov                    and call : Fozzy's Place BBS
  382.            c/o Fozzy INC.                            (717)671-1271
  383.            P.O Box 6835                              Harrisburg, PA
  384.            Harrisburg, PA 17112-0835                 Fido # 1:270/116
  385.  
  386.         Include the SYSOP NAME and BBS SYSTEM NAME in the manner they are
  387.         entered in your RACONFIG System Information.
  388.  
  389.                                         Thanks!   Mark Sarnov
  390.  
  391.