home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ftp.wwiv.com
/
ftp.wwiv.com.zip
/
ftp.wwiv.com
/
pub
/
DOOR
/
CONNECT4.ZIP
/
SYSOP.DOC
< prev
next >
Wrap
Text File
|
1994-02-14
|
15KB
|
332 lines
DOORLIB, the QB45 "DOOR LIBrary"
Door Operational Information for SysOps
July 11, 1993
By
Raymond Clements
2204 Carriage Dr.
Owensboro, KY 42301-5823
(C) Copyright 1987-1993
All Rights Reserved
The Pegasus BBS
(502)684-9871
(502)684-9896 USR DS 16.8K
RIME Postlink routable ->PEGASUS or ->36
Support Shareware
-------------------
Thank you for obtaining this door program. Many hours of coding
have gone into its development. Like all shareware products,
you're encouraged to register this program if it meets your needs.
Supporting Shareware helps insure the future development of such
programs and will entitle you to support from their authors.
About DOORLIB
---------------
DOORLIB requires DOS v3.1 or greater and supports file sharing to
allow multi-node use, both XON/XOFF and CTS/RTS handshaking,
communication ports COM1 to COM4, non-standard communication ports,
baud rates from 300 to 115,200, fossil drivers using the standard
INT 14h interface and IRQs from 1 to 15 and is DESQview aware.
The following door interface files are supported:
AUNTIE.SYS
CALLINFO.BBS
CHAIN.TXT
DOOR.SYS
DORINFO#.DEF
JUMPER##.DAT
PCBOARD.SYS
SFDOORS.DAT
TRIBBS.SYS
USERINFO.DAT (requires usage of /NODE:## and /PORT:##)
(If your BBS isn't already supported then please send me the file
format for the door I/O file your BBS uses and I'll try to add
support for it.)
DOORLIB.TXT
-------------
The majority of text used by DOORLIB is in the file DOORLIB.TXT,
thus helping to support multi-lingual doors. Please keep in mind
that editing DOORLIB.TXT may create errors that are not the
responsibility of the author. (The majority of errors generated
will probably be caused by disrupting the order of the lines.)
The macro, @OPTEXT@, should NEVER be altered.
Line 1 <== Name of the BBS software being used.
Line 2 <== Name used to mean no active player in the
scoreboard bulletin.
Line 3 <== Clears the screen at the beginning of the
scoreboard and challenge ladder bulletins.
Lines 4-12 <== Used to colorize the scoreboard and
challenge ladder bulletins. PCBoard,
Wildcat and ANSI codes are supported.
Lines 13-35 <== Text used by DOORLIB doors.
Lines 36-90 <== Microsoft QuickBASIC v4.5 error messages.
Environment Variables
-----------------------
One environment variable must be set in your AUTOEXEC.BAT file:
SET LIB=<drive:><path to DOORLIB.TXT> (ONLY the DRIVE and PATH!)
Example: SET LIB=C:\LIBRARYS
The DOORLIB.TXT file must then be placed in this directory. I'd
suggest a separate directory as I do on my system.
For your convenience this door also supports the following
environment variables:
%DIRECTORY% <== SET DIRECTORY=\BBS\ (ie. \BBS\ , etc.)
%DRIVE% <== SET DRIVE=C: (ie. C: , D: , etc.)
%FOSSIL% <== SET FOSSIL=1 (ie. 1 )
%IRQ% <== SET IRQ=5 (ie. 1 , 15 , etc.)
%NODE% <== SET NODE=1 (ie. 1 , 2 , etc.)
%PORT% <== SET PORT=&H3F8 (ie. &H3E8 , etc.)
These may be used to allow a single DOORNAME.CFG file for all nodes.
When using these variables please remember the combination of them
MUST form a valid DOS "drive:\path\" pointing to the location of the
BBS interface file.
Door Setup
------------
Make a batch file to run the door as described in your BBS
documentation.
Example Door Batch File:
--------------------------
ECHO OFF <== Turns off ECHOing of batch commands.
CD\DOORS\DOORNAME <== Changes to door's subdirectory.
DOORNAME DOORNAME.CFG <== Runs DOORNAME.EXE by passing the parameter
of DOORNAME.CFG to it.
CD\BBS <== Changes back to BBS' subdirectory.
BOARD <== Starts BBS back up.
Example DOORNAME.CFG File:
----------------------------
You may use the environmental variables to only require one
DOORNAME.CFG file for multiple nodes.
C:\BBS\DOOR.SYS <== The drive:\path\filename
of your BBS interface file
which is the same as
%DRIVE%%DIRECTORY%%NODE%DOOR.SYS
using the above variables.
The Pegasus BBS <== The name of your BBS.
Raymond Clements <== The SysOp's name (first and last).
0000000000 <== Registration code number.
John Doe & Jane Doe <== The name(s) of the door's sponsors.
(Some programs may require additional info in the DOORNAME.CFG file.)
Command-line Parameters
-------------------------
By default, the door will reflect the same setup locally that the
caller has chosen remotely. These parameters may be used when
starting the door to override the caller's defaults. (Multiple
parameters are accepted.)
/COLOR <== Forces the door to display color
even when the caller isn't in color mode.
/NOCOLOR <== Forces the door NOT to display color
even when the caller is in color mode.
/FOSSIL <== Allows usage of a fossil driver.
/IRQ:## <== Allows usage of non-standard IRQs.
/LOCAL <== Allows local usage of the door.
/MUSIC <== Forces the door to play ANSI music
even when the caller isn't using it.
/NOMUSIC <== Forces the door NOT to play ANSI music
even when the caller is using it.
/NODE:## <== Allows node specification.
(For usage with door I/O files that
don't specify current node.)
/PORT:##### <== Allows usage of non-standard comm. ports.
(Specify full HEX or DECIMAL number.)
(ie. use "&H" with HEX numbers.)
/SOUND <== Forces the door to use sound even
when the caller isn't using it.
/NOSOUND <== Forces the door to NOT use sound even
when the caller is using it.
Door Operation
----------------
These function/operational keys are at your disposal:
ALT-H < Involuntarily returns the caller to the
F8 <== BBS at the next caller input prompt.
ALT-X < ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Scoreboard Utility: SCR-UTIL.EXE
----------------------------------
These parameters may be used with SCR-UTIL to maintain each door's
high score file (ie. DOORNAME.SCR) and/or challenge ladder file
(ie. DOORNAME.LDR).
/EDIT <== Allows editing of SysOp maintainable
parameters in the high score and
challenge ladder files.
(ie. SCR-UTIL DOORNAME.SCR /EDIT)
/PURGE <== Purge names from database if they
haven't used the DOOR in a predefined
number of days.
(ie. SCR-UTIL DOORNAME.SCR /PURGE)
/RESET <== Resets all of the names in the database
back to the "no active player" name.
(ie. SCR-UTIL DOORNAME.SCR /RESET)
>>>> BOTH SCR-UTIL.EXE AND CFG-UTIL.EXE ARE FOUND IN DL-UTILS.ZIP <<<<
Configuration Utility: CFG-UTIL.EXE
-------------------------------------
These parameters may be used with CFG-UTIL to maintain each door's
configuration file (ie. DOORNAME.CFG).
/CREATE <== Creates a standard 5 line configuration
file using the recommended defaults for
each line.
(ie. CFG-UTIL DOORNAME.CFG /CREATE)
/EDIT <== Allows editing of each line in the
configuration files.
(ie. CFG-UTIL DOORNAME.CFG /EDIT)
/TRIVIA <== Tells the "/CREATE" parameter to create
a standard 22 line trivia configuration file
using the recommended defaults for each line.
(ie. CFG-UTIL DOORNAME.CFG /CREATE /TRIVIA)
Device Driver
---------------
The device driver, ANSI.SYS, should be added to the CONFIG.SYS
file in the root directory. The door uses this device driver for
displaying all colors and screen positioning to the local console.
Errors
--------
All errors should recover and cause the door program to exit
gracefully and return to the main system. All errors are logged
in the "DOORLIB.ERR" file found in the "SET LIB=" directory. The
error number and line number are included with the date and time.
Errors will be either caused by the main module (the author's code,
contact him/her) or the DOORLIB library (contact Raymond Clements).
It should NEVER cause the BBS to hang. If your BBS hangs, you are
requested to contact the appropriate party and report the error
number, error line number and circumstances that caused it.
Because we are using Microsoft's (C) QuickBASIC v4.5 run-time
routines, it is possible that BASIC will detect a fatal error
condition. As mentioned above, we have taken every precaution,
but simply cannot code for every error condition. If the door
author follows all the rules, the door should run without errors.
Warranty
----------
This door is provided as is without warranty of any kind. The entire
risk as to the results and performance of this door is assumed by you.
Futhermore, the author does not warrant, guarantee, or make any other
representations regarding the use of, or the results of the use of,
this door, and you rely on this door and results solely at your own
risk. The author cannot and will not accept responsibility for system
damage, loss of profit or any other special, consequential or
incidental damages resulting from the use of or inability to use this
door.
Distribution
--------------
This file may be made available for download on any BBS as long as NO
changes are made to the contents of the archive. The archive and its
individual contents may NOT be used by any service that charges any
money whatsoever, without the written permission of the author.
Registration
--------------
Registration and the subsequent insertion of the registration number
into your configuation file, allows for the removal of the opening
shareware information screen, the display of your BBS name on the
opening screen as well as the removal of the registration request on
the closing screen. To register this door, please fill out the
order form, also found in this archive, (ORDER.FRM) and mail it
along with the registration fee to the name and address on the form.
Please be sure to use the proper upper and lower case when filling in
the name and BBS name this door is to be registered to, as they MUST
match the way they're entered in the configuration file.
Credits
---------
All my DoorLib door programs are written with a registered version of
TSE (The Semware Editor), compiled with Microsoft's QuickBASIC, linked
with registered versions of Tom Hanlin's PBClone and Jeff Sumberg's
QBSerial and are ZIPed with a registered version of Phil Katz's PKZIP.
I would like to thank all of them for the use of their great programs.
I'd also like to thank my loving wife Sondra for putting up with me
during all of my hours of programming and SysOping.