home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / dp004b4.zip / SYSOP.DOC < prev    next >
Text File  |  1997-08-13  |  22KB  |  435 lines

  1.  
  2. This document and all other documents are out of date but still include the
  3. correct installation procedures etc.
  4.  
  5. The file list is also out of date.
  6.  
  7. They have both been outdated since version 0.02.
  8.  
  9. Good luck!
  10.  
  11. ** NOTE ** If you are upgrading from version 0.01, see the UPGRADE.DOC
  12.            file --- You must now run DP.BAT instead of DATAPAGE.EXE
  13.  
  14.         DataPage Beta 4 (version 0.04 --  Program & Design by Michael Burke
  15.  
  16.  
  17.                                 DISCLAIMER
  18.  
  19.         The author has taken every precaution to insure that no harm
  20.         or damage will occur on computer systems operating this package.
  21.         Nevertheless, the author shall NOT be held liable for whatever
  22.         may happen on your computer system or to any computer systems
  23.         which connects to your own as a result of operating this package.
  24.         The user assumes full responsibility for the correct operation of
  25.         this software package, whether harm or damage results from software
  26.         error, hardware malfunction, or operator error. NO warranties are
  27.         offered, expressly stated or implied, including without limitation
  28.         or restriction any warranties of operation for a particular purpose
  29.         and/or merchantability.  If you do not agree with this then do NOT
  30.         use this program.
  31.  
  32.         A major portion of this software comes from the DDPlus Door Driver
  33.         Package. The DDPlus Doordriver kit has been used for the
  34.         communications, interrupt handling and some utility functions and
  35.         that part of the software remains copyrighted by the authors of
  36.         the DDplus Package.
  37.  
  38.         This game is distributed under the Shareware concept. You are
  39.         allowed to operate this game for as long as you want, as long
  40.         as you can find a way to work around the limitations.
  41.  
  42.                                 INTRODUCTION:
  43.                                 ------------
  44.         
  45.         This door is a BBS equivalent of WWW pages.  It is not quite as
  46.         versatile; however, it does allow users to maintain their own
  47.         personal "DataPage", which is a directory on your hard drive
  48.         containing files they upload (to a kb limit that you decide).
  49.  
  50.                                 REQUIREMENTS:
  51.                                 ------------
  52.         At this point in time the only requirements are FILES=10 (or more)
  53.         in your config.sys file and ANSI.SYS. SHARE should also be loaded IF
  54.         you intend to use the game in a multi-node environment OR under
  55.         DesqView. The game is RIP aware but NOT a RIP Game at this time. A
  56.         FOSSIL is NOT required to run the game, although one will be
  57.         supported if it exists. Automatic time slicing support is provided
  58.         to most common multi-taskers as well.
  59.  
  60.                                 Files Included
  61.                                 --------------
  62.         Below is a listing of all files for the this Game.  If you are
  63.         missing ANY of these files (except for the DOC and FRM files), the
  64.         game will NOT function.  Feel free to give out copies of the ENTIRE
  65.         archive package of this game but please make sure all the files
  66.         below are in that package:
  67.  
  68.           README.1ST   - The text file you are reading.
  69.           B4UASK.DOC   - Self help checklist provided for sysops to ensure
  70.                           that they have done everything you require in
  71.                           order to run your door on their BBS.
  72.           SYSOP.DOC    - THE most important document in your distribution
  73.                           package! Explains how to set up and
  74.                           operate your door on their BBS's.
  75.           BUGRPT.FRM   - A standard bug report form for use by sysops.
  76.           REGISTER.FRM - Tells sysops how to register your product and the
  77.                           procedures to be followed.
  78.           SETUP.EXE    - The FIRST thing you should run when you unzip it.
  79.                           It'll let you set up miscellaneous options.
  80.           DATAPAGE.EXE - The main module!  You should run this locally
  81.                           after editing DOOR.CTL by typing DATAPAGE /L
  82.                           to initialize the user data file.  When it is
  83.                           initialized, to modify user defaults you can run:
  84.           USEREDIT.EXE - The user editor/user defaults editor.
  85.           CEXYZ.EXE    - Default Transfer protocol.
  86.           X,Y,Z.BAT    - Batch Files for downloading files.
  87.           X,Y,ZUP.BAT  - Batch Files for uploading files.
  88.           DPHELP.ANS   - DataPage Help ANSI done by Nathan Fraser
  89.           DPHELP.TXT   - DataPage help file.
  90.           DIRLIST.ZIP  - Directory Lister plug-in. To install it, unzip
  91.                           it into your DataPage directory.
  92.  
  93.           DIRLIST.TXT must exist when you run DataPage but is not
  94.           included with the package.
  95.  
  96.                            Installation
  97.                            ------------
  98.  
  99.          1. Decompress the DataPage archive into a new directory; ie.
  100.             C:\DOORS\DATAPAGE
  101.  
  102.          2. Run SETUP.EXE to set miscellaneous options.
  103.  
  104.          3. Edit the DOOR.CTL file with an ASCII text editor to set
  105.              BBS options.  The file is well documented.
  106.  
  107.          4. Edit the DIRLIST.TXT file to set directories for users to use.
  108.              Think of them as categories.  Include NO slashes, backslashes,
  109.              etc in the file, just one directory per line, up to 20
  110.              directories.  Make sure the directories exist as subdirectories
  111.              of DataPage.
  112.              ie. the file could be just:
  113.              SAMPLE
  114.              EXAMPLE
  115.  
  116.              and you could have a C:\DATAPAGE\SAMPLE and C:\DATAPAGE\EXAMPLE
  117.              directory to go with them.
  118.  
  119.          5. Run DATAPAGE.EXE /L to initialize the user data file.
  120.  
  121.          6. Run USEREDIT.EXE to set the new user defaults.
  122.  
  123.          7. Set it up on your BBS.  The commandline should be something
  124.             resembling:
  125.             DP /PC:\BBS /N1
  126.             (where c:\bbs is the location of the dropfile and /N1 is the
  127.              node number, ie node 2 would be /N2)
  128.  
  129.              NOTE: This door is *NOT* yet multinode.  It will work with
  130.                    multiple concurrent users, but only one node may transfer
  131.                    files (always node 1, or 2, etc... depending on what
  132.                    comport you set in SETUP.EXE)
  133.  
  134.         8. In order to run the game program online the following
  135.            parameters may be used.
  136.  
  137.         "/Bxxxxx"   This tells DataPage to lock its baud rate at
  138.         xxxxx.  In order to get the most efficiency out of a high speed
  139.         error correcting modem (9600 baud or above), you may lock the baud
  140.         rate to a speed higher than what the caller is actually using.
  141.         By locking the baud to say 38,400, the modem can compress text data
  142.         that is being sent and achieve a baud rate much higher than the
  143.         actual transmission rate.
  144.         This will lock the baud rate at the same value for all nodes that
  145.         use this command line.  If you perfer a more selective way to lock
  146.         baud use 'LOCKBAUD' command in the DOOR.CTL file.
  147.  
  148.         "/Cx"     (where x is 1..4) This specifies a comport number.
  149.         Some bbs software does not create door information files (dropfiles)
  150.         that contain the comport number.  If your bbs does have a comport
  151.         listed in the dropfile then there is no need for this parameter.
  152.         The default is comport 0, local mode.
  153.  
  154.         "/E" - Expanded Memory Specification If your machine has over one
  155.         megabyte of memory, then you may have some available.  DataPage can
  156.         utilize EMS to improve game performance and reduce conventional
  157.         memory requirements.
  158.         This command will tell DataPage to use EMS memory to hold its
  159.         overlay buffer.  Otherwise disc area may be used to hold this buffer.
  160.         This needs a memory manager and when enabled and is compatible with
  161.         DESQview. Default is NOT to use available EMS.
  162.  
  163.         "/L"      This tells DataPage to load up in LOCAL mode.
  164.         This is good for testing or when a sysop just wants to "try out" the
  165.         door without messing with his BBS setup.  The "/L" mode will ask the
  166.         user for his name and run the door in local mode.
  167.  
  168.         "/Nx"     (where x is 1..9) This specifies a "node number".
  169.         Some bbs software support multinode environments in which you must
  170.         know the node number of the drop file to use. For example, RBBS-PC
  171.         uses DORINFOx.DEF. If you specified "/N2" then DataPage would use
  172.         DORINFO2.DEF.
  173.  
  174.         "/Mx"     (where x is up to 2 filename acceptable characters)
  175.         Used to specify one of Multiple control files.  If you have created
  176.         more than one DOOR.CTL file (DOOR1.CTL, DOOR2.CTL, etc.) for each
  177.         node or network PC then you can select the one you want by using
  178.         the /M parm.
  179.         Example:  "/M2" will force DataPage to use door2.ctl.
  180.  
  181.         "/Pyyy"   This specifies the path to the drop files.
  182.         For example, "/PC:\BBS" would tell DataPage to
  183.         look for the drop file in C:\BBS. If this is left
  184.         out the program assumes the drop file is in the current
  185.         directory.
  186.  
  187.         "/R" To force local RIP for the sysop. Used only if the program
  188.         has RipLink built in and the door supports RIP.  Use AFTER the
  189.         /L parameter if you are using the door in local mode.
  190.         
  191.         "/V"    This command will tell DataPage not to show any display
  192.         on the local screen.  Only a colored screen and a message will be
  193.         displayed.  The cursor will not move as it will be turned off.
  194.         Saves a little processing on multi-tasking systems.
  195.  
  196.         "/W"      This flags the program that a network is present even
  197.         though no multitaskers are detected.  This is useful if the door is
  198.         run on a network such as Novell that doesn't use multitaskers.
  199.  
  200.  
  201.             COMMON ERRORS
  202.             003  File path not found. Check to make sure the game
  203.                  directory is correctly named as GAMEDIR.
  204.             201  Files not found. Check to make sure that all required
  205.                  games files are in the GAMEDIR directory.
  206.  
  207.                             Sample Batch File
  208.                             -----------------
  209.            
  210.                  CD \DOORS\DATAPAGE
  211.                  DATAPAGE /PC:\SBBS\NODEx <-=- NODE number !!DO NOT USE "x"!!
  212.                  CD \SBBS\NODEx
  213.  
  214.             -->  Please note that you replace the "x" with the appropriate
  215.                  node number. Ex: Dorinfo1.def ; Dorinfo2.def ; etc...
  216.  
  217.                      RESTRICTIONS ON THE UNREGISTERED GAME
  218.                      -------------------------------------
  219.         Until the door is registered the following restrictions are
  220.         in effect:
  221.  
  222.             a.  There will be a slight delay experienced by users at the
  223.             beginning of the game.
  224.  
  225.             b.  You cannot let a user have more than 256 kb total for their
  226.             DataPage directory space.
  227.             
  228.             c.  Once you are registered any future updates can be obtained
  229.             free through my BBS and my upgrades are ALWAYS easy to
  230.             implement!
  231.  
  232.                          WHAT TO DO IF THERE ARE PROBLEMS
  233.                          --------------------------------
  234.  
  235.         Every effort is made to ensure that the door runs correctly
  236.         before it leaves my BBS as Shareware.  If you are experiencing
  237.         problems please do the following BEFORE calling me:
  238.  
  239.         1.  Read ALL the SYSOP.DOC to ensure you have setup the program
  240.             and have met all the program requirements.
  241.  
  242.         2.  Use the B4UASK.DOC as a checklist to ensure that you have
  243.             not done anything wrong.
  244.  
  245.  
  246.                                   Multinode use
  247.                                   -------------
  248.                    This door is *NOT* yet multinode.  It will work with
  249.                    multiple concurrent users, but only one node may transfer
  250.                    files (always node 1, or 2, etc... depending on what
  251.                    comport you set in SETUP.EXE)
  252.  
  253.                Common Problems (Locked Bauds, High Speed modems, etc)
  254.                ------------------------------------------------------
  255.  
  256.         1.   The door does NOT require a fossil driver to run.
  257.  
  258.         2.   If you are running a high speed modem (9600 baud or above),
  259.              then I suggest you run your bbs/mailer/doors at a locked baud
  260.              rate. On high speed error correcting modems, locking the baud
  261.              rate will have a noticeable increase on the speed of text that
  262.              is sent. It's beyond the scope of this document to discuss
  263.              configuring your BBS and mailer for a locked baud rate; you may
  264.              wish to consult those docs for information on that. Here are a
  265.              few things to keep in mind when setting up DataPage with a locked
  266.              baud rate:
  267.  
  268.              a.  When using a locked baud rate, I highly recommend
  269.                  using a  FOSSIL driver. This door will work at high
  270.                  speeds without one though. BNU is a good fossil driver
  271.                  which can even be loaded and unloaded before and after
  272.                  you run this game.
  273.  
  274.              b.  If you are using a fossil, then make sure to tell the
  275.                  fossil that the port is locked. For BNU, to lock com1:
  276.                  at 38,400, you would use something like "L0=38400" on
  277.                  BNU's command line.
  278.  
  279.              c.  If you lock the baud for one program, it must be
  280.                  locked for everything. You can't lock the baud for just
  281.                  this door, but not your BBS/mailer.
  282.  
  283.              d.  You may need to use the /B switch on the datapage.exe
  284.                  Command line to specify the locked baud rate. For
  285.                  19,200 this would be "/B19200" and for 38,400 this
  286.                  would be "/B38400". Please note there is no space
  287.                  between the "/B" and the baud rate.
  288.  
  289.         3.   What follows is some information on possible strange
  290.              situations that may occur:
  291.  
  292.              a.  Low speed users can use the door, but high speed
  293.                  users get garbage.
  294.      
  295.                  - If you are not using the DORINFOx.DEF or
  296.                    DOOR.SYS drop file then you may wish to find a
  297.                    converter program to convert whatever drop file
  298.                    your BBS produces to the DORINFOx.DEF or DOOR.SYS
  299.                    format and tell datapage.exe to use that.
  300.  
  301.                    Several converter programs are readily available
  302.                    on most BBS systems. CallDoor is a good one if you
  303.                    can find it. I have it on my BBS for download if
  304.                    you need it.
  305.  
  306.              b.  DataPage hangs up when a user enters the door.
  307.  
  308.                  - Sounds like the door is getting the wrong baud
  309.                    rate somehow. Try switching over to the DOOR.SYS
  310.                    drop file method if possible.
  311.  
  312.              c.  Text and screens are getting cut off.
  313.  
  314.                  - If you are running with a locked baud, then this
  315.                    could be caused by some sort of FLOW CONTROL
  316.                    problem. Try using a fossil if you aren't already.
  317.  
  318.              d.  If you're using something other than the DOOR.SYS
  319.                  drop file, then I always suggest trying to use
  320.                  DOOR.SYS if possible. It is the most reliable method
  321.                  and has had the most testing. If that is not possible
  322.                  try DORINFOx.DEF as an alternative.
  323.  
  324.              e.  A door locks up node 1.  This can happen with fossils
  325.                  or the internal communications routines because it
  326.                  uses the default comport of 1 when NONE is found in
  327.                  the dropfile or door.ctl file. To correct this make
  328.                  sure the right port is shown in the dropfile OR
  329.                  door.ctl file.
  330.  
  331.              f.  ANSI is reflected correctly on the local screen but
  332.                  the user is getting garbage.  Assuming the user has
  333.                  ANSI installed then most likely the problem is at
  334.                  your end. First make sure you have configured the 
  335.                  door.ctl file to show the correct locked port rate.
  336.                  Second make sure the dropfile is passing the locked
  337.                  port rate INSTEAD of the actual conncet rate.  If it
  338.                  is not passing the locked port rate then you may
  339.                  need to use a different dropfile format OR use a
  340.                  dropfile converter program to change the line to
  341.                  show the locked port rate INSTEAD of the actual
  342.                  connect rate.
  343.  
  344.                             "Corrupted" data files
  345.                              ----------------------
  346.         It is possible that something could happen to your door
  347.         data file.  A power outage, door crash, or other event could
  348.         damage the data  files.  If you get  one of these messages,
  349.         then the best thing to do is reinstall.
  350.                     
  351.                                  CREDITS:
  352.                                  --------
  353.         This relatively small section is just to recognize the
  354.         GOOD people  who have made this door a possibility.
  355.  
  356.         The DDPlus Team - Thanks to Scott Baker, Steve Lorenz,
  357.                           Bob Dalton, Andy Stewart, Tom Morgan
  358.                           and other contributors for that great
  359.                           turbo pascal door kit.  If you ever
  360.                           want to make a door product for use
  361.                           with BBS's then this is the kit to get!
  362.         
  363.         DESQview is a registered trademark of Quarterdeck Office Systems.
  364.         Doordriver kit is proprietary software by Scott Baker.
  365.         Ripscript & Ripterm are registered trademarks of TeleGrafix
  366.         Communications.
  367.  
  368.                                Where to reach me
  369.                                -----------------
  370.  
  371.         I can usually be reached at my BBS system, which should be
  372.         listed in the section entitled "registration" which is below.
  373.         I can also be reached via e-mail.
  374.  
  375.                                   Registration
  376.                                   ------------
  377.         If you or your users enjoy this door, then please register it.
  378.         Information on price and how to register is shown on the
  379.         enclosed REGISTER.FRM.  Registration will disable the delay,
  380.         allow additional options and entitle you to life time support
  381.         through my BBS.  BBS Support includes unlimited free updates
  382.         and upgrades (not like some door door authors who charge for
  383.         major upgrades/updates!) through my BBS.  To register this game
  384.         just print out the registration form (REGISTER.FRM) file included
  385.         with the door and send it with your check or money order to:
  386.                     
  387.                         Michael R. Burke
  388.                         81 Walthen Drive
  389.                         Charlottetown, PE
  390.                         C1A 4T7
  391.                         Canada
  392.  
  393.                   More information is in the register.frm file.
  394.  
  395.  
  396.                            HOW TO REACH ME BY MODEM
  397.                            ---------------------------
  398.  
  399.                                  The Realm (Canada)
  400.                       (902) 892-3395  (2400 to 14400 baud)
  401.                                Fidonet 1:255/304
  402.                          email: mburkepei@hotmail.com
  403.  
  404.         Reminder: You will be mailed a LETTER with your registration
  405.         code.  Just allow an appropriate amount of time (a week or two)
  406.         after dropping your check in the mail for it to arrive to me
  407.         and the code to be sent by mail back to you.  If you need it
  408.         sooner log onto my BBS, leave me a message telling me you
  409.         mailed the registration and when I receive your check or money
  410.         order I will post a private message on the BBS giving you the
  411.         key code.  If you do it this way please allow at least a week
  412.         from the time you mail it to the time you call and get your
  413.         code. If you go the BBS route you may or may not receive a key code
  414.         by mail.  If you prefer you can ask for the codes via email.
  415.         REMINDER: No disks are sent, if you need
  416.         the most current version you must call OR freq my BBS for it.
  417.  
  418.                         Bug Reports/Comments/Suggestions
  419.                         --------------------------------
  420.         I have made every attempt to make sure the game is free of bugs,
  421.         BUT the possibility always exists that one may have been missed
  422.         by me or the playtesters.  If you find a bug, or have a
  423.         suggestion or comment to make which would make future versions
  424.         better please print out the BUGRPT.FRM and mailer, fill it out,
  425.         and send it to me.  I read ALL of them and those people that
  426.         lead me to find a bug or generate a better game will receive
  427.         credit in the game documentation. PLEASE DO NOT NOTIFY ME OF
  428.         PROBLEMS AND EXPECT ME TO FIX THEM IF YOU HAVE FAILED TO
  429.         PROVIDE ME WITH THE BUGRPT.FRM AND OTHER INFORMATION I REQUIRE
  430.         AS STATED IN THE B4UASK.DOC.
  431.  
  432.                                         Thank you for scanning or
  433.                                         reading this documentation.
  434.                                         Michael Burke, Author.
  435.