home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / PASSWORD.ZIP / SYSOP.DOC < prev   
Text File  |  1991-09-15  |  12KB  |  257 lines
  1.  
  2.  
  3.  
  4.                 DOORPCH v3.8 DOOR Operational Information for SysOps
  5.  
  6.                                 September 15, 1991
  7.                                         By
  8.                                  Raymond Clements
  9.                                  2204 Carriage Dr.
  10.                              Owensboro, KY  42301-5823
  11.  
  12.                              (C) Copyright 1987-1991
  13.                                All Rights Reserved
  14.  
  15.                                  The Pegasus BBS
  16.                              Node #1 - (502)684-9855
  17.                              Node #2 - (502)684-9871 HST
  18.                            RIME PCRelay routable ->PEGASUS
  19.  
  20.  
  21.                                  SysOp Operation
  22.                                 -----------------
  23.  
  24.          Please include the following information with any DOOR you write
  25.          which uses DOORPCH v3.8.  The SysOp will require the information.
  26.  
  27.  
  28.                                      Preface
  29.                                     ---------
  30.  
  31.          This is NOT meant to tell you how to setup DOORs on your BBS,
  32.          just how to setup DORPCH38 doors.
  33.  
  34.  
  35.                                 Support Shareware
  36.                                -------------------
  37.  
  38.          Thank you for obtaining this door program.  Many hours of coding
  39.          have gone into its development.  Like all shareware products,
  40.          you're encouraged to register this program if it meets your needs.
  41.          Supporting Shareware helps insure the future development of such
  42.          programs and will entitle you to support from their authors.
  43.  
  44.  
  45.                               Environment Variables
  46.                              -----------------------
  47.  
  48.          Two environment variables must be set in your AUTOEXEC.BAT file:
  49.  
  50.          SET LIB=<drive:><path to DORPCH38.EXE>  Note: ONLY the PATH!
  51.  
  52.          Example:  SET LIB=C:\MYLIB
  53.  
  54.          The DORPCH38.EXE run-time library and DOORPCH.CFG files must then
  55.          be placed in this directory.  I'd suggest a separate directory as
  56.          I do on my system and include it in your PATH statement.
  57.  
  58.  
  59.          SET DOORPCH=PCB     This variable is required by prior versions
  60.                              of DOORPCH, but not by DORPCH38.EXE.
  61.  
  62.          For your convenience DOORPCH v3.8 also supports the following three
  63.          new variables:
  64.                         %NODE% , %DRIVE% , and %DIRECTORY%
  65.  
  66.                         SET NODE=1          (ie. 1 , 2 , etc.)
  67.                         SET DRIVE=C:        (ie. C: , D: , etc.)
  68.                         SET DIRECTORY=\BBS\ (ie. \PCB\ , \BBS\ , etc.)
  69.  
  70.          These may be used to allow a single DOORNAME.CFG file for all nodes.
  71.          When using these variables please remember the combination of them
  72.          MUST form a valid DOS "drive:\path\" pointing to the location of the
  73.          BBS interface file.
  74.  
  75.  
  76.                                    DOORPCH.KEY
  77.                                   -------------
  78.  
  79.          DoorPch is released as a completely UNcrippled program.  Upon
  80.          registering DoorPch you'll receive a DOORPCH.KEY file.  This
  81.          file should be put in the "SET LIB=" directory along with the
  82.          DORPCH38.EXE and DOORPCH.CFG files.  Upon exiting, all DOORs
  83.          using DoorPch v3.8 will then say "This copy of DoorPch v3.8 is
  84.          registered to: " and your BBS name, your name and your serial
  85.          number.
  86.  
  87.  
  88.                                     DOOR Setup
  89.                                    ------------
  90.  
  91.          Make a batch file to run the DOOR as described in your BBS
  92.          documentation.
  93.  
  94.  
  95.                              Example DOOR batch file:
  96.                             --------------------------
  97.  
  98.          ECHO OFF
  99.          CD\DOORS\4CARD
  100.          4CARD 4CARD.CFG             <== Runs 4CARD.EXE passing
  101.                                          a parameter of 4CARD.CFG to it.
  102.          CD\BBS
  103.          BOARD
  104.  
  105.  
  106.                             Example DOORNAME.CFG file:
  107.                            ----------------------------
  108.  
  109.          You may use the environmental variables to only require one
  110.          DOORNAME.CFG file for multiple nodes.
  111.  
  112.          C:\BBS\DOOR.SYS             <== The drive:\path\filename
  113.                                          of your BBS interface file
  114.                                          which is the same as
  115.  
  116.                                          %DRIVE%%DIRECTORY%DOOR.SYS
  117.  
  118.                                          using the above variables.
  119.          The Pegasus BBS             <== The name of your BBS.
  120.          Raymond                     <== The SysOp's FIRST name.
  121.          Clements                    <== The SysOp's LAST name.
  122.          John Doe & Jane Doe         <== The name(s) of the DOOR's sponsors.
  123.  
  124.  
  125.                             Command-line parameters
  126.                            -------------------------
  127.  
  128.          This parameter may be used when starting a DOORPCH v3.8 DOOR.
  129.  
  130.          /LOCAL                      <== Allows local usage of the DOOR as
  131.                                          the SysOp.
  132.                                          (ie. 4CARD 4CARD.CFG /LOCAL)
  133.  
  134.  
  135.                            DoorPch v3.8 Utility: DP38Util
  136.                           --------------------------------
  137.  
  138.          These parameters may be used with DP38Util to setup and maintain
  139.          each DOOR's high score file and/or challenge ladder file.
  140.  
  141.          /CREATE                     <== Creates the high score file and/or
  142.                                          the challenge ladder file.
  143.                                          (ie. DP38UTIL 4CARD.SCR /CREATE)
  144.          /PURGE:##                   <== Purge names from database if they
  145.                                          haven't used the DOOR in ## days.
  146.                                          (ie. DP38UTIL 4CARD.SCR /PURGE:21)
  147.  
  148.  
  149.                                    Libraries
  150.                                   -----------
  151.  
  152.          All DOORPCH v3.8 DOORs require the DORPCH38.EXE run-time library
  153.          and the Microsoft (R) QuickBASIC 3.0 run-time library, BRUN30.EXE,
  154.          be in your path.  Your DOOR program may have come with these files
  155.          in the archive file.  If they are not present, this DOOR program
  156.          WILL NOT RUN.  You should contact the DOOR author if the files
  157.          are missing.  You require one and only one version of these two
  158.          libraries for ALL DOORPCH v3.8 DOORware.  The files are also
  159.          available in DORPCH38.ZIP available on most of the better Bulletin
  160.          Board Systems.  If you wish a fully detailed explanation of how
  161.          DOORPCH operates with DOORS, then you may read the documentation
  162.          within the DORPCH38.ZIP file within which this documentation may
  163.          be found.
  164.  
  165.  
  166.                                   DOOR Operation
  167.                                  ----------------
  168.  
  169.          When this DOOR is in operation you have complete control over the
  170.          caller.  This DOOR was written using DOORPCH v3.8.  The logic is
  171.          safe and every precaution has been taken to insure this code works
  172.          flawlessly.  If it doesn't, please let us know.  Many
  173.          function/operational keys are at your disposal:
  174.  
  175.          F1    -   Displays the version of DOORPCH compiled and linked
  176.                    into the DOOR.
  177.          F2    -   Displays a caller's Alias if one is used via the DOOR.
  178.          F3    -   Toggles Local Music ON/OFF.
  179.          F4    -   Toggles the Bell ON/OFF.
  180.                    Value is returned to BBS when DOOR completes.
  181.          F5    -   DOS Shell.  Allows the SysOp to exit to DOS from inside
  182.                    a DOOR.
  183.          F6    -   Toggles the Graphics mode of the caller ON/OFF.
  184.                    Value is returned to BBS when DOOR completes.
  185.          F7    -   Toggle the caller alarm ON/OFF.
  186.                    Value is returned to BBS when DOOR completes.
  187.          F8    -   Involuntarily returns the caller to the BBS.
  188.          F9    -   Toggles the display ON/OFF.
  189.                    Value is returned to BBS when DOOR completes.  Some doors
  190.                    may force the display ON, but the original OFF value will
  191.                    be returned to the BBS if this occurs.
  192.          F10   -   Activates SysOp/Caller CHAT mode within the DOOR.
  193.          ESC   -   Deactivates CHAT mode.  DOOR is resumed.
  194.          ALT-H -   HELP key for lines 24/25 capabilities.
  195.          UP    -   Allows the SysOp to add additional time for the caller.
  196.                    Value is returned to BBS when DOOR completes.
  197.          DN    -   Allows the SysOp to subtract time from the caller.
  198.                    Value is returned to BBS when DOOR completes.
  199.          ALT-N -   Some BBSs use SysOp next on control/indicator.
  200.                    Value is returned to BBS when DOOR completes.
  201.          ALT-X -   Some BBSs will exit after current caller completes their
  202.                    session.  Value is returned to BBS when DOOR completes.
  203.  
  204.  
  205.                              Example: DEVICE=ANSI.SYS
  206.                             --------------------------
  207.  
  208.          DOORPCH uses this device driver for displaying all colors and
  209.          screen positioning to the local console.  ANSI Color Graphics will
  210.          always be sent to the local console if you are using a color
  211.          monitor.  If a caller is in non-graphics mode you will still see
  212.          colors if you have a color monitor.  The reverse is also true.
  213.          If the caller is in graphics mode and the local console is a mono
  214.          monitor then colors will NOT be displayed to the local console.
  215.  
  216.  
  217.                                        MUSIC
  218.                                       -------
  219.  
  220.          This DOOR program may utilize ANSI/BASIC music.  If it does, and you
  221.          are running in a NETWORK, DOORPCH does not send ANSI music to the
  222.          local console unless you have it configured to.  We have found that
  223.          under some Multi-Tasking operating systems such as DoubleDOS that
  224.          the "partition" locks up until the music completes.  If you are on
  225.          a single node system (not in a network), then music will be played
  226.          to the local screen if the local screen is active (F9 ON) and you
  227.          have DOORPCH configured that way or local music is toggled on (F3 ON).
  228.  
  229.  
  230.                                        BELL
  231.                                       ------
  232.  
  233.          DOORPCH logic will not allow a BELL to be sent to the local
  234.          console when the local screen is inactive (F9 OFF) or the caller
  235.          alarm is toggled off (F7 OFF).  This, of course, assumes the
  236.          DOOR author follows the DOORPCH rules.
  237.  
  238.  
  239.                                       ERRORS
  240.                                      --------
  241.  
  242.          All errors should recover and cause the DOOR program to exit
  243.          gracefully and return to the main system.  All errors are logged
  244.          in the "DOORPCH.ERR" file found in the "SET LIB=" directory.  The
  245.          error number and line number are included with the date and time.
  246.          Errors will be either caused by the main module (the authors code,
  247.          contact him/her) or the DOORPCH sub (contact Raymond Clements).
  248.          It should NEVER cause the BBS to hang.  If your BBS hangs, you are
  249.          requested to contact the appropriate party and report the error and
  250.          circumstances that caused it.  Because we are using Microsoft's (c)
  251.          QuickBASIC 3.0 run-time routines, it is possible that BASIC will
  252.          detect a fatal error condition.  As mentioned above, we have taken
  253.          every precaution, but simply cannot code for every error condition.
  254.          If the DOOR author follows all the rules, the DOOR should run without
  255.          error.
  256.  
  257.