home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / BFE1302A.ZIP / BFE.DOC < prev    next >
Text File  |  1993-06-21  |  71KB  |  1,523 lines
  1.                        
  2.                        ▒███████  ▒███████  ▒███████ 
  3.                        ▒██  ▒██  ▒██  ▒██  ▒██      
  4.                        ▒████████ ▒████████ ▒███████ 
  5.                        ▒██   ▒██ ▒██   ▒██      ▒██ 
  6.                        ▒████████ ▒████████ ▒███████ 
  7.                        
  8.   ▒███████ ▒███████ ▒███████ ▒████▒██ ▒████████ ▒███████ ▒████▒██ ▒██████
  9.   ▒██      ▒██  ▒██ ▒██  ▒██ ▒██▒█▒██    ▒██    ▒██      ▒██▒█▒██ ▒██  ▒██
  10.   ▒██████  ▒███████ ▒██  ▒██ ▒██▒█▒██    ▒██    ▒██████  ▒██▒█▒██ ▒██  ▒██
  11.   ▒██      ▒██ ▒██  ▒██  ▒██ ▒██▒█▒██    ▒██    ▒██      ▒██▒█▒██ ▒██  ▒██
  12.   ▒██      ▒██ ▒███ ▒███████ ▒██▒████    ▒██    ▒███████ ▒██▒████ ▒██████
  13.            
  14.            ▒███████ ▒██   ▒██ ▒███████ ▒████████ ▒███████ ▒███████
  15.            ▒██      ▒██   ▒██ ▒██         ▒██    ▒██      ▒██▒█▒██
  16.            ▒███████ ▒████████ ▒███████    ▒██    ▒██████  ▒██  ▒██
  17.                 ▒██    ▒██         ▒██    ▒██    ▒██      ▒██  ▒██
  18.            ▒███████    ▒██    ▒███████    ▒██    ▒███████ ▒██  ▒██
  19.                    
  20.                    ┌───────────────────────────────────────┐
  21.            ▓███│  v1.30.2α    Release Date 20 June 1993  │▓███
  22.                    └───────────────────────────────────────┘
  23.         (C)opyright 1992, 1993 Cairo Research Labs, All Rights Reserved
  24. ─────────────────────────────────────────────────────────────────────────────
  25. ■ INTRODUCTION ■
  26. ────────────────────────────────────────────────────────────────────────────
  27.  
  28. BFE is a BBS front-end system that was originally designed to provide sysops
  29. with a method of running more than one BBS from the same line.  In addition,
  30. it has a wealth of other options available to put in on the front-end of your
  31. BBS, such as allowing file transfers, ASCII/ANSI/AVATAR file viewing,
  32. shelling to DOS from remote, running external programs and batch files, and
  33. much more!
  34.  
  35. BFE was designed to be called from a front-end mailer, such as Frontdoor or
  36. Binkleyterm.  Instead of spawning directly to the BBS system, it presents
  37. a menu to the user, which details his immediate options.  These options can
  38. range from offering multiple BBS systems, remote jobs, literally anything
  39. you can think of!  The BFE system can also be configured to be called
  40. straight from your BBS software itself, in essence, running as a normal
  41. door, using one of several popular BBS dropfile formats.  Read onward....
  42.  
  43.  ┌───────────────────────────┐
  44. ▄│   Word From The Authors   │
  45. █└───────────────────────────┘
  46. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  47.  
  48. To date, BFE has enjoyed a tremendous success rate, due in part to the
  49. undying loyalty of an exhausted beta team, I might add!  Recently, however,
  50. a few shareware authors of similar products have apparently been spreading
  51. false information about the BFE system, making rather unsubstantial claims
  52. as to its functionality.  Personally, I feel this is rather uncouth and
  53. is certainly unnecessary, as BFE's power and flexbility speak for itself.
  54. BFE, by far, excels in the areas of flexibility, processing speed, and
  55. ease of use.
  56.  
  57. Some of you have really put BFE to the test, and I must say that I am glad
  58. to see that it passed with flying colors.  Here are just a few comments on
  59. BFE as reported by users and beta testers:
  60.  
  61.  - "During certain hours, my BFE.CTL file gets swapped out with another one,
  62.     providing various options based upon the time of the day!"
  63.  
  64.  - "Now we can provide online registration information ... up front!"
  65.  
  66.  - "A tremendous frontend support system for our shareware products!"
  67.  
  68.  - "...provides our users with pertinent file transfers and information,
  69.     without forcing them to log on to the BBS first.  In and out!"
  70.  
  71.  - "...splendid way of letting my users choose between RIP, NAPLPS, and
  72.     normal BBS operation, all before they log on!"
  73.  
  74. BFE was originally designed in-house, for use on our support BBS, Under the
  75. Nile, at 1:3613/12.  However, after getting begged by many of our users to
  76. offer a shareware version, I set out on the task.  My mission was to create
  77. a flexible, simple-to-use, inexpensive BBS front-end.  See for yourself!
  78.  
  79.                         ** NOTES and CAVEATS **
  80.  
  81. In the 1.10 release, we entitled the system, MBBS, or MultiBBS.  However,
  82. we later found out that this conflicted with several other packages which
  83. shared the same name.  As a result, it was renamed to BFE, the BBS Frontend
  84. System.  BFE has evolved into much more than the original MBBS, thus the
  85. original releases of MBBS will no longer be supported.
  86.  
  87. We hate crippleware! Down with crippleware authors!  Shame on them... BFE
  88. has never, is not, and never will be crippleware.  Hrmpf!
  89.  
  90. Starting with the 1.30x series of BFE releases, a new alpha/beta naming
  91. convention has been applied: MAJOR.MINOR.REV (Staging Level).
  92.  
  93. If you experience any problems with the BFE system, or have any questions,
  94. please contact us!  We can be reached in the DOORWARE, MUFFIN, and the 
  95. OPENDOORS echos, as well as via netmail to 1:3613/12.  We also moderate our
  96. own support echo, entitled SPHINX.  The SPHINX echo is not available on the
  97. fidonet backbone.  If you are unable to locate a feed near you, feel free
  98. to contact us for more information on connecting directly.
  99.  
  100.  ┌─────────────┐
  101. ▄│   Features  │
  102. █└─────────────┘
  103. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  104.  
  105. BFE features include:
  106.  
  107.         * Complete support for ANSI/ASCII/AVATAR users (Auto ANSI detect!)
  108.         * *TRUE* Multinode/Multiuser Compatibility!
  109.         * DESQview aware!
  110.         * Configurable for security concerns!
  111.         * Custom multi-level menus with item-level password protection!
  112.         * Complete carrier monitoring and timeout checking
  113.         * Use any of 11 standard dropfiles, or define custom ones!
  114.         * Run as a normal door or as a frontend!  Dropfile not required!
  115.         * Complete BBS carousel - run multiple BBS systems
  116.         * ASCII/ANSI/AVATAR file support
  117.         * File transfer system with support for external protocols
  118.         * Run remote jobs, such as batch files, programs, other doors, etc.
  119.         * Remote OS shells!
  120.         * Built in chat mode
  121.         * *Total* configurability!
  122.         * Much more!
  123.         
  124.  ┌────────────────────────────────┐
  125. ▄│   What's New in This Release?  │
  126. █└────────────────────────────────┘     o New  * Change  ! Fix
  127. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  128.         
  129.         o *Major* code cleanup and internal re-documenting and optimizing.
  130.           This will be done every periodically in order for the product to
  131.           continue to grow.
  132.         
  133.         o New beta naming convention:   MAJOR.MINOR.REV (Staging Level)
  134.           (i.e. this is 1.30.2α, v1.30, rev. 2, in alpha staging)
  135.  
  136.         o Custom user input using the new PROMPT keyword!  Now, you can 
  137.           utilize custom input as the value for SECONDARY data fields for 
  138.           *any* menu type in BFE!
  139.         
  140.         o New keywords: NOPASSPARMS and PROCESS.  These are used to directly
  141.           manipulate the way that BFE performs calls to external processes.
  142.           When used with the PROMPT keyword above, just about anything can 
  143.           be called, in any order, with any arguments!
  144.           
  145.         o The COLOVERRIDE option has been added, to allow each individual
  146.           menu option to use its own unique color.  This overrides the global
  147.           DESCRIPCOL keyword in each .CTL file.  (Thanks to Chris Koziol)
  148.  
  149.         o Upload capability now in place!  This involved changes to the
  150.           PROTOCOL.BFE file, and adding a new type "U" option.
  151.           
  152.     * If BFE cannot locate ASCII/ANSI/AVATAR screens at display time,
  153.           it will log an error entry into the logfile, and will no longer
  154.           wait for a remote keystroke to continue. (Thanks to R. Guevarra) 
  155.  
  156.  ┌────────────────────────────────┐
  157. ▄│   Licensing and Distribution   │
  158. █└────────────────────────────────┘
  159. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  160.  
  161.    This documentation, programs, and other files distributed in this software
  162.    package (the "Software") are the copyrighted property of Scott Burkett and
  163.    Cairo Research Labs.  All rights are reserved.
  164.  
  165.    For use by corporations, institutions or goverment agencies, or for-profit
  166.    purposes, contact the Author for licensing information.
  167.  
  168.    U.S. GOVERNMENT INFORMATION
  169.  
  170.    The use, duplication, or disclosure by the U.S. Government of the Software
  171.    is subject to the restricted rights applicable to commercial software that
  172.    are specified in the subdivision (b.3.ii) of the 'Rights in Technical Data
  173.    and Computer Software' clause, document DFARS 52.227-7013.
  174.  
  175.    DISTRIBUTION/USAGE
  176.  
  177.    BFE can be freely distributed, provided that the original archive
  178.    is not changed in any way (other than changing the archive type) and no
  179.    amount of money is required. In no circumstance at all can BFE be
  180.    modified without written consent from the authors.  It is prohibited too
  181.    to include this program, whole or in part, in other software.  It is
  182.    expressly forbidden to distribute a registered key to unregistered users.
  183.  
  184.    BFE can be used in commercial organizations only after regular
  185.    registration.
  186.  
  187.    This license is considered accepted if the program is used.  Its violation
  188.    will involve the withdrawal of the registration key and the rights to use
  189.    the program.
  190.  
  191.    WARRANTY DISCLAIMER
  192.  
  193.    The Author cannot and does not warrant that any functions contained in the
  194.    Software will meet your requirements, or that its operations will be error
  195.    free.  The entire risk as to the Software performance or quality, or both,
  196.    is solely with the user and not the Author.  You assume responsibility for
  197.    the selection of the program to achieve your intended results, and for the
  198.    installation, use, and results obtained from the Software.
  199.  
  200.    The Author makes no warranty, either implied or expressed, including with-
  201.    out limitation any warranty with respect to this Software documented here,
  202.    its quality, performance, or fitness for a particular purpose. In no event
  203.    shall the Author be liable to you for damages, whether direct or indirect,
  204.    incidental, special, or consequential arising out the use of or any defect
  205.    in the Software, even if the Author has been advised of the possibility of
  206.    such damages, or for any claim by any other party.
  207.  
  208.    All other warranties of any kind, either express or implied, including but
  209.    not limited to the implied warranties of merchantability and fitness for a
  210.    particular purpose, are expressly excluded.
  211.  
  212.    LIMITATION OF REMEDIES
  213.  
  214.    The information contained in the documentation for the Software is subject
  215.    to change without notice.
  216.  
  217.    The Author's entire liability, and your exclusive remedy shall be: (1) the
  218.    replacement of an original Software diskette not meeting the above Limited
  219.    Warranty and which is returned to the Author along with proof of purchase,
  220.    or (2), if the Author is unable to deliver a replacement diskette which is
  221.    free of defects, you may terminate the License Agreement by returning this
  222.    Software and the corresponding license fee will be returned.
  223.  
  224.    By using the Software, you acknowledge (1) to have read and understood all
  225.    parts of this document and (2) to have agreed with and accepted all of its
  226.    provisions without any reservation.
  227.  
  228.                                           Scott Burkett
  229.                                           Cairo Research Labs
  230.  ┌─────────────────────────────┐
  231. ▄│   The Demo Version of BFE   │
  232. █└─────────────────────────────┘
  233. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  234.  
  235. This shareware demonstration version of BFE is as fully functional as its
  236. registered counterpart, with a few minor differences.
  237.  
  238.   - The unregistered evaluation message at the top of the screen: Upon
  239.     registration, this will be replaced by your name or your organization's
  240.     name, showing your support for the BFE project.
  241.  
  242.   - Registered users have the option of changing both the text and the color
  243.     of the default registration message which appears at the top of each menu.
  244.  
  245.   - Registered users can make use of custom ASCII/ANSI/AVATAR screens in lieu
  246.     of the built-in default BFE menus.
  247.  
  248.  ┌──────────────────────────────┐
  249. ▄│   Benefits of Registration   │
  250. █└──────────────────────────────┘
  251. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  252.  
  253. Benefits of registering BFE:
  254.  
  255.         o Extended Tech Support via the SPHINX echo (our support echo).
  256.  
  257.         o Access to beta copies of BFE, as they become available.
  258.  
  259.         o You will also be entitled to free upgrades to newer versions of
  260.           BFE, as they become available. In addition to the great
  261.           many features and the quality that this version of BFE has
  262.           to offer, we are currently working on several additions and
  263.           enhancements for future versions.
  264.  
  265.  ┌─────────────────────┐
  266. ▄│    Ordering BFE     │
  267. █└─────────────────────┘
  268. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  269.  
  270. Below are detailed instructions for registering BFE. These
  271. instructions are not intended to seem confusing or complicated; they are
  272. simply meant to answer almost any question that you might have about
  273. registering.  If you have any questions or uncertainties about your
  274. registration, please feel free to contact us.  For information on how to
  275. contact us, please see the section on "Upgrades and Information".
  276.  
  277. To order BFE, simply follow these three steps:
  278.  
  279.   1.)  Fill out the registration form. Information on filling out
  280.        the form is located in the next section.
  281.  
  282.   2.)  Enclose the appropriate payment ($10), Ten American Dollars,
  283.        payable in the form of cash, check or money order.  Make all checks
  284.        or money orders payable to:  SCOTT BURKETT
  285.  
  286.   3.)  Send the above two items to:
  287.  
  288.                           Cairo Research Labs
  289.                           1113 29th Street
  290.                           Columbus, GA 31904
  291.  
  292.  
  293. FILLING OUT THE REGISTRATION FORM
  294. --------------------------------------------------------------------------------
  295.  
  296. NO PRINTER?    Alternatively, if you do not have a printer, simply send a
  297.                hand-drawn version of the order form.  If you do not wish to
  298.                mail a registration form in, you may opt to upload it to our
  299.                support BBS at (706) 596-8126 (14.4/v.32).  We will not present
  300.                you with a registration key, however, until proper payment
  301.                has been rendered.
  302.  
  303.                If you have any special instructions for us, or anything that
  304.                you would like to say when you register, feel free to write
  305.                this down on the back of the registration form, or on a
  306.                separate piece of paper.
  307.  
  308.                When filling out the BFE registration form, be sure to
  309.                indicate how you would prefer to receive your BFE
  310.                registration key. You will have the choice of receiving your
  311.                registration key by one of three means: A call to our BBS,
  312.                FidoNet CrashMail, or by a call to your BBS.  If you have a
  313.                FidoNet Email address, FidoNet CrashMail is still by far the
  314.                quickest way to receive your order. Once you have decided
  315.                which means you would prefer to receive your order by, please
  316.                read the detailed instructions on your order method below.
  317.  
  318. --------------------------------------------------------------------------------
  319. RECEIVING      In order to receive your BFE registration key by a
  320. BY CALL        message and/or upload to your BBS, fill out the order form and
  321. TO BBS         mail it along with your payment as described below. Be sure to
  322.                include the phone number, baud rate, and our login and
  323.                password for the BBS to which you would like us to call.  We
  324.                will cover any long distance costs. If, for some reason, we
  325.                are unable to connect to your BBS (not because it busy, but,
  326.                for example, if your BBS is no longer online), we will place
  327.                your key in a message on our support BBS.
  328.  
  329. --------------------------------------------------------------------------------
  330. RECEIVING      In order to receive your BFE registration key via
  331. ORDER BY       FidoNet CrashMail, simply fill out the order form and mail it
  332. FIDONET        along with your payment as described below.  Be sure to
  333. CRASHMAIL      include the FidoNet node address to which you wish to have
  334.                your order sent.
  335.  
  336.  
  337. ────────────────────────────────────────────────────────────────────────────
  338. ■ GETTING STARTED ■
  339. ────────────────────────────────────────────────────────────────────────────
  340.  
  341.   BFE is a snap to get up and running (as you will see).
  342.  
  343.  ┌────────────────────────┐
  344. ▄│   System Requirements  │
  345. █└────────────────────────┘
  346. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  347.  
  348. BFE was designed for use with IBM compatible personal computer systems,
  349. with 640K minimum RAM, however, it will run in much less.  It will run under
  350. most popular BBS packages, to include RemoteAccess, Maximus, SuperBBS,
  351. QuickBBS, GAP, PCBoard, WildCat!, WWIV, and others.  Facilities are also in
  352. place to provide complete dropfile customization, which provides maximum
  353. compatibility with nearly all BBS system software.
  354.  
  355. BFE also requires the use of a fossil driver, such as Ray Gwinn's X00, or
  356. David Nugent's BNU.  These programs can be found on most BBS systems, since
  357. they are necessary in running most BBS packages to begin with.  If your BBS
  358. does not utilize a fossil driver, you can always enable it for BFE, and then
  359. disable it after BFE exits.
  360.  
  361. If you would like to allow users to download certain files from BFE, free of
  362. BBS ratios, then you will also need copies of whatever external protocols you
  363. wish to run (i.e. DSZ, MPT, etc).
  364.  
  365.  ┌─────────────────┐
  366. ▄│   Installation  │
  367. █└─────────────────┘
  368. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  369.  
  370. First things first:
  371.  
  372. Create a directory to hold the BFE system.  We recommend using something
  373. like C:\BFE.  Next, copy the BFE122.EXE file into the directory
  374. and type "BFE122" at the DOS prompt.  The archive is self-extracting and will
  375. come apart without much effort.
  376.  
  377. ** Note:  Your source for obtaining the BFE archive may have changed
  378. the format of the archive to one suitable for use on their system (i.e. ZIP,
  379. LZH, ARJ, etc).
  380.  
  381. ────────────────────────────────────────────────────────────────────────────
  382. ■ OPERATION ■
  383. ────────────────────────────────────────────────────────────────────────────
  384.  
  385. Operating BFE is a cinch, as you will soon find out.  As mentioned earlier,
  386. it was designed to be called from a front-end mailer.  Most, if not all,
  387. mailers will pass the necessary arguments along to your batch file (i.e.
  388. port, baud, time to next event, etc).  You will be passing these parameters
  389. to BFE in turn, in order to establish the communication link.  See below for
  390. more info on the command line arguments for BFE.
  391.  
  392. BFE also has the ability to be run as a normal BBS door, obtaining the
  393. necessary communication parameters from one of several popular BBS dropfile
  394. formats.  More on this later.
  395.  
  396. This is the first decision you have to make!  Will you be running BFE as a
  397. communications front-end, or as a normal door, or both?  Read on...
  398.  
  399. In order to let BFE know what options to present to the user, a control
  400. file must be created.  It may whatever name you wish, but for documentation
  401. sake, we will use BFE.CTL.
  402.  
  403. ** NOTE:  as you read through the examples, you may think that configuring
  404.           BFE can be a bit tedious.  We admit that BFE can be a bit of a
  405.           nuisance while you are just learning it, but before you know it,
  406.           you will be as proficient as the next Joe.  We are planning on
  407.           creating a BFE menu designer, to help out in this task, though...
  408.  
  409. Each option in the control file is addressed via a "keyword".
  410.  
  411. ---------------------------------------------------------------------------
  412.                         Keyword: CHOICE
  413. ---------------------------------------------------------------------------
  414.  
  415. The CHOICE keyword is used to define each of your BFE menu options.  These
  416. are the options that will be presented to your callers.  Actually, the CHOICE
  417. keyword marks the beginning of an "option block".
  418.  
  419. The format of each option block is:
  420.      
  421. CHOICE
  422.            HOTKEY [Hotkey]
  423.              DESC [Textual Description]
  424.              TYPE [Option Type]
  425.            FLAVOR [Option Flavor]
  426.          SECURITY [Security to Access]
  427.         SECONDARY [Catch-all Secondary data field]
  428.            PROMPT [Used to obtain user-defined input]
  429.           PROCESS [Used in conjunction with PROMPT/NOPASSPARMS]
  430.       NOPASSPARMS [Prevent BFE from passing comm. parameters to tasks]
  431.         PORTSPEED [TRUE or LOCKED]
  432.         SHOWAFTER [After-selection ANSI/ASCII/AVATAR screen]
  433.          PASSWORD [Password Needed to Access]
  434. ENDCHOICE
  435.  
  436. We will discuss each of the above subitems in turn.  Note the use of the
  437. ENDCHOICE keyword to mark the end of the option definition.
  438.  
  439. The option block format is very loosely interpreted.  Spacing is not a
  440. concern, nor is the case off the keywords.  They may also be in any order
  441. within the block.
  442.  
  443. As you go through the following descriptions and examples, keep in mind that
  444. BFE performs very little error checking when parsing the CHOICE keywords.  As
  445. long as you keep everything in the format presented, you shouldn't run into
  446. too many problems.  This will/should be remedied in the future.
  447.  
  448. Let's take a look at each of the CHOICE parameters:
  449.  
  450. ---------------------------------------------------------------------------
  451. [HOTKEY]
  452.  
  453. The "hotkey" field represents the keypress needed to activate the option.
  454. You may use any character for this, however, if you chose an alpha character
  455. (A through Z), it will use the uppercase form of the character.  In other
  456. words, if you put a lowercase letter in as a hotkey, BFE will convert it
  457. to uppercase when initialized.
  458.  
  459.         Examples: HOTKEY 1
  460.                   CHOICE G
  461.  
  462. ---------------------------------------------------------------------------
  463. [DESC]
  464.  
  465. Simple enough.  The description field should contain the text that will
  466. be presented next to each option.  You are limited to 80 characters for
  467. each option description.
  468.  
  469.         Examples: DESC Under the Nile BBS!
  470.                   DESC Download Master File Listing
  471.  
  472. ---------------------------------------------------------------------------
  473. [Type]
  474.  
  475. The TYPE field is perhaps the most important of the CHOICE parameters, as it
  476. directly affects the remainder of the parameters.  The value in this field
  477. determines what BFE will do once the user presses the hotkey for the option.
  478. Some fields require additional information, such as the path and filename of
  479. a file to be downloaded.  This type of information is provided through the
  480. use of the SECONDARY FIELD.  The SECONDARY FIELD's purpose changes based
  481. upon the value of this TYPE field.
  482.  
  483. Currently, the valid types are (Examples afterwards):
  484.  
  485.                        E - Exit on an errorlevel
  486.  
  487. Specifying an "E" as the type will cause BFE to exit back to the calling
  488. batch file with an errorlevel.  This is perhaps one of the more powerful
  489. types, as it provides vitually unlimited possibilities.  Simply place the
  490. errorlevel you wish to exit with in the SECONDARY FIELD.  As an example, you
  491. could call one BBS with an errorlevel of 100, and another one with an error-
  492. level of 101, etc.  Basically, as long as you trap the errorlevel in your
  493. calling batch file, you could do practically anything!
  494.  
  495.                        R - Run external process
  496.  
  497. Specifying an "R" as the type will cause BFE to execute (run) an external
  498. process.  This is also an incredibly powerful option, in very much the same
  499. way as the "E" type.  The benefit of using "R" over "E" is simple:  You
  500. don't have to fiddle with the calling batch file and trapping the errorlevels.
  501. In addition, BFE will pass several values on the command line, in the follow-
  502. ing order:
  503.  
  504.         %1 - Port number (1-4)
  505.         %2 - Baud rate (dependant upon PORTSPEED setting)
  506.         %3 - Time to next event
  507.  
  508. This feature is unavailable in an "E" type.  BFE will attempt to swap itself
  509. out to memory or disk first, to ensure that you have as much memory as
  510. possible to call your task.  If you wish to run a program that requires
  511. command line parameters or switches, you will need to place the call to the
  512. program in a batch file, and have BFE call the batch file.  Simply place the
  513. name of the external process in the SECONDARY FIELD.  You may specify the
  514. full path, or just the filename if it resides in your path or the BFE
  515. directory.
  516.  
  517. ** NOTES:  I cannot stop expressing the sheer power of this type!  You can
  518. use this to call bulletin doors, message entry doors, Doorway, etc.  BFE works
  519. especially well with RegPRO, our full screen online entry form system! :-)
  520. It is possible to call a program such as Marshall Dudley's Doorway(tm).  In
  521. fact, this has been tested and confirmed by several BFE beta sites.  Since
  522. BFE passes the port and baud rate to any external processes, it is a cinch.
  523.  
  524.                        O - Operating System Shell
  525.  
  526. For those of you wish to drop to DOS from remote, this is the one!  Simply
  527. place an O as the type.  BFE will make use of the COMSPEC enviroment variable
  528. to locate your command processor (COMMAND.COM, 4DOS.COM, etc).  To return
  529. to BFE, simply type exit at your command prompt.
  530.  
  531. One note is in order here. You may run any program you desire from remote,
  532. once you are in the OS shell.  However, keep in mind that unless the program
  533. supports DOS routing, then you will not see any output on your screen.  Most
  534. command line utilities will work just fine, as well as the internal DOS
  535. commands, however, things like Windows, PC-Tools, etc will not function
  536. properly, and will more than likely lock your system.  If you enable your
  537. fossil watchdog, you should be fine in the event you get hung up.  Check your
  538. fossil documentation for more information on the watchdog services.
  539.  
  540. With the inherent power that arrives by shelling to your OS from remote, you
  541. should always password protect this option!  Then again, I guess it *is* your
  542. system... :-)
  543.  
  544.                        G - Goodbye
  545.  
  546. This type is fairly straightforward!  It hangs up on the user, and returns
  547. an errorlevel of 255 to the calling batch file.  
  548.  
  549.                        C - Chat Page!
  550.  
  551. This type is fairly straightforward as well. It will prompt the user for a
  552. reason to chat, and proceed to page the sysop.  To break in, simply press
  553. ALT-C.  To exit chat mode, simply press ESC.  Note that you may also press
  554. ALT-C at any time to initiate a chat session while the user is in BFE.
  555.  
  556.                        D - Display ASCII/ANSI/AVATAR screen
  557.  
  558. This nifty type will allow you to display an ANSI, ASCII, or AVATAR file to
  559. the user.  To use this option, simply place the filename of the file to be
  560. displayed in the SECONDARY FIELD.  If you do not specify an extension, then
  561. BFE will look for the filename which corresponds to the user's graphic
  562. settings.  When BFE first comes up, it performs an Automatic ANSI detection
  563. loop.  It makes an attempt to determine whether or not the user is calling
  564. from an ANSI-ready terminal.  If so, then BFE will display FILENAME.ANS or
  565. filename.AVT (ANSI or AVATAR, depending on his settings).  If not then
  566. FILENAME.ASC will be used.  You may also specify the extension, if you only
  567. want one file to be used, such as RELEASES.TXT.  You may specify a full path,
  568. or just the filename if the file is in the BFE directory.
  569.  
  570. BFE will automatically engage "more prompting" when displaying screens that
  571. are over 1 screen in length.
  572.  
  573. ** NOTE: BFE "interprets" the file as it is being displayed to the COM port.
  574. It is capable of interpretting embedded system codes used by RemoteAccess.
  575. For more information on these codes, please refer to your RA documentation.
  576.  
  577.                        J - Jump to another menu!
  578.  
  579. Through the use of the "J" type, you can have BFE call a completely different
  580. .CTL file!  This is handy when you need to group several options together:
  581. For example:
  582.  
  583.                         Top Menu (BFE.CTL)
  584.                         -       -
  585.                         -       -
  586.  Sysop Menu (SYS.CTL)<---       ----> Product Info (PROD.CTL)
  587.  
  588. Menus can now be nested up to 10 levels!  If you try to go beyond this, BFE
  589. will simply post a warning message and re-display the current active menu.
  590.  
  591.                        X - Return to previous .CTL file
  592.  
  593. Use this option to provide a method of returning from a subordinate .CTL
  594. file menu back to the .CTL file menu that called it.
  595.  
  596.                        T - Return to main .CTL file
  597.  
  598. Use this option to provide a method of returning from a subordinate .CTL
  599. file menu back to the main .CTL file.  If you are in nested menus, then this
  600. option will take you all the way back to the first one.  Think of this type
  601. as being the one that takes you back to the "T"op menu.
  602.  
  603.                        F - Download one file
  604.  
  605. This type will allow the user to download a file (ratio free) from BFE,
  606. without having to log onto your BBS first.  This is particularly handy, esp.
  607. if you are a shareware author, as you can offer the latest version of your
  608. packages up front.  Trust me when I say that your long distance users will
  609. love you for this!  Simply place the filename to be downloaded in the
  610. SECONDARY FIELD.  You may specify a full path, or just the filename if the
  611. file is in the BFE directory.
  612.  
  613. When the user selects this option, BFE will present a list of available
  614. protocols (configured in a file called PROTOCOL.BFE, more on this later).
  615.  
  616.                        M - Menu of downloadable files
  617.  
  618. This type is very similar to the "F" type, with one exception.  Instead of
  619. downloading a specific file, the user will be presented with a list of the
  620. available files, from which he/she may choose the file to be downloaded.
  621. In order to use this type, a "files list" must be created, and the filename
  622. of the list (or full path to the list) must be placed in the SECONDARY FIELD.
  623.  
  624. This list should be in the following format:
  625. ---------------------------[ CUT HERE! ]-----------------------------------
  626.  
  627.                 Cairo Research Labs Free File List
  628.  
  629. D:\CAIRO\AVLAB100.ZIP  AVLAb v1.0 - Antiviral Researcher's Toolkit!
  630. D:\CAIRO\RCS10A.LZH    Robot Construction Set v1.0a - For Fidonet Areas
  631. D:\CAIRO\RP_260.LZH    RegPRO v2.60 - World's Premier Questionnaire Door!
  632. D:\CAIRO\TBM_250.LZH   Turbo Bulletin Manager Door v2.50
  633. D:\CAIRO\TBWIN111.LZH  TBWin v1.11 - Windows Interface for TBAV utils
  634. D:\CAIRO\TFA100B.LZH   Turbo File Announcer 1.0ß - Max File Announcer System
  635. D:\CAIRO\VK_300A.LZH   VKill v3.00A - Upload Integrity Tester for Maximus CBCS
  636. D:\CAIRO\VID110.ZIP    VID v1.10 - Virus Information Door - For most BBS's
  637. D:\CAIRO\VDB0393.LZH   Updated VID Virus Database - as of March 1993
  638. D:\CAIRO\WINVID10.LZH  WinVID v1.0 - Windows Virus Database!
  639. D:\BETA\RP_300B.LZH    Beta version of the upcoming RegPRO 3.0 release!
  640.  
  641. ---------------------------[ CUT HERE! ]-----------------------------------
  642.  
  643. As you can see, this is a modified version of the standard FILES.BBS, with
  644. the only difference being that the full path to each file needs to be present.
  645. This provides a nifty way of pulling files from all over your system to a
  646. single file download menu.  In this way, you need not use any of the FILES.BBS
  647. files that your BBS uses, you can create a custom one and place it in another
  648. directory, such as the BFE directory.
  649.  
  650. Any line which does not start in column 1 is considered a comment, and will
  651. be displayed in a different color.  Note that all of the colors used in the
  652. FILES.BBS display are configurable as of v1.22!  More on this in the section
  653. covering the "global configuration file".
  654.  
  655. All that is needed in the secondary field is the PATH to the FILES.BBS, not
  656. the entire path/filename.  The name FILES.BBS is assumed.
  657.  
  658. Once again, the user will be presented with a list of available protocols
  659. which are defined in a file called PROTOCOL.BFE (more later).
  660.  
  661. Examples: TYPE G
  662.           TYPE M
  663.           .
  664.           etc
  665.              
  666. ---------------------------------------------------------------------------
  667. FLAVOR
  668. ---------------------------------------------------------------------------
  669.  
  670. The FLAVOR keyword is used to control whether or not BFE displays the
  671. option on the screen AT ALL.  By default, all menu options are displayed.
  672. However, if the FLAVOR is set to HIDDEN, then the option will not be shown,
  673. but will still be available as a valid option.
  674.  
  675. Examples: FLAVOR HIDDEN
  676.           FLAVOR NORMAL
  677.           
  678. ---------------------------------------------------------------------------
  679. SECURITY
  680. ---------------------------------------------------------------------------
  681.  
  682. The SECURITY keyword is used in conjunction with a BBS dropfile to further
  683. restrict certain options from your users.  If you are running BFE without
  684. the DROPFILE keyword, this keyword will not function, since BFE will have no
  685. way of knowing what the security level of the user is.  Simply place the
  686. numeric value of the user after the keyword.  Any option that a user does not
  687. have the appropriate security for, will simply not be displayed to him.
  688. Unlike HIDDEN selections, any options which are not valid due to a low
  689. security level can *never* be selected.
  690.  
  691. Examples: SECURITY 50
  692.           SECURITY 32000
  693.  
  694. ---------------------------------------------------------------------------
  695. SECONDARY/PROMPT/PROCESS/NOPASSPARMS
  696. ---------------------------------------------------------------------------
  697.  
  698. As mentioned earlier, the SECONDARY field is used as a catch-all data field.
  699. The value of this field (or even if it is used at all) is determined by the
  700. option TYPE (see above).  It may contain anything from an errorlevel value,
  701. a filename, etc.
  702.  
  703. Examples: SECONDARY C:\FILES\MASTER.ZIP
  704.           SECONDARY 75
  705.  
  706. The PROMPT option has been added to provide a method of obtaining data from 
  707. the user, and passing this along to the menu type as the SECONDARY field.
  708.  
  709. For instance, let's say you wanted to set up a menu option to allow you to
  710. enter batch/DOS commands from remote (without performing a remote shell).  
  711.  
  712.         CHOICE 
  713.                 .
  714.                 TYPE R
  715.                 SECURITY 100
  716.                 PROMPT Enter your commands:
  717.                 .
  718.         ENDCHOICE
  719.         
  720. That's it!  When the user selects this menu option, he will be prompted
  721. to "Enter your commands:".  Whatever is typed in by the user (1 line only)
  722. will be passed to the operating system for execution.  BFE will pass the
  723. default communication parameters (port, speed, time-to-next-event) to the
  724. task as command line arguments.
  725.  
  726. The PROCESS keyword was added for once specific reason.  To allow you to pass
  727. data which was gathered by the PROMPT keyword, to an external process.
  728. Another example.  Let's say you wanted to have the user enter parameters for
  729. an external process called TEST.BAT.
  730.  
  731.         CHOICE 
  732.                 .
  733.                 TYPE R
  734.                 NOPASSPARMS
  735.                 PROMPT Enter the parameters:
  736.                 PROCESS TEST.BAT
  737.                 .
  738.         ENDCHOICE
  739.         
  740. When the user selects this menu option, he will be prompted to "Enter the
  741. parameters:".  Whatever is typed in by the user (once again, 1 line only)
  742. is passed to TEST.BAT for execution.
  743.  
  744. The NOPASSPARMS keyword which was used in the above example, is in place to
  745. prevent BFE from passing the default communication parameters to the process.
  746. In our example above, we want to pass data which was entered by the user!
  747.  
  748. ---------------------------------------------------------------------------
  749. PORTSPEED
  750. ---------------------------------------------------------------------------
  751.  
  752. The PORTSPEED option was provided to allow Sysops who lock their serial
  753. ports to pass either the TRUE port speed (i.e. 9600), or the LOCKED speed
  754. (i.e 38400).  This comes in handy when combined with download types or when
  755. calling another BBS door from a BFE menu option.
  756.  
  757. Examples: PORTSPEED True
  758.           PORTSPEED Locked
  759.  
  760. * NOTE:  Be sure to check the additional serial port locking options that
  761.          appear in the global configuration file!  These must be set as well!
  762.  
  763. ---------------------------------------------------------------------------
  764. SHOWAFTER
  765. ---------------------------------------------------------------------------
  766.  
  767. The SHOWAFTER option provides yet another hook to display ASCII/ANSI/AVATAR
  768. screens.  This method, however, displays the screen *after* the user makes
  769. the selection, and after any password/security checking.  Once the screen
  770. has been displayed, BFE will automatically wait for the user to hit any
  771. key to continue.  BFE will also clear the display before displaying the
  772. screen.
  773.  
  774. The same screen display rules that apply to the "D" type apply here as well.
  775.  
  776. Examples:  SHOWAFTER Welcome
  777.            SHOWAFTER Update.txt
  778.  
  779. ---------------------------------------------------------------------------
  780. COLOVERRIDE
  781. ---------------------------------------------------------------------------
  782.  
  783. The COLOVERRIDE option is used in conjunction with the default internal BFE
  784. menu system.  It provides a method of assigning each menu option descripion
  785. with a different color scheme.  If this keyword is ommited from your CHOICE
  786. blocks, then the global DESCRIPCOL color will be used.  
  787.  
  788. Note that if you are using custom USERMENU menus, this option will have no
  789. effect!
  790.  
  791. Examples: COLOVERRIDE Bright White on Black
  792.           COLOVERRIDE Bright Flashing White on Black
  793.           COLOVERRIDE Bright Yellow on Blue 
  794.  
  795. ---------------------------------------------------------------------------
  796. PASSWORD
  797. ---------------------------------------------------------------------------
  798.  
  799. PASSWORDS!  Yes, you can password *ANY* option on an BFE menu by simply
  800. placing a value in the PASSWORD field of the choice in question.  This
  801. password must be under 25 characters long, and is case INSENSITIVE.  The user
  802. gets three attempts at the password, and if unsuccessful, BFE will proceed
  803. to drop carrier, and exit with an errorlevel of 99.
  804.  
  805. Examples: PASSWORD Dumbmove
  806.           PASSWORD GUEST
  807.  
  808. ---------------------------------------------------------------------------
  809. ENDCHOICE
  810. ---------------------------------------------------------------------------
  811.  
  812. This keyword merely marks the end of an option block definition.
  813.  
  814. ---------------------------------------------------------------------------
  815.                           Keyword: USERMENU
  816. ---------------------------------------------------------------------------
  817.  
  818. By default, BFE creates the user menus based upon the options that you have
  819. configured in all of your CHOICE keyword blocks.  If you specify the USERMENU
  820. keyword, followed by a filename, then the contents of the filename will be
  821. used as the menu screen.  The same rules which apply to the "D" type (above)
  822. apply to the USERMENU keyword.  (i.e. ANSI/ASCII/AVATAR, etc).  This option
  823. is available to registered users only.
  824.  
  825. Examples: USERMENU Mainscr
  826.           USERMENU Moreinfo
  827.  
  828. ---------------------------------------------------------------------------
  829.                         TITLECOL     \
  830.                         LINECOL       \
  831.                         BRACKETCOL     \
  832.                         HOTKEYCOL       \ Custom color keywords
  833.                         DESCRIPCOL      /
  834.                         PROMPTCOL      /
  835.                         USERCOL       /
  836. ---------------------------------------------------------------------------
  837.  
  838. Each of your BFE .CTL files may use a custom set of colors! By setting the
  839. following keywords in each .CTL file, you can create custom colors:
  840.  
  841. TITLECOL   - Color of the BFE Title Line
  842. LINECOL    - Color of the divider lines
  843. BRACKETCOL - Color of the brackets on either side of the hotkeys
  844. HOTKEYCOL  - Color of the hotkeys for this screen
  845. DESCRIPCOL - Color of the description text for each choice
  846. PROMPTCOL  - Color of the BFE system prompts
  847. USERCOL    - Color of all user-inputted text
  848. REGCOL     - Color of the Registration Message (*Registered users only)
  849.  
  850. Use the following formula for color selection:
  851.  
  852.         {Flashing} {Bright} [foreground] on [background]
  853.  
  854. Where "Flashing" is an optional keyword indicating that the text should be
  855. flashing. "Bright" is an optional keyword indicating that the foreground
  856. color should be bright. Foreground is the name of a foreground color, and
  857. background is the name of a background color. Case (upper or lower) is not
  858. significant.
  859.  
  860. Where foreground and background colors are one of:
  861.  
  862.          Black
  863.          Blue
  864.          Green
  865.          Cyan
  866.          Red
  867.          Magenta
  868.          Yellow / Brown
  869.          White / Grey
  870.  
  871. If no colors are specified, BFE will use the default internal color set.
  872.  
  873. Examples: TITLECOL Bright Yellow on Black
  874.           HOTKEYCOL Flashing Bright White on Blue
  875.  
  876. By using different background colors and flashing attributes, incredible
  877. results can be achieved.
  878.  
  879. ** NOTE:  This particular method of color scheming was borrowed from the
  880.           global configuration file, in order to make things more consistent
  881.           across the board.
  882.  
  883. ---------------------------------------------------------------------------
  884. REGMESSAGE
  885. ---------------------------------------------------------------------------
  886.  
  887. Finally, the REGMESSAGE keyword can be used by registered users to change
  888. the default registration message!  If unregistered, BFE will display the
  889. "* Unregistered Evaluation Copy *" message.  If registered, the default is
  890. "Registered to: <Your Name>".  By changing this message, you can essentially
  891. provide the equivalent of menu titles for each of your menus.  Each menu
  892. (.CTL file) can have a different message!
  893.  
  894. (Examples: REGMESSAGE Welcome to the Sysop Menu!
  895.                             or
  896.            REGMESSAGE Cairo Research Labs Product Info Menu!
  897.  
  898. ---------------------------------------------------------------------------
  899.  ┌────────────────────────────┐
  900. ▄│ Global Configuration File  │
  901. █└────────────────────────────┘
  902. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  903.  
  904. BFE also makes use of a "global configuration file".  Much of BFE's internal
  905. customization can be controlled through the modification of this file.  The
  906. name of this file should be passed on the command line to BFE (more on the
  907. command line later!).  If the name of the global configuration file is not
  908. passed on the BFE command line, it will not be utilized.
  909.  
  910. The following is a detailed listing of each of the options available:
  911.  
  912. ;-----------------------------------------------------------------------------
  913. ;               BFE.GBL - Sample BFE Global Configuration File
  914. ;       (C)opyright 1992, 1993 Cairo Research Labs, All Rights Reserved
  915. ;-----------------------------------------------------------------------------
  916. ; Any text following a semi-colon (;), and blank lines, are ignored.
  917. ;-----------------------------------------------------------------------------
  918. ;
  919. ;  The WelcomeScreen keyword is used to display a file (ASCII/ANSI/AVATAR)
  920. ;  upon entry to the BFE system.
  921. ;
  922. ;  i.e. WelcomeScreen WELCOME           <--(Tries .AVT, .ANS, then .ASC)
  923. ;       WelcomeScreen WELCOME.ASC
  924. ;
  925. WelcomeScreen WELCOME
  926. ;
  927. ;-----------------------------------------------------------------------------
  928. ;
  929. ;  The Dropfile option is used to determine which "mode" BFE will run in, a
  930. ;  normal door, or as a BBS front end system.  See the section on Dropfiles
  931. ;  in the BFE.DOC file for more information.
  932. ;
  933. Dropfile  Yes
  934. ;
  935. ;-----------------------------------------------------------------------------
  936. ;
  937. ;  BBS system directory. Indicates where the door information file (dropfile)
  938. ;  can be found. Remove the semi-colon (;) to activate this option. Note that
  939. ;  this option is not necessary if you are using BFE as a BBS front end
  940. ;  instead of a door!  If the dropfile is in the current dir, this is also
  941. ;  not necessary.
  942. ;
  943. BBSDir    C:\FD\BFE
  944. ;
  945. ;------------------------------------------------------------------------------
  946. ;
  947. ;  The BFE working directory.  This is where the BFE system files are
  948. ;  located. Remove the semi-colon (;) to activate this option.
  949. ;
  950. DoorDir    C:\FD\BFE
  951. ;
  952. ;------------------------------------------------------------------------------
  953. ;
  954. ;  Log File options. "LogFileName" specifies filename (path optional) where
  955. ;  BFE should record log information. To disable the log file altogether,
  956. ;  remove the semi-colon (;) from the "DisableLogging" line.  The default
  957. ;  logname if both options are commented out is BFE.LOG in the current dir.
  958. ;
  959. LogFileName  BFE.LOG
  960. ;DisableLogging
  961. ;
  962. ;------------------------------------------------------------------------------
  963. ;
  964. ;  BBS node number that door is running on. Only used if VID is unable to
  965. ;  determine the node number by some other means (i.e. dropfile)
  966. ;
  967. Node    1
  968. ;
  969. ;------------------------------------------------------------------------------
  970. ;
  971. ;  Door Personality.  Currently BFE supports 3 types of "personalities" or
  972. ;  flavors:  Remoteaccess 2.0x, WildCat!, and the default).  The active
  973. ;  personality determines the style of status line BFE will utilize, and
  974. ;  the various hotkeys which are active during door operation.
  975. ;
  976. ;Personality Wildcat
  977. ;Personality Remoteaccess
  978. ;Personality Default
  979. ;
  980. ;------------------------------------------------------------------------------
  981. ;
  982. ;  Sysop paging hours. Sysop paging will be permitted beginning at the start
  983. ;  time, up until, but not including, the end time. Times should be in 24-hour
  984. ;  format. To disable paging on a particular day, set the paging start and end
  985. ;  times to the same time.  Uncomment them all for 24 hour paging service.
  986. ;
  987. ;                      Start Time    End Time
  988. SundayPagingHours         9:00        22:00
  989. MondayPagingHours         8:30        22:00
  990. TuesdayPagingHours        8:30        22:00
  991. WednesdayPagingHours      8:30        22:00
  992. ThursdayPagingHours       8:30        22:00
  993. FridayPagingHours         8:30        22:00
  994. SaturdayPagingHours       9:00        22:00
  995. ;
  996. ;------------------------------------------------------------------------------
  997. ;
  998. ;  Duration of sysop page. Value indicates the number of beeps that compose
  999. ;  the sysop page alarm.
  1000. ;
  1001. PageDuration    10
  1002. ;
  1003. ;------------------------------------------------------------------------------
  1004. ;
  1005. ;  The Timelimit option is used to determine how much time each user will have
  1006. ;  in the BFE system.  Note that this option is only active if you are *NOT*
  1007. ;  using a dropfile!  In that case, the user's realistic remaining time value
  1008. ;  will be utilized.
  1009. ;
  1010. TimeLimit 60
  1011. ;
  1012. ;-----------------------------------------------------------------------------
  1013. ;
  1014. ; If you want the user's time to "freeze" while either running an external
  1015. ; process, remote shell, or file transfer, then take a second to uncomment
  1016. ; this keyword.  If this keyword is not specified, BFE will recalculate the
  1017. ; user's time upon returning from the file transfer, shell, etc.
  1018. ;
  1019. Freezetime
  1020. ;
  1021. ;------------------------------------------------------------------------------
  1022. ;
  1023. ;  Inactivity timeout. Specifies the maximum number of seconds that may elapse
  1024. ;  without the user pressing any key, before the user will be automatically
  1025. ;  disconnected. A value of 0 disables inactivity timeouts.
  1026. ;
  1027. InactivityTimeout    200
  1028. ;
  1029. ;------------------------------------------------------------------------------
  1030. ;
  1031. ;  Name of the sysop. BFE can usually determine the sysop's name from the
  1032. ;  information passed to the door by the BBS (i.e. in the dropfile). However,
  1033. ;  some BBS software does not supply this information to doors. In such cases,
  1034. ;  simply place your name here.
  1035. ;
  1036. ;SysopName    The Sysop
  1037. ;
  1038. ;------------------------------------------------------------------------------
  1039. ;
  1040. ;  Name of the BBS. BFE can usually determine the name of the BBS from the
  1041. ;  information passed to the door by the BBS. However, some BBS software
  1042. ;  does not supply this information to door programs. In such cases, simply
  1043. ;  place the name of the BBS here.  Note that this is normally not needed,
  1044. ;  and may be commented out.
  1045. ;
  1046. ;SystemName    Unnamed BBS
  1047. ;
  1048. ;------------------------------------------------------------------------------
  1049. ;
  1050. ;  Door colour options. These options specify the various text colours that
  1051. ;  will be used by the door if ANSI or AVATAR graphics modes are available.
  1052. ;  Colours are specified in the format:
  1053. ;
  1054. ;         {Bright} {Flashing} [Foreground Colour] on [Background Colour]
  1055. ;
  1056. ;  Where foreground and background colours are one of:
  1057. ;
  1058. ;         Black
  1059. ;         Blue
  1060. ;         Green
  1061. ;         Cyan
  1062. ;         Red
  1063. ;         Magenta
  1064. ;         Yellow / Brown
  1065. ;         White / Grey
  1066. ;
  1067. ChatUserColour               Bright white on black
  1068. ChatSysopColour              Bright red on black
  1069. FileListTitleColour          Bright yellow on black
  1070. FileListNameColour           Bright yellow on black
  1071. FileListSizeColour           Bright magenta on black
  1072. FileListDescriptionColour    Cyan on black
  1073. FileListOfflineColour        Bright red on black
  1074. ;
  1075. ;------------------------------------------------------------------------------
  1076. ;
  1077. ;  Memory swapping options. These options are generally not needed, but can be
  1078. ;  used to customize BFE's swapping behaviour. "SwappingDir" can be used
  1079. ;  to specify which directory or directories should be used for swapping.
  1080. ;  Multiple directory paths can be separated using a semi-colon.
  1081. ;  "SwappingNoEMS" can be used to prevent any swapping from being done to EMS
  1082. ;  memory, and "SwappingDisable" can be used to disable memory swapping
  1083. ;  altogether. Remove the semi-colon (;) to activate any of these options.
  1084. ;
  1085. ;SwappingDir    C:\
  1086. ;SwappingNoEMS
  1087. ;SwappingDisable
  1088. ;
  1089. ;------------------------------------------------------------------------------
  1090. ;
  1091. ;  Modem options. These options are generally not needed, as they can usually
  1092. ;  be determined from the BBS door information file. "LockedBPS" specifies the
  1093. ;  the BPS rate at which the door should communicate with the modem. Valid
  1094. ;  rates are 300, 600, 1200, 2400, 4800, 9600, 19200 and 38400. A BPS rate of 0
  1095. ;  forces the door to always operate in local mode. "FossilPort" specifies the
  1096. ;  FOSSIL driver port number that the modem is connected to. Usually, FOSSIL
  1097. ;  port 0 corresponds to COM1, FOSSIL port 1 to COM2, and so on. Remove the
  1098. ;  semi-colon (;) to activate either of these options.
  1099. ;
  1100. ;LockedBPS    38400
  1101. ;FossilPort    0
  1102. ;
  1103. ;------------------------------------------------------------------------------
  1104. ;
  1105. ;  Custom door information file support. BFE automatically recognizes
  1106. ;  most door information file (drop file) formats, including DORINFO?.DEF,
  1107. ;  EXITINFO.BBS, DOOR.SYS, SFDOORS.DAT, CALLINFO.BBS and CHAIN.TXT. However,
  1108. ;  to permit BFE to operate on BBS systems that produce a different format
  1109. ;  file, you may define a custom door information file format. A custom door
  1110. ;  information file format is defined using the "CustomFileName" command,
  1111. ;  followed by one or more lines beginning with the "CustomFileLine" command.
  1112. ;
  1113. ;  The "CustomFileName" option specifies the filename used to distinguish this
  1114. ;  file format from other file formats. This filename should not include a
  1115. ;  path. To specify the path where the door information file is located, use
  1116. ;  the BBSDir setting, near the beginning of this file. If the filename of the
  1117. ;  custom format is the same as that of one of the built-in formats, the custom
  1118. ;  format will override the built-in format.
  1119. ;
  1120. ;  The actual format of the custom file is specified using a number of lines
  1121. ;  that begin with the keyword "CustomFileLine". Each of these lines will
  1122. ;  correspond to a single line in the door information file, with the option
  1123. ;  following the "CustomFileLine" keyword specifying the information that can
  1124. ;  be found on that line. This can be one of the following keywords:
  1125. ;
  1126. ;                    Ignore - Causes the next line in the door information
  1127. ;                             file to be ignored. Use on lines for which none
  1128. ;                             of the options below apply.
  1129. ;                   ComPort - COM? port the modem is connected to
  1130. ;                             (0 indicates local mode)
  1131. ;                FossilPort - Fossil port number the modem is connected to
  1132. ;                  ModemBPS - BPS rate at which to communicate with modem
  1133. ;                             (0 or non-numerical value indicates local mode)
  1134. ;                 LocalMode - 1, T or Y if door is operating in local mode
  1135. ;                  UserName - Full name of the user
  1136. ;             UserFirstName - First name(s) of the user
  1137. ;              UserLastName - Last name of the user
  1138. ;                     Alias - The user's psuedonym / handle
  1139. ;                 HoursLeft - Hours user has left online
  1140. ;               MinutesLeft - Minutes user has left online, or time left online
  1141. ;                             in format hh:mm
  1142. ;               SecondsLeft - Seconds user has left online, or time left online
  1143. ;                             in format hh:mm:ss or format mm:ss
  1144. ;                             (If more than one of the above time options are
  1145. ;                             used, the user time left is taken to be the total
  1146. ;                             of all of these values.)
  1147. ;                      ANSI - 1, T, Y or G for ANSI graphics mode
  1148. ;                    AVATAR - 1, T or Y for AVATAR graphics mode
  1149. ;               PagePausing - 1, T or Y if user wishes a pause at end of screen
  1150. ;              ScreenLength - Number of lines on user's screen
  1151. ;            ScreenClearing - 1, T or Y if screen clearing mode is on
  1152. ;                  Security - The user's security level / access level
  1153. ;                      City - City the user is calling from
  1154. ;                      Node - Node number user is connected to
  1155. ;                 SysopName - Full name of the sysop
  1156. ;            SysopFirstName - The sysop's first name(s)
  1157. ;             SysopLastName - The sysop's last name
  1158. ;                SystemName - Name of the BBS
  1159. ;
  1160. ;
  1161. CustomFileName    EXAMPLE.DEF           ; Same format as DORINFO?.DEF
  1162. CustomFileLine    SystemName
  1163. CustomFileLine    SysopFirstName
  1164. CustomFileLine    SysopLastName
  1165. CustomFileLine    ComPort
  1166. CustomFileLine    ModemBPS
  1167. CustomFileLine    Ignore
  1168. CustomFileLine    UserFirstName
  1169. CustomFileLine    UserLastName
  1170. CustomFileLine    City
  1171. CustomFileLine    ANSI
  1172. CustomFileLine    Security
  1173. CustomFileLine    MinutesLeft
  1174.  
  1175. ;-----------------------[ End of Sample .BFE.GBL File ]------------------------
  1176.  
  1177.                       ** Notes on the BFE logfile: **
  1178.  
  1179. BFE has the ability to maintain a rather detailed logfile of all activity
  1180. in the door.  Unfortunately, since the user has not signed on the BBS at this
  1181. point, we have no idea what his/her identity is.  However, special attention
  1182. has been paid to ensure that any other pertinent information is included in
  1183. the logfile. The logfile format is similar to the log file format used by
  1184. Joho's FrontDoor(tm) Netmailer System.
  1185.  
  1186.                         ** Notes on BBS Dropfiles **
  1187.  
  1188. If BFE locates an enabled Dropfile keyword in your global config file, it
  1189. will attempt to make use of a BBS dropfile, effectively ignoring any relevant
  1190. command line communication arguments.  If you wish to run BFE as a normal door
  1191. from your BBS, you will need to specify a "Yes" value for this keyword.  If
  1192. you are running BFE as a front-end to your system (i.e. called from a mailer),
  1193. "No" will need to be provided.
  1194.  
  1195. It appears that the BBS world simply cannot agree on a standard dropfile
  1196. format.  For a while, it appeared as if the DORINFOx.DEF, or perhaps the
  1197. DOOR.SYS format would prevail.  However, with the release of RemoteAccess
  1198. v2.0+, that myth has apparently been shattered, as the RA author decided to
  1199. introduce yet another dropfile format.  We will continue to add and support
  1200. all of the popular dropfile formats, regardless of how hairy it gets... :-)
  1201.  
  1202. BFE by default does not look for a BBS dropfile, since it was originally
  1203. designed to be run as a frontend (i.e. *BEFORE* the user had actually logged
  1204. on to the BBS).
  1205.  
  1206. As of v1.22 of BFE, a "smart" method of dropfile detection has been employed.
  1207. BFE first looks in the current directory for the dropfile.  If it is not
  1208. there, it looks in the DOS path.  If the dropfile mode is enabled, and BFE
  1209. can not locate a dropfile, it will not run!
  1210.  
  1211.    1.) First, if there was a custom door information file format
  1212.        defined in the BFE global configuration file, BFE will begin
  1213.        by looking for this file. BFE searches for the custom
  1214.        information file in the following order:
  1215.  
  1216.              A.) The path defined by the BBSDir keyword
  1217.              B.) The directory which was the current default dir
  1218.                  at startup time
  1219.              C.) If any of the following environment variables
  1220.                  exist, BFE will then search for the file
  1221.                  in the directories pointed to by these variables,
  1222.                  in the following order:
  1223.                               RA
  1224.                               QUICK
  1225.                               PCB
  1226.                               BBS
  1227.  
  1228.    2.) If no custom door information file was found / defined,
  1229.        BFE will then search for door information files
  1230.        corresponding to one of the built in formats. It will search
  1231.        for these files in the same directories, and same order, as
  1232.        it does for the custom door information file (A - C). Within
  1233.        each directory, it will search for files with the following
  1234.        filenames:
  1235.  
  1236.                          CHAIN.TXT
  1237.                          SFDOORS.DAT
  1238.                          DOOR.SYS
  1239.                          CALLINFO.BBS
  1240.                          DORINFO1.DEF
  1241.                          DORINFOx.DEF, where x is the node number
  1242.  
  1243.        As soon as it finds a directory containing one of these
  1244.        filenames, BFE will stop it's door information file
  1245.        search phase. It then begins to decide what to do with what
  1246.        it has found. If more than one of the above filenames was
  1247.        found in the directory in question, BFE will read the
  1248.        file with the most recent date and time stamp. This is intended
  1249.        to overcome abiguities that can arise when a door information
  1250.        file conversion program is being used, and a number of
  1251.        different door information files may still exist in the
  1252.        directory. In such a case, it is assumed that the most recently
  1253.        created file is the one that should be used. If more than one
  1254.        file exist with an identical date and time, BFE will use
  1255.        the file that is closer to the beginning of the above list. (ie
  1256.        they are listed in their order of priority)
  1257.  
  1258.        Once BFE has decided which file it is going to use, it
  1259.        may have still more decision-making to do. In the case of
  1260.        door information file names that correspond to more than one
  1261.        format (such as DOOR.SYS), BFE will examine the file
  1262.        to determine which format it actually is. If a DORINFO?.DEF
  1263.        file is found, BFE will then also attempt a search for an
  1264.        EXITINFO.BBS file.  Again, if an EXITINFO.BBS file is found, BFE
  1265.        must determine which of the many EXITINFO.BBS formats it is actually
  1266.        dealing with.
  1267.  
  1268.        This may all sound rather complicated, but it is a well thought-
  1269.        out strategy that is intended to asure that the correct door
  1270.        information file will be located and used in the vast majority
  1271.        of cases. (and to think - it does all this in the blink of an
  1272.        eye!)
  1273.  
  1274. If you need to specify a specific path to your dropfile, see the "BBSDir"
  1275. option in the next section.
  1276.  
  1277. As of v1.22, BFE recognizes the following dropfile formats:
  1278.  
  1279.         DORINFOx.DEF (Standard DORINFOx.DEF Drop file (Default))
  1280.         EXITINFO.BBS (RA v.01 - v.04)
  1281.         EXITINFO.BBS (Extended (RA v1.0+))
  1282.         EXITINFO.BBS (RemoteAccess 2.0+ style)
  1283.         CHAIN.TXT    (WWIV)
  1284.         SFDOORS.DAT  (SpitFire BBS)
  1285.         CALLINFO.BBS (WildCat!)
  1286.         DOOR.SYS     (GAP/PC-Board)
  1287.         DOOR.SYS     (Doorway version)
  1288.         QBBS 2.75+   (EXITINFO.BBS)
  1289.         DOOR.SYS     (WildCat! style)
  1290.         Custom       (See the global config file section)
  1291.  
  1292.         ** Additional Notes on the Global Configuration File: **
  1293.  
  1294. The name of the .GBL file is passed on the BFE command line.  If you do not
  1295. wish to make use of the options in the BFE.GBL file, simply pass a dummy
  1296. name (i.e. NULL, DUMMY, etc).  In other words, if BFE cannot locate the
  1297. global configuration file, it will be ignored, and all defaults will be used.
  1298.  
  1299. ---------------------------------------------------------------------------
  1300.                    External Protocol Configuration
  1301. ---------------------------------------------------------------------------
  1302.  
  1303. Whenever you make use of BFE's file transfer types (F and M), you will need
  1304. to make use of external protocols.  Previous releases of BFE made use of the
  1305. DSZ file transfer engine from Omen Technology.  However, in order to solve
  1306. command line problems, not to mention providing a more flexible layer for
  1307. using other protocol systems, the PROTOCOL.BFE file has been implemented.
  1308.  
  1309. The format of this file is incredibly simple, yet powerful.  You may specify
  1310. up to 9 protocols in this file.  If you need more than this you are overdoing
  1311. it. :-)
  1312.  
  1313. ;-----------------------[ Sample PROTOCOL.BFE File ]------------------------
  1314. ;┌────────────────────────────────────┬─────────────────────────────────────┐
  1315. ;│██▀▀▀▀█   ██▀▀▀▀▀▀ ██▀▀▀▀▀▀         │  For support, contact:              │
  1316. ;│██▄▄▄▄█▄  ██▄▄▄▄▄  ██▄▄▄▄▄          │                                     │
  1317. ;│██    ▄█  ██       ██               │  Scott Burkett, Sysop               │
  1318. ;│██▄▄▄▄▄█  ██       ██▄▄▄▄▄▄ v1.30.2α│  Under the Nile BBS, 1:3613/12      │
  1319. ;│                                    │  (706) 596-8126 14.4/v.32           │
  1320. ;│BBS Front-End System                └─────────────────────────────────────┤
  1321. ;│(C)opyright 1992, 1993 Cairo Research Labs, All Rights Reserved           │
  1322. ;└──────────────────────────────────────────────────────────────────────────┘
  1323.  
  1324. ; PROTOCOL.BFE
  1325. ; ------------
  1326. ; If you're using a locked baud rate, you will probably not use the %s
  1327. ; parameter in your protocol batch files.  Simply place your locked baud
  1328. ; baud rate (19200, 38400, etc) in place of where the %s would normally
  1329. ; appear.
  1330. ;
  1331. ; BFE passes: %1 - Node number
  1332. ;          %2 - Port number (1-4)
  1333. ;          %3 - Serial Speed
  1334. ;          %4 - File to download (complete path, if specified in SEC.)
  1335. ;             %5 - U = Upload D = Download  
  1336. ;
  1337. ; Format: Protocol [Description (one word)] [Protocol batch file] [A]
  1338. ;
  1339. ;         ** The [A] parameter above will force BFE to prompt the user for 
  1340. ;            the filename (if uploading).  Some protocols, such as ZModem,
  1341. ;            do not need this option enabled, as they automagically obtain
  1342. ;            the filename through the initial transmission header.
  1343. ;
  1344. ; You may list up to 9 Protocols (Only the first nine will be used!)
  1345.                         
  1346. Protocol DSZ/ZModem DSZMODEM.BAT
  1347. Protocol DSZ/YModem DSYMODEM.BAT
  1348. Protocol DSZ/XModem DSXMODEM.BAT A
  1349.  
  1350. ;---------------[ End of Sample PROTOCOL.BFE File ]------------------------
  1351.  
  1352. The contents of your batch files will vary, but here is a sample batch file
  1353. for calling DSZ in the above DSZMODEM.BAT file:
  1354.  
  1355. @echo off
  1356. REM %1 = Node
  1357. REM %2 = Port
  1358. REM %3 = Speed
  1359. REM %4 = Filename to be transferred
  1360. REM %5 = (U)pload or (D)ownload    
  1361.  
  1362. SET DSZPORT=%2
  1363.  
  1364. if "%5" == "U" goto UPLOAD
  1365.  
  1366. xu port:2:off
  1367. dsz.com ha on port %2 speed 19200 sz %4
  1368. xu port:2:on
  1369. goto END
  1370.  
  1371. :UPLOAD
  1372. xu port:2:off
  1373. dsz.com ha on port %2 speed 19200 rz 
  1374. xu port:2:on
  1375.  
  1376. :END
  1377. SET DSZPORT=
  1378.    
  1379. ----------[ Cut Here! ]
  1380.  
  1381. *** Note that 19200 was used in the above example.  You would do this if you
  1382.     run with a locked serial port.  If you are not running a high speed modem
  1383.     at a locked serial speed, simply substitute the 19200 with the %3 value.
  1384.  
  1385. ---------------------------------------------------------------------------
  1386.  
  1387.  ┌────────────────┐
  1388. ▄│   Sysop Keys   │
  1389. █└────────────────┘
  1390. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  1391.  
  1392. There are several options available to the Sysop while the user is in the
  1393. BFE Door.  These options and hotkeys differ from BBS "personality" to
  1394. "personality".  As discussed in the sample global configuration file, BFE
  1395. currently supports 3 BBS personalities (RemoteAccess 2.0x, WildCat!, and the
  1396. default style).  For more information on the RA and WildCat! hotkeys, consult
  1397. the documentation which accompanied the BBS software.
  1398.  
  1399.                         DEFAULT SYSOP HOTKEYS
  1400.                         ---------------------
  1401.  
  1402. [UP/DOWN] -   Use the arrow keys to increase or decrease the
  1403.               amount of time which the user has left in the door.
  1404.  
  1405. [Alt]-[C] -   Allows the sysop to break into chat with the user
  1406.               at any time. [Alt]-[C] again, or [ESC] will end
  1407.               chat mode. (Notice that the Want-Chat indicator
  1408.               will also be turned off, if it was flashing. If
  1409.               you are running under Apex, RemoteAccess or
  1410.               QuickBBS, paging from within the door will even
  1411.               cause the Want-Chat indicator to stay lit when the
  1412.               user returns to the BBS)
  1413.  
  1414. [Alt]-[J] -   Allows the sysop to shell to DOS, if enough memory
  1415.               is available. Simply type EXIT to return to the
  1416.               door again.
  1417.  
  1418. [Alt]-[H] -   Hang up on the user. Plain and simple!
  1419.  
  1420. [Alt]-[L] -   This key locks the user out of the BBS. It first
  1421.               hangs up on the user, and then sets their security
  1422.               level to 0, to prevent them from ever logging on
  1423.               again. This feature may require use of the EXITINFO.BBS
  1424.               file, depending on what system BFE is running under.
  1425.  
  1426. [Alt]-[K] -   The "User Keyboard-Off" key allows the sysop to
  1427.               temporarily prevent the user from typing anything
  1428.               on their keyboard. This has no effect on the local
  1429.               keyboard, but causes BFE to ignore any keystrokes
  1430.               from remote.
  1431.  
  1432. [Alt]-[N] -   The "Sysop Next" key, this function reserves the
  1433.               system for use by the sysop after the user logs
  1434.               off, if BFE is running under an Apex or RA
  1435.               1.00 or later system.
  1436.  
  1437. [Alt]-[D] -   "Drop to BBS" key. This function allows the sysop
  1438.               to exit BFE and return the user to the BBS,
  1439.               without hanging up.
  1440.  
  1441. [F1]      -   Display basic user information (default)
  1442. [F9]      -   Display help information for sysop
  1443. [F10]     -   Turn off the status line
  1444.  
  1445.  ┌──────────────────┐
  1446. ▄│   Command Line   │
  1447. █└──────────────────┘
  1448. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  1449.  
  1450. BFE accepts the following parameters (in any order):
  1451.  
  1452.         -p(Port>               - 1,2,3,or 4 (COM1, COM2, etc)
  1453.         -s(Serial speed>       - Self explanatory!
  1454.         -c(Control File Path>  - Path/filename of your main .CTL file!
  1455.         -t(Time to next event) - The time until the next event
  1456.         -f                     - Forces ANSI in local mode
  1457.  
  1458. You can run BFE in local mode by passing "-p0 -s0" as the port and speed.
  1459. Of course, if you are using a dropfile, these values are meaningless
  1460. once again, therefore your dropfile must be configured for local use (Or
  1461. comment out the "Dropfile" keyword in the global config file!)
  1462.  
  1463.  ┌───────────────────────────────┐
  1464. ▄│ Multinode/Multiuser Operation │
  1465. █└───────────────────────────────┘
  1466. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  1467.  
  1468. BFE is quite capable of running on multinode systems, and in fact, does it
  1469. quite adeptly.  Special care has been given to ensure 100% multinode compat-
  1470. ibility.  If you happen to experience problems running BFE on a multinode
  1471. machine, please contact us if you are unable to resolve the problem.
  1472.  
  1473.  
  1474. ** NOTE:  BFE creates a special "semaphore" file called BFELOCK.$$$ whenever
  1475. a node is currently reading a control file.  If another instance of BFE is
  1476. executed, it will wait until this file is erased by the owner instance of BFE.
  1477. If, for some reason, BFE seems to "lock up", check for the existence of this
  1478. file, and simply remove it.  Careful attention has been paid to ensure that
  1479. this file gets deleted in any event, but things can happen!
  1480.  
  1481. ────────────────────────────────────────────────────────────────────────────
  1482. ■ MISCELLANEOUS ■
  1483. ────────────────────────────────────────────────────────────────────────────
  1484.  
  1485.  ┌────────────────────┐
  1486. ▄│   Special Thanks   │
  1487. █└────────────────────┘
  1488. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  1489.  
  1490. We would like to take time to offer our appreciation to the Cairo Research
  1491. Lab Beta Team.  Thanks guys!
  1492.  
  1493. A special thanks to Steve Pepin, for his persistent help with the WildCat!
  1494. concerns in *all* of our door products.
  1495.  
  1496. Special thanks go out to Bob Kruger, the friend and beta tester from the
  1497. outskirts of hell.  And to Diane (my wife-to-be, for her graduation from
  1498. 4 years of nursing school hell!).
  1499.  
  1500. Thanks are also in order for Brian Pirie for authoring a *superb* DOS commo
  1501. library, and countless others whose efforts and caveats seem to go unnoticed
  1502. at times.
  1503.  
  1504.  ┌──────────────────────────────┐
  1505. ▄│   Upgrades and Information   │
  1506. █└──────────────────────────────┘
  1507. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  1508.  
  1509. For the latest version of BFE, or for tech support by BBS, call:
  1510.  
  1511. Under The Nile!                 
  1512. (706) 596-8126 14.4 v.32        
  1513. 1:3613/12@fidonet               
  1514.  
  1515. All tech support calls to Under the Nile, please.
  1516.  
  1517. Magic name BFE will get you the latest version!
  1518. Magic name BFEBETA will get you the latest beta version!
  1519.  
  1520. ────────────────────────────────────────────────────────────────────────────
  1521. ■ END OF BFE 1.30.2α DOCUMENTATION ■
  1522. ────────────────────────────────────────────────────────────────────────────
  1523.