home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / COMPTRV4.ZIP / SYSOP.DOC < prev    next >
Text File  |  1994-02-14  |  15KB  |  332 lines
  1.  
  2.  
  3.  
  4.                         DOORLIB, the QB45 "DOOR LIBrary"
  5.  
  6.                     Door Operational Information for SysOps                                     
  7.  
  8.                                 July 11, 1993
  9.   
  10.                                       By
  11.   
  12.                                Raymond Clements
  13.                                2204 Carriage Dr.
  14.                            Owensboro, KY  42301-5823
  15.  
  16.                            (C) Copyright 1987-1993
  17.                              All Rights Reserved
  18.  
  19.                                The Pegasus BBS
  20.                                 (502)684-9871
  21.                           (502)684-9896 USR DS 16.8K
  22.                    RIME Postlink routable ->PEGASUS or ->36
  23.  
  24.  
  25.                               Support Shareware
  26.                              -------------------
  27.  
  28.        Thank you for obtaining this door program.  Many hours of coding
  29.        have gone into its development.  Like all shareware products,
  30.        you're encouraged to register this program if it meets your needs.
  31.        Supporting Shareware helps insure the future development of such
  32.        programs and will entitle you to support from their authors.
  33.  
  34.  
  35.                                 About DOORLIB
  36.                                ---------------
  37.  
  38.        DOORLIB requires DOS v3.1 or greater and supports file sharing to
  39.        allow multi-node use, both XON/XOFF and CTS/RTS handshaking,
  40.        communication ports COM1 to COM4, non-standard communication ports,
  41.        baud rates from 300 to 115,200, fossil drivers using the standard
  42.        INT 14h interface and IRQs from 1 to 15 and is DESQview aware.
  43.  
  44.        The following door interface files are supported:
  45.  
  46.            AUNTIE.SYS
  47.            CALLINFO.BBS
  48.            CHAIN.TXT
  49.            DOOR.SYS
  50.            DORINFO#.DEF
  51.            JUMPER##.DAT
  52.            PCBOARD.SYS
  53.            SFDOORS.DAT
  54.            TRIBBS.SYS
  55.            USERINFO.DAT  (requires usage of /NODE:## and /PORT:##)
  56.  
  57.        (If your BBS isn't already supported then please send me the file
  58.         format for the door I/O file your BBS uses and I'll try to add
  59.         support for it.)
  60.  
  61.  
  62.                                  DOORLIB.TXT
  63.                                 -------------
  64.  
  65.        The majority of text used by DOORLIB is in the file DOORLIB.TXT,
  66.        thus helping to support multi-lingual doors.  Please keep in mind
  67.        that editing DOORLIB.TXT may create errors that are not the
  68.        responsibility of the author.  (The majority of errors generated
  69.        will probably be caused by disrupting the order of the lines.)  
  70.  
  71.        The macro, @OPTEXT@, should NEVER be altered.
  72.  
  73.        Line 1                 <== Name of the BBS software being used.
  74.  
  75.        Line 2                 <== Name used to mean no active player in the
  76.                                   scoreboard bulletin.
  77.  
  78.        Line 3                 <== Clears the screen at the beginning of the
  79.                                   scoreboard and challenge ladder bulletins.
  80.  
  81.        Lines 4-12             <== Used to colorize the scoreboard and
  82.                                   challenge ladder bulletins.  PCBoard,
  83.                                   Wildcat and ANSI codes are supported.
  84.  
  85.        Lines 13-35            <== Text used by DOORLIB doors.
  86.  
  87.        Lines 36-90            <== Microsoft QuickBASIC v4.5 error messages.
  88.  
  89.  
  90.                             Environment Variables
  91.                            -----------------------
  92.  
  93.        One environment variable must be set in your AUTOEXEC.BAT file:
  94.  
  95.        SET LIB=<drive:><path to DOORLIB.TXT>  (ONLY the DRIVE and PATH!)
  96.  
  97.        Example:  SET LIB=C:\LIBRARYS
  98.  
  99.        The DOORLIB.TXT file must then be placed in this directory.  I'd
  100.        suggest a separate directory as I do on my system.
  101.  
  102.        For your convenience this door also supports the following
  103.        environment variables:
  104.  
  105.        %DIRECTORY%            <== SET DIRECTORY=\BBS\ (ie. \BBS\ , etc.)
  106.        %DRIVE%                <== SET DRIVE=C:        (ie. C: , D: , etc.)
  107.        %FOSSIL%               <== SET FOSSIL=1        (ie. 1 )
  108.        %IRQ%                  <== SET IRQ=5           (ie. 1 , 15 , etc.)
  109.        %NODE%                 <== SET NODE=1          (ie. 1 , 2 , etc.)
  110.        %PORT%                 <== SET PORT=&H3F8      (ie. &H3E8 , etc.)
  111.  
  112.        These may be used to allow a single DOORNAME.CFG file for all nodes.
  113.        When using these variables please remember the combination of them
  114.        MUST form a valid DOS "drive:\path\" pointing to the location of the
  115.        BBS interface file.
  116.  
  117.  
  118.                                   Door Setup
  119.                                  ------------
  120.  
  121.        Make a batch file to run the door as described in your BBS
  122.        documentation.
  123.  
  124.  
  125.                            Example Door Batch File:
  126.                           --------------------------
  127.  
  128.        ECHO OFF               <== Turns off ECHOing of batch commands.
  129.        CD\DOORS\DOORNAME      <== Changes to door's subdirectory.
  130.        DOORNAME DOORNAME.CFG  <== Runs DOORNAME.EXE by passing the parameter
  131.                                   of DOORNAME.CFG to it.
  132.        CD\BBS                 <== Changes back to BBS' subdirectory.
  133.        BOARD                  <== Starts BBS back up.
  134.  
  135.  
  136.                           Example DOORNAME.CFG File:
  137.                          ----------------------------
  138.  
  139.        You may use the environmental variables to only require one
  140.        DOORNAME.CFG file for multiple nodes.
  141.  
  142.        C:\BBS\DOOR.SYS        <== The drive:\path\filename
  143.                                   of your BBS interface file
  144.                                   which is the same as
  145.  
  146.                                   %DRIVE%%DIRECTORY%%NODE%DOOR.SYS
  147.  
  148.                                   using the above variables.
  149.        The Pegasus BBS        <== The name of your BBS.
  150.        Raymond Clements       <== The SysOp's name (first and last).
  151.        0000000000             <== Registration code number.
  152.        John Doe & Jane Doe    <== The name(s) of the door's sponsors.
  153.  
  154.        (Some programs may require additional info in the DOORNAME.CFG file.)
  155.  
  156.  
  157.                           Command-line Parameters
  158.                          -------------------------
  159.  
  160.        By default, the door will reflect the same setup locally that the
  161.        caller has chosen remotely.  These parameters may be used when
  162.        starting the door to override the caller's defaults.  (Multiple
  163.        parameters are accepted.)
  164.        
  165.  
  166.        /COLOR                 <== Forces the door to display color
  167.                                   even when the caller isn't in color mode.
  168.  
  169.        /NOCOLOR               <== Forces the door NOT to display color
  170.                                   even when the caller is in color mode.
  171.  
  172.        /FOSSIL                <== Allows usage of a fossil driver.
  173.  
  174.        /IRQ:##                <== Allows usage of non-standard IRQs.
  175.  
  176.        /LOCAL                 <== Allows local usage of the door.
  177.  
  178.        /MUSIC                 <== Forces the door to play ANSI music
  179.                                   even when the caller isn't using it.
  180.  
  181.        /NOMUSIC               <== Forces the door NOT to play ANSI music
  182.                                   even when the caller is using it.
  183.  
  184.        /NODE:##               <== Allows node specification.
  185.                                   (For usage with door I/O files that
  186.                                    don't specify current node.)
  187.  
  188.        /PORT:#####            <== Allows usage of non-standard comm. ports.
  189.                                   (Specify full HEX or DECIMAL number.)
  190.                                   (ie. use "&H" with HEX numbers.)
  191.  
  192.        /SOUND                 <== Forces the door to use sound even
  193.                                   when the caller isn't using it.
  194.  
  195.        /NOSOUND               <== Forces the door to NOT use sound even
  196.                                   when the caller is using it.
  197.  
  198.  
  199.                                 Door Operation
  200.                                ----------------
  201.  
  202.        These function/operational keys are at your disposal:
  203.  
  204.        ALT-H                  <   Involuntarily returns the caller to the
  205.        F8                     <== BBS at the next caller input prompt.
  206.        ALT-X                  <       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  207.  
  208.  
  209.                        Scoreboard Utility: SCR-UTIL.EXE
  210.                       ----------------------------------
  211.  
  212.        These parameters may be used with SCR-UTIL to maintain each door's
  213.        high score file (ie. DOORNAME.SCR) and/or challenge ladder file
  214.        (ie. DOORNAME.LDR).
  215.  
  216.        /EDIT                  <== Allows editing of SysOp maintainable
  217.                                   parameters in the high score and
  218.                                   challenge ladder files.
  219.                                   (ie. SCR-UTIL DOORNAME.SCR /EDIT)
  220.  
  221.        /PURGE                 <== Purge names from database if they
  222.                                   haven't used the DOOR in a predefined
  223.                                   number of days.
  224.                                   (ie. SCR-UTIL DOORNAME.SCR /PURGE)
  225.  
  226.        /RESET                 <== Resets all of the names in the database
  227.                                   back to the "no active player" name.
  228.                                   (ie. SCR-UTIL DOORNAME.SCR /RESET)
  229.  
  230.  
  231.        >>>> BOTH SCR-UTIL.EXE AND CFG-UTIL.EXE ARE FOUND IN DL-UTILS.ZIP <<<<
  232.  
  233.  
  234.                       Configuration Utility: CFG-UTIL.EXE
  235.                      -------------------------------------
  236.  
  237.        These parameters may be used with CFG-UTIL to maintain each door's
  238.        configuration file (ie. DOORNAME.CFG).
  239.  
  240.        /CREATE                <== Creates a standard 5 line configuration
  241.                                   file using the recommended defaults for
  242.                                   each line.
  243.                                   (ie. CFG-UTIL DOORNAME.CFG /CREATE)
  244.  
  245.        /EDIT                  <== Allows editing of each line in the
  246.                                   configuration files.
  247.                                   (ie. CFG-UTIL DOORNAME.CFG /EDIT)
  248.  
  249.        /TRIVIA                <== Tells the "/CREATE" parameter to create
  250.                                   a standard 22 line trivia configuration file
  251.                                   using the recommended defaults for each line.
  252.                                   (ie. CFG-UTIL DOORNAME.CFG /CREATE /TRIVIA)
  253.  
  254.  
  255.                                  Device Driver
  256.                                 ---------------
  257.  
  258.        The device driver, ANSI.SYS, should be added to the CONFIG.SYS
  259.        file in the root directory.  The door uses this device driver for
  260.        displaying all colors and screen positioning to the local console.
  261.  
  262.  
  263.                                     Errors
  264.                                    --------
  265.  
  266.        All errors should recover and cause the door program to exit
  267.        gracefully and return to the main system.  All errors are logged
  268.        in the "DOORLIB.ERR" file found in the "SET LIB=" directory.  The
  269.        error number and line number are included with the date and time.
  270.        Errors will be either caused by the main module (the author's code,
  271.        contact him/her) or the DOORLIB library (contact Raymond Clements).
  272.        It should NEVER cause the BBS to hang.  If your BBS hangs, you are
  273.        requested to contact the appropriate party and report the error
  274.        number, error line number and circumstances that caused it.
  275.        Because we are using Microsoft's (C) QuickBASIC v4.5 run-time
  276.        routines, it is possible that BASIC will detect a fatal error
  277.        condition.  As mentioned above, we have taken every precaution,
  278.        but simply cannot code for every error condition.  If the door
  279.        author follows all the rules, the door should run without errors.
  280.  
  281.  
  282.                                    Warranty
  283.                                   ----------
  284.  
  285.        This door is provided as is without warranty of any kind.  The entire
  286.        risk as to the results and performance of this door is assumed by you.
  287.        Futhermore, the author does not warrant, guarantee, or make any other
  288.        representations regarding the use of, or the results of the use of,
  289.        this door, and you rely on this door and results solely at your own
  290.        risk.  The author cannot and will not accept responsibility for system
  291.        damage, loss of profit or any other special, consequential or
  292.        incidental damages resulting from the use of or inability to use this
  293.        door.
  294.  
  295.  
  296.                                  Distribution
  297.                                 --------------
  298.  
  299.        This file may be made available for download on any BBS as long as NO
  300.        changes are made to the contents of the archive.  The archive and its
  301.        individual contents may NOT be used by any service that charges any
  302.        money whatsoever, without the written permission of the author.
  303.  
  304.  
  305.                                  Registration
  306.                                 --------------
  307.  
  308.        Registration and the subsequent insertion of the registration number
  309.        into your configuation file, allows for the removal of the opening
  310.        shareware information screen, the display of your BBS name on the
  311.        opening screen as well as the removal of the registration request on
  312.        the closing screen.  To register this door, please fill out the
  313.        order form, also found in this archive, (ORDER.FRM) and mail it
  314.        along with the registration fee to the name and address on the form.
  315.        Please be sure to use the proper upper and lower case when filling in
  316.        the name and BBS name this door is to be registered to, as they MUST
  317.        match the way they're entered in the configuration file.
  318.  
  319.  
  320.                                     Credits
  321.                                    ---------
  322.  
  323.        All my DoorLib door programs are written with a registered version of
  324.        TSE (The Semware Editor), compiled with Microsoft's QuickBASIC, linked
  325.        with registered versions of Tom Hanlin's PBClone and Jeff Sumberg's
  326.        QBSerial and are ZIPed with a registered version of Phil Katz's PKZIP.
  327.        I would like to thank all of them for the use of their great programs.
  328.        I'd also like to thank my loving wife Sondra for putting up with me
  329.        during all of my hours of programming and SysOping.
  330.  
  331.  
  332.