home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1999 May / PC_ONLINE_5_99.ISO / filesbbs / dos / wave_08.exe / SYSOP.DOC < prev    next >
Encoding:
Text File  |  1999-02-11  |  14.7 KB  |  330 lines

  1.                       Beta 8  WAVE for MAX
  2.  
  3.  
  4.   DISCLAIMER:
  5.   -----------
  6.   The author has taken every precaution to ensure that no harm or
  7.   damage will occur on computer systems operating this package. Nevertheless,
  8.   the author shall NOT be held liable for whatever may happen on your computer
  9.   system or to any computer systems which connects to your own as a result of
  10.   operating this package. The user assumes full responsibility for the correct
  11.   operation of this software package, whether harm or damage results from any
  12.   software error, hardware malfunction, or operator error. NO warranties are
  13.   offered, expressly stated or implied, including without any limitation or
  14.   restriction any warranties of operation for a particular purpose and / or
  15.   merchantability. If you do not agree with this, then absolutely do NOT use
  16.   this program!
  17.  
  18. ───────────────────────────────────────────────────────────────────────────────
  19.  
  20.   LICENSE AGREEMENT:
  21.   ------------------
  22.  
  23.   The door program, support files, and documentation are copyrighted products
  24.   of Frank McCormick. The author reserves all rights to these products.
  25.   This is protected by Canadian, American and International
  26.   Copyright Laws. In no way shall the components of the door software package
  27.   be reproduced or modified in any form or method without prior
  28.   written permission from the author.
  29.  
  30.   Tampering with or altering the contents or integrity of the door software
  31.   package is prohibited. No fee may be charged by any agency other than the
  32.   author beyond the cost of distributing unregistered copies without prior
  33.   written permission from the author.
  34.  
  35.  
  36. ───────────────────────────────────────────────────────────────────────────────
  37.  
  38.   GUARANTEE:
  39.   ----------
  40.   No guarantee is provided.
  41.  
  42. ───────────────────────────────────────────────────────────────────────────────
  43.  
  44.   REQUIREMENTS:
  45.   -------------
  46.   This door will run on any 80XXX system with at least CGA Video and
  47.   640K of memory.
  48.   This door is 100 percent ANSI, ASCII, AVATAR, RIP and MAX aware.
  49.  
  50. ───────────────────────────────────────────────────────────────────────────────
  51.  
  52.   INSTALLATION:
  53.   -------------
  54.  
  55.  1.  Create a directory for the door.
  56.  1a. Create a directory off that one, i.e. WORK.
  57.  
  58.  2.  Copy the contents of this archive into that directory.
  59.  
  60.  3.  Modify the ini file to fit conditions on your computer.
  61.  3a  Double-check the INI file.
  62.  
  63.  4. To insure proper multi-node use in a DOS based multi-tasking environment,
  64.     SHARE.EXE must be installed.
  65.  
  66.  5. In order to run the door program online, the following parameters may
  67.     be used. For a list of all available command line parameters, simply
  68.     execute the door program with no parameters on the command line....
  69.  
  70.     DropFile Specifiers:
  71.     --------------------
  72.     "/D={Node Work Path}\DOOR.SYS" - This tells the program to use the
  73.     DOOR.SYS drop file and the {Node Work Path} points to the proper
  74.     directory where the drop file is to be created or found.
  75.  
  76.     "/R={Node Work Path}\DORINFO#.DEF" - This tells the program to use the
  77.     DORINFO#.DEF drop file and the {Node Work Path} points to the proper
  78.     directory where the drop file is to be created or found.
  79.  
  80.  
  81.     Optional Parameters:
  82.     --------------------
  83.     "/P={MAXterm Home Directory}" - If this door supports MAX Graphics and
  84.     MAX pseudo network spool operation, this parameter is used to start up
  85.     the spool and point it to the directory where MAXterm is installed. You
  86.     may only use this in conjunction with the /L parameter.
  87.  
  88.     "/S##### (Where ##### is the user's actual baud rate) - This specifies
  89.     the online caller's actual baud rate. You use this parameter to force a
  90.     new baud rate if you are running the door with the DOOR.SYS drop file
  91.     and would like to force the door to use the actual baud rate rather than
  92.     the locked port speed.
  93.  
  94.     "/N###" (Where ### is 1..?) - This specifies the current node number and
  95.     tells the door which NODE###.CTL file to use.
  96.  
  97.     "/L" - This tells the door to load up in LOCAL mode.
  98.  
  99.     "/O" - This tells the door to load up in ONLINE mode. This is useful if
  100.     you are running the door online without a drop file. Such is the case if
  101.     you wanted to run the door between your BBS and a front end mailer or a
  102.     waiting for caller program where no drop files are created in advance.
  103.     
  104.     "/X" - This tells the door to send a !|1K|*|#|#|# at exit time to either
  105.     clear the remote screen in RIPterm or to flip MAXterm back to text mode.
  106.  
  107.     "/U#####" (Where ##### is the user's actual BBS record number) - This is
  108.     used in the event the door needs to know the user's actual record number
  109.     when it is not contained in the drop file, or if no drop file is in use.
  110.  
  111.     "/A#####" (Where ##### is the user's actual BBS access level) - This is
  112.     used in the event the door needs to know the user's actual access level
  113.     when it is not contained in the drop file, or if no drop file is in use.
  114.  
  115.     "/T#####" (Where ##### is the user's remaining time in minutes) - This
  116.     is used in the event the door needs to know the user's actual remaining
  117.     online time when it is not contained in the drop file, or if no drop
  118.     file is in use.
  119.  
  120.     "/E#####" (Where ##### is the number of minutes until your next event)
  121.     This is used in the event the door needs to know when the next event in
  122.     your BBS is to take place when it is not contained in the drop file, or
  123.     if no drop file is in use.
  124.  
  125.     "/Z[FirstName_LastName]" - This is used in the event that you have to
  126.     force the user's name and alias in the door. If there is a first name
  127.     and last name, they must be separated by an underscore, not a space..
  128.  
  129.  
  130.  
  131.  
  132. ───────────────────────────────────────────────────────────────────────────────
  133.  
  134.   SAMPLE BATCH FILES FOR RUNNING THE DOOR:
  135.   ----------------------------------------
  136.   CD\DOOR
  137.   DOOR.EXE /D=C:\BBS\NODE1\DOOR.SYS
  138.   CD\BBS
  139.   EXIT
  140.  
  141.   or:
  142.  
  143.   CD\DOOR
  144.   DOOR.EXE /N2 /S14400 /R=C:\BBS\NODE2\DORINFO2.DEF
  145.   CD\BBS
  146.   EXIT
  147.  
  148. ───────────────────────────────────────────────────────────────────────────────
  149.  
  150.   OTHER GENERAL INFORMATION:
  151.   --------------------------
  152.  
  153.   Global System Variables Used By The Door:
  154.   ─────────────────────────────────────────
  155.   {TIME}      = The Current Time
  156.   {DATE}      = The Current Date
  157.   {NODE}      = The Current Node Number
  158.   {BAUD}      = The Current Baud Rate
  159.   {MINS}      = Time Left Online In Minutes
  160.   {EVENT}     = Minutes Until Next Event
  161.   {PORT}      = The Current Comm Port In Use
  162.   {SEC}       = The User's Security Level
  163.   {BBS}       = Your BBS Name
  164.   {USER}      = User's Full Name
  165.   {SYSOP}     = SysOp's Full Name
  166.   {UFIRST}    = User's First Name
  167.   {ULAST}     = User's Last Name
  168.   {SFIRST}    = SysOp's First Name
  169.   {SLAST}     = SysOp's Last Name
  170.   {PROG}      = The Program Name and Version Number
  171.   {ADDR}      = The Port Address Stored In The .CTL File
  172.   {IRQ}       = The Port IRQ Stored In The .CTL File
  173.   {SYSSEC}    = SysOp Security Stored In The .CTL File
  174.   {SERIAL}    = The Serial Number Stored In The .CTL File
  175.   {INSERT1}
  176.    Through
  177.   {INSERT5}   = These are system variables that change from
  178.                 time to time through out the program. Check
  179.                 your screen files to see what their purpose
  180.                 is at the time.
  181.  
  182.   These variables can also be used in text files and screen files used by
  183.   your program. You will also want to look at your ANSI and RIP files with
  184.   a text editor to make sure that any Global System Variables you have used
  185.   have not been split as this will cause them to display incorrectly.
  186.  
  187.   There is a feature incorporated in the variables called Padding
  188.   that is used to align text on your screen, or to ensure that variables will
  189.   only take up X amount of characters on the screen. Any underscores "_" in a
  190.   variable are translated into spaces at run time and can be used on either
  191.   side of the variable. The way to look at it is a "Pad Left" and "Pad Right"
  192.   sort of feature.
  193.  
  194.   Let's try an experiment with the {USER} variable, we'll just use some
  195.   short strings of text to demonstrate the usage of variables and padding.
  196.   Let's say that the user's real name is "Jimi Hendrix". (Just because...)
  197.  
  198.     Actual Text: Hello {USER}, how are you today?
  199.   Translates To: Hello Jimi Hendrix, how are you today?
  200.  
  201.     Actual Text: Hello {USER________________________}, how are you today?
  202.   Translates To: Hello Jimi Hendrix                  , how are you today?
  203.  
  204.     Actual Text: Hello {________________________USER}, how are you today?
  205.   Translates To: Hello                   Jimi Hendrix, how are you today?
  206.  
  207.   Now, granted that these aren't really practical examples, but it shows you
  208.   how padded and non-padded variables work. Padding would be especially handy
  209.   if you were creating something like a user statistics screen. You could put
  210.   the padded variables on an ANSI background, and since there is padding in
  211.   there, the screen will always be displayed in a uniformed fashion. As you
  212.   can see in the above example, the variable {USER} is padded so there is a
  213.   total of 30 spaces on the screen. If you were to chop it down to 20, even
  214.   if the user's name was longer than 20 characters, only 20 characters will
  215.   be displayed on the screen at once.
  216.  
  217.   If you have ever noticed with other programs that use variables of any kind,
  218.   to make sure that your screens always display perfectly aligned is to use
  219.   ANSI animation to go to a specific X/Y coordinate and then plot the variable
  220.   on whatever backdrop you are using. Guess what?....ASCII callers are out of
  221.   luck in this case because there is no cursor control in ACSII/TTY emulation.
  222.  
  223.   Inline Color Tokens:
  224.   ────────────────────
  225.   Inline Color Tokens are similar to Global System Variables with just one
  226.   exception....They don't work in screen files. These are used for adding
  227.   color to text files. Your ANSI colors range from 0 to 31, any number above
  228.   15 forces ANSI blink on. If you want to change the color anywhere in a text
  229.   file, simply add a color code in a pair of fancy brackets before your text.
  230.   An example would be, to change your text to yellow add the token: {14} just
  231.   before it. You have as many color changes that you can fit into a 256
  232.   character line. Padding has no effect on inline color tokens.
  233.  
  234. ───────────────────────────────────────────────────────────────────────────────
  235.  
  236.   MULTINODE USE:
  237.   --------------
  238.  
  239.   This door supports multinode use and provides automatic multi-tasker
  240.   support (time slice releasing) for a wide variety of multi-taskers.
  241.   Such as DesqView, OS/2, and Windows. You will need to run the program
  242.   configuration to create all of the needed control files and node work
  243.   directories. The only thing left to do after that is create batch files
  244.   for each node.
  245.  
  246. ───────────────────────────────────────────────────────────────────────────────
  247.  
  248.   TROUBLESHOOTING:
  249.   ----------------
  250.  
  251.  1. This door REQUIRES a fossil driver to run correctly.
  252.  
  253.  2. If you are running a high speed modem (9600 baud or above), then I
  254.     suggest you run your BBS/Mailer/Doors at a locked baud rate. On high
  255.     speed error correcting modems, locking the baud rate will have a
  256.     noticeable increase on the speed of text that is sent. It's beyond
  257.     the scope of this document to discuss configuring your BBS and
  258.     mailer for a locked baud rate, you may wish to consult your BBS docs
  259.     for information on that. Here are a couple things to keep in mind
  260.     when setting up door with a locked baud rate:
  261.  
  262.     a.  If you are using a fossil, then make sure to tell the fossil
  263.         that the port is locked. For BNU, to lock com1: at 38,400, you
  264.         would use something like "L0=38400,8N1" on BNU's command line.
  265.  
  266.     b.  If you lock the baud for one program, it must be locked for
  267.         everything. You can't lock the baud for just this door, but
  268.         not your BBS/Mailer.
  269.  
  270.  3. What follows is some information on possible strange situations
  271.     that may occur on some systems:
  272.  
  273.     a.  Low speed users can use the door, but high speed users get garbage.
  274.  
  275.         - If you are the DORINFOx.DEF drop file, then there is a chance
  276.           your BBS is writing the locked port speed to the drop file
  277.           rather than the actual caller baud rate. You should either
  278.           change to the DOOR.SYS drop file, or use the /S parameter to
  279.           pass the actual baud rate to the door.
  280.  
  281.           Several converter programs are readily available on most
  282.           BBS systems. CallDoor is a good one if you can find it.
  283.  
  284.     b.  The door hangs up when a user enters the door.
  285.  
  286.         - Sounds like the door is getting the wrong baud rate somehow.
  287.           Try switching over to the DOOR.SYS drop file method if possible.
  288.  
  289.         - This can also be cause by using a fossil driver and locking the
  290.           comport at a rate higher than 38400. If this is the case, then
  291.           reduce your locked port speed and try again.
  292.  
  293.     c.  Text and screens are getting cut off.
  294.  
  295.         - If you are running with a locked baud, then this could be caused
  296.           by some sort of FLOW CONTROL problem. Make sure your fossil is
  297.           loaded correctly and not locked faster than 38400 baud.
  298.  
  299.         - If you're using something other than the DOOR.SYS drop file,
  300.           then I always suggest trying to use DOOR.SYS if possible. It is
  301.           the most reliable method and has had the most testing. If that
  302.           is not possible try DORINFOx.DEF as an alternative.
  303.  
  304.     d.  The door locks up the BBS on every node.
  305.  
  306.         - This can happen with fossil driver or the internal communications
  307.           routines because it uses the default comport of 1 when NONE or
  308.           COM0: is found in the drop file.
  309.  
  310.     e.  ANSI is reflected correctly on the local screen but the user is
  311.         getting garbage when using DORINFOx.DEF.
  312.  
  313.         - Assuming the user has ANSI installed then most likely the problem
  314.           is at your end. First make sure the dropfile is passing the actual
  315.           baud rate INSTEAD of the locked port speed. If it is not passing
  316.           correct baud rate then you may need to use DOOR.SYS instead.
  317.  
  318.     f.  When a user enters the door or when you run it locally, the screen
  319.         appears to cycle (flipping) over and over until the program shuts
  320.         down with a "Runtime Error 202".
  321.  
  322.         - This is caused by people running hacked versions of their fossil
  323.           driver. Even though most of these hacks are nothing more than a
  324.           copy with a new version number, once it's tampered with, it's a
  325.           defective copy. Programs to avoid are BNU 2.xx and X00 2.xx. If
  326.           at all possible, get your fossil drivers author direct!
  327.  
  328.  
  329.  
  330.