home *** CD-ROM | disk | FTP | other *** search
/ Piper's Pit BBS/FTP: ibm 0000 - 0009 / ibm0000-0009 / ibm0003.tar / ibm0003 / ROVER.ZIP / ROVER.DOC < prev    next >
Encoding:
Text File  |  1990-01-10  |  42.9 KB  |  1,209 lines

  1.  
  2.                      rOverBoard BBS Software  - Version 1.8 (beta)
  3.                    Copyright (C) 1987 - 1989  FreeLance Programming
  4.                                  All rights reserved
  5.  
  6.  
  7.      FreeLance Programming  /  PO Box 726  /  Washington DC 20044-0726
  8.      The Wizard's Workshop  /  3013228678  /  300/1200/2400 - 24 hours
  9.  
  10.  
  11.      Table of Contents                                           Page #
  12.      -----------------                                           ---------
  13.      About rOverBoard                                               i
  14.      Hardware Requirements/Features                                 1
  15.      Reporting Problems/Making Suggestions                          1
  16.      Command Line Switches                                          2
  17.      rOverBoard .SCReen files                                       4
  18.      Other rOverBoard related/created files                         5
  19.      "Questionnaire" Screens (REGISTER.SCR, SURVEY.SCR)             6
  20.      The Bulletin Menu                                              7
  21.      File Listings (BBSFILES.DAT)                                   8
  22.      User Access control ("Access Masks")                           9
  23.      Message Areas: Types and Restrictions                         10
  24.      Installation and setup                                        11
  25.      Modem Initialization Strings                                  12
  26.      rOver's keyboard                                              13
  27.      Multi-tasking considerations                                  14
  28.      Misc. Notes                                                   15
  29.      ANSI & ASCII support                                          15
  30.      rOver's credit system; what it is and how it works            16
  31.      Events: Meaning and Usage                                     ??
  32.      Using Door programs with rOverBoard                           ??
  33.      Misc. Notes                                                   17
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.                               rOverBoard BBS Software
  69.                                    Version 1.8
  70.                                         i
  71.  
  72.   rOverBoard is a user-supported software product from FreeLance Programming.
  73.   It is currently in a late beta-test phase; mostly due to a few uncompleted
  74.   features (like the docs).  There are no known bugs outstanding at the time
  75.   of this release.  Of course, this in no way means there aren't any.  rOver's
  76.   earlier beta versions have been running since November, '87, and the code is
  77.   fairly solid.  I am not requesting donations for this version; however, if
  78.   you wish to send $5 to encourage me to continue, you will receive a) more
  79.   rapid help on questions, and b) a discount on the first production version.
  80.   Suggestions for improvements are are ALWAYS welcome.  I can be contacted (as
  81.   Sysop) on:
  82.  
  83.                               The Wizard's Workshop
  84.                                  (301)-322-8678 (free; new users ok)
  85.                                  (301)-322-2115 ($$$; no new users; MNP!)
  86.                                   3/12/24 24hrs
  87.  
  88.   To save long distance charges, or even maybe to help feed a poor, starving
  89.   programmer, snail mail can be sent to the following address.  Please make
  90.   checks (if any) payable to FreeLance Programming.  That address is:
  91.  
  92.                               FreeLance Programming
  93.                                    P O Box 726
  94.                             Washington DC 20044-0726
  95.  
  96.   If you find any bugs, or have suggestions, please contact me either on-line
  97.   or by mail.  The lastest version of rOverBoard will, of course, always be
  98.   available on The Wizard's Workshop.
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.                               rOverBoard BBS Software
  135.                                    Version 1.8
  136.                                        - 1 -
  137.  
  138. rOverBoard requires an IBM Pc/compatible with 384k minimum (640k recommended).
  139. Although the software will run on a two-floppy machine, a hard disk is strongly
  140. recommended.  Modem support is currently limited to Hayes compatibles.  Some of
  141. rOver's major features include:
  142.  
  143.      - Support for 2 modems (up to 38.4k baud) plus a "local" BBS window
  144.        where the sysop can be logged on simultaneously with callers.
  145.  
  146.      - Complete maintenance capabilities while the board is running, including
  147.        shell to Dos, change setup/users/events/etc., upgrade new users.
  148.  
  149.      - Will run invisibly in the background; all DOS access is multitasked
  150.        (this feature requires Dos 3.x+ and a true compatible).
  151.  
  152.      - A space conservative design that uses fewer files and less disk space.
  153.  
  154.      - Speed!  rOver uses in-memory hash tables for superior response times.
  155.  
  156.      - Up to 32 message and 32 file areas.
  157.  
  158.      - Positive verification security; easy to change priviledges at the user
  159.        or at the group level.  Almost 300 individual access control switches,
  160.        with 10 easily assignable pre-defined "masks" to ease global changes.
  161.  
  162.      - Multi-layered menus adjustable to the users' experience level.
  163.  
  164.      - Many file transfer protocols, including Ascii, X, Y, and Zmodem.
  165.  
  166.      - Transparent 'command stacking'; reponses to several sequential prompts
  167.        may be concatenated on a single line, causing the appropriate prompts to
  168.        be skipped (examples: D;Z;ROVER.ZIP, MA0RY, SVBM, FN?).  Help system
  169.        displays include allowable concatenation syntax.
  170.  
  171.      - The ability to work with .ZIP files.
  172.  
  173.      - The ability to re-edit previously S)aved messages.
  174.  
  175.      - Automatic message deletion based on configurable time period (by area).
  176.  
  177.      - Automatic user deletion based on configurable time period(s).
  178.  
  179.      - "Notify" messages (to ALL or given user) auto-displayed at log-on time.
  180.  
  181.      - Intelligent welcome/bulletin screens that are displayed at logon only if
  182.        they have changed since the user last logged on.
  183.  
  184.      - The ability to invisibly prevent unwanted files from being uploaded.
  185.  
  186.      - Full path support; files need not be in their 'default' directory.
  187.        Authorized users can access ANY file on the machine.
  188.  
  189.      - A full array of statistics at both the board and user levels.
  190.  
  191.      - Much, much, more...
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.                               rOverBoard BBS Software
  201.                                    Version 1.8
  202.                                        - 2 -
  203.  
  204.    Usage:
  205.  
  206.      ROVER.EXE /1[p] /2[p] /M[+/-] /P /R /F /S /L /N /U# /D# /V /Z /A
  207.  
  208.    All command line switches are optional.
  209.  
  210.    /1[p] - /2[p] :  Activate Ports 1 & 2 (respectively)
  211.  
  212.      'p' is of the form: [#} [!] [+ | - | *], where:
  213.  
  214.      # = Modem init speed (1=300 [default], 2=1200, 3=2400, ..., 7=38400)
  215.      - = Prevents 300 (300/1200, if '!' used) baud downloads (on that line)
  216.      + = Prevents 300 (300/1200, if '!' used) baud callers (on that line)
  217.      * = Indicates a hard-wired (null- or no- modem) connection.  This option
  218.          disables baud-rate checking and prevents DTR from cycling when a user
  219.          logs off.  The specified init speed will be used as the baud rate.
  220.  
  221.    /M[+/-] :  Mail Checking
  222.  
  223.      By default, rOver gives callers the opportunity to check for their new
  224.      mail when they log on.  This switch functions as follows:
  225.  
  226.      /M  : Same as the default; the user is prompted for a y/n response
  227.      /M- : The prompt is not displayed, and the mail check is NEVER done
  228.      /M+ : The prompt is not displayed, and the mail check is ALWAYS done
  229.            (When using this option, ^k/^c will NOT interrupt the search.)
  230.  
  231.    /P :  Private Board
  232.  
  233.      When this switch is used, new users are not allowed to log-on.  Instead,
  234.      they are shown the registration questionnaire (REGISTER.SCR), if any, and
  235.      are then immediately logged off.  Be aware that if the user calls back,
  236.      he/she will no longer be considered new, and WILL be allowed to log on.
  237.      Be sure that you have set up your access masks as appropriate!  To make
  238.      the board totally private, use /U1 and/or /U2 as appropriate.
  239.  
  240.    /F, /S :  Flicker Control
  241.  
  242.      rOver uses direct screen writes, which can cause "snow" on CGA monitors.
  243.      These two switches eliminate such snow.  Use of either switch will cause
  244.      increased screen draw times.  The switches function as follows:
  245.  
  246.      /F - Eradicates snow on *most* writes.  Screen swaps may still snow.
  247.      /S - Eradicates ALL snow.  You need not use /F if using this switch.
  248.  
  249.    /L :  Log File Control
  250.  
  251.      By default, rOver creates/appends BBSLOG.DAT, a file which contains
  252.      a configurable set of information about system and user activity.  Use
  253.      of the /L switch suppresses this feature.
  254.  
  255.    /N : Upload Log File Control
  256.  
  257.      By default, rOver also creates/appends UPLOADS.DAT, a file containing
  258.      whodunnit info for uploaded files.  The /N switch suppresses this feature.
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.                               rOverBoard BBS Software
  267.                                    Version 1.8
  268.                                        - 3 -
  269.  
  270.    /U# - /D# :  Line Control
  271.  
  272.      Where # specifies a port # (1 or 2).  To apply the condition to both
  273.      ports, specify the switch twice (eg. "rOver /U1 /U2").
  274.  
  275.      /U - Callers must have "Can Use Line #" = Y to logon (to that port)
  276.      /D - Callers must have "Can Use Line #" = Y to d/l (while on that port)
  277.  
  278.    /Z :  Multi-tasking
  279.  
  280.      When this switch is used, all access to Dos (via F1 - Dos Commands) is
  281.      done while rOver continues to run in the background.  This feature
  282.      requires that you be using Dos 3.x or above, and imposes further hardware
  283.      compatibility requirements on your machine.  This feature is invaluable
  284.      for getting work done on machines running 24hr boards, and has fewer
  285.      compatibility problems that running a multi-tasker and multiple copies
  286.      of the bbs software.  NOTE:  See the section on multi-tasking!
  287.  
  288.    /V :  Visual Indicator
  289.  
  290.      While in Dos when using the /Z switch, it can be nice to know that the
  291.      board really *is* still running in the background.  This switch will
  292.      blink a character at you (while in text modes only) to assure you that
  293.      things are still running.  If this character stops appearing, the board
  294.      is NOT running.  Heavy disk i/o (*especially* to floppies) can briefly
  295.      have this affect.
  296.  
  297.    /A : Allow Doors
  298.  
  299.      This switch causes rOver to be started in so-called "single-image" mode.
  300.      For more information regarding board modes and the use of doors, see the
  301.      documentation on doors.
  302.  
  303.    /K : Disable Ansi Color Displays
  304.  
  305.      This switch prevents ANSI colors from being displayed on the local
  306.      monitor, while still allowing the remote user to see them.
  307.  
  308.  
  309. Note that many switches may alternately be controlled via system events or
  310. the "active settings" screen (F10 from the Main Menu).  If any events of
  311. a particular type *are* scheduled in the event table, command line switches
  312. for that feature are ignored, and the event table controls.
  313.  
  314. The use of a .BAT file to start rOver is *strongly* recommended, both to avoid
  315. having to remember all these switches as well as to trap various return codes.
  316. The RUN.BAT file included in ROVER.ZIP is provided as an example of such.
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.                               rOverBoard BBS Software
  333.                                    Version 1.8
  334.                                        - 4 -
  335.  
  336. rOver displays a variety of screens when a user logs on, as appropriate.  All
  337. screens are standard ASCII text files, with optional embedded ANSI color info
  338. (see the section on ANSI support for more info).  Screens selected from the
  339. MAIN Menu (the 'W', 'B', or 'H' commands) may be aborted (via ^k or ^c); this
  340. is _not_ true of screens that are auto-displayed by rOver.  In general, and
  341. with the exception of WELCOME1, rOver will not show screens to any user who
  342. has already seen them, unless requested via the MAIN Menu.  This can be
  343. changed by setting the file date of the .SCR file to a far future date, in
  344. which case rOver will think it is _always_ new for any user.
  345.  
  346. WELCOME1.SCR - This is the opening banner; displayed just after the ASCII and
  347.                ANSI support prompts.  It, like all .SCR files, is optional.
  348.  
  349. WELCOME2.SCR - This is the 'welcome screen', displayed after the "last called"
  350.                message, or when selected from the MAIN Menu via the W)elcome
  351.                command.  If this screen is not present at system start-up, the
  352.                W)elcome command will be disabled.
  353.  
  354. BULLETIN.SCR - This screen functions either as a single bulletin (ala the
  355.                welcome screen) or as a menu of available bulletins.  It is
  356.                displayed after the W)elcome screen, or when selected via the
  357.                B)ulletin command (also disabled if no BULLETIN.SCR at startup
  358.                time).  See the section on the BULLETIN Menu for more info.
  359.  
  360. BULLET??.SCR - Where ?? can be 1 - 99.  When BULLETIN.SCR is used as a menu of
  361.                available bulletins, these files make up the individual bullets.
  362.                See the section on the BULLETIN Menu for more information.
  363.  
  364. HINTS.SCR    - This screen is only displayed in response to the H)ints command
  365.                on the MAIN Menu.  If it is not present at system start-up, the
  366.                H)ints command will be disabled.
  367.  
  368. NEWUSER.SCR  - This special screen is only displayed for new callers.  It is
  369.                displayed immediately after the initial user setup prompts, and
  370.                just prior to REGISTER.SCR (if applicable).
  371.  
  372. LOGOFF.SCR   - This optional screen is sent immediately prior to the "Logging
  373.                xxxxx OFF" message that preceeds disconnect.
  374.  
  375. REGISTER.SCR - This is a 'questionnaire' screen which may contain prompts for
  376.                user input.  See the section on qustionnaires for information
  377.                on the contents of this screen.  The presence or absence of this
  378.                screen controls new-user access, as follows:  If this screen is
  379.                is not present, or the user successfully completes it, the user
  380.                is assigned default access mask #1.  If it is present, and the
  381.                users does NOT complete it, he/she is assigned default access
  382.                mask #10.
  383.  
  384. SURVEY.SCR   - This is also a 'questionnaire' screen, using the same commands
  385.                as the above screen.  It is displayed only in response to the
  386.                A)nswer-Survey command on the MAIN Menu, and omission of the
  387.                screen will disable that command.
  388.  
  389. NOUSEx.SCR   - These screens work in combination with the /Ux switch(es).  If
  390.                a new or unauthorized user attempts to log onto a restricted
  391.                node, the appropriate NOUSEx.SCR will be displayed, and the
  392.                user will then be logged off.  Use NOUSE1.SCR for Node 1, and
  393.                NOUSE2.SCR for Node 2, as desired.  Note that if the line is
  394.                not restricted, these screens are not displayed.
  395.  
  396.  
  397.  
  398.                               rOverBoard BBS Software
  399.                                    Version 1.8
  400.                                        - 5 -
  401.  
  402. In addition to the .SCR files listed above, rOver uses and/or creates various
  403. files, as described below.  Except where otherwise noted, all files must be in
  404. the default directory when the system is started.
  405.  
  406. SETUP.DAT    - This file contains all configuration and statistical info
  407.                for the entire board.  It is REQUIRED for use of rOver OR the
  408.                maintenance utility.  This is NOT a text file.
  409.  
  410. BBSFILES.DAT - This is the text file containing the entries for ALL files in
  411.                ALL areas.  See the section on file listings and the included
  412.                sample file for more information about this file.
  413.  
  414. BBSFILES.IDX - This is a quick-access index to BBSFILES.DAT that contains
  415.                name/date/size information for each file.  It is automatically
  416.                rebuilt whenever the BBSFILES.DAT file is edited, or when the
  417.                /X switch is used.  It is NOT a text file.
  418.  
  419. USER.DAT     - This is the user file.  If it does not exist, it will be
  420.                created at start-up time.  This is NOT a text file.
  421.  
  422. BBSLOG.DAT   - This is the system log of all activity (except that suppressed
  423.                via the log-level feature).  It is created/appended to unless
  424.                the /L log-suppress switch is used.
  425.  
  426. UPLOADS.DAT  - This is the system log of all upload activity, separated for
  427.                convenience.  It can be suppressed by using the /N switch.
  428.  
  429. REGISTER.DAT - This file contains user answers in response to REGISTER.SCR.
  430.                If REGISTER.SCR exists, this file is created/appended to, as
  431.                well as REGISTER.IDX (which is also rebuilt by the /X switch).
  432.  
  433. APPROVED.DAT - As users are upgraded, their answer sets are 'deleted' from
  434.                REGISTER.DAT, and transferred to APPROVED.DAT.  The maintenance
  435.                utility will then remove the 'deleted' sets from REGISTER.DAT.
  436.  
  437. SURVEY.DAT   - This file contains user answers in response to SURVEY.SCR.
  438.                It file is created/appended to, if SURVEY.SCR exists.
  439.  
  440. MSG##.DAT
  441. MSG##.IDX    - Where ## is a two-digit, zero-filled message area number.  One
  442.                of each of these files is used for each message area, and will
  443.                be created if ncessary.  These files must be in the sub-dir
  444.                specified as the "Mail Path" in the setup options (F8 - Misc.
  445.                Maint).  This sub-directory must be created prior to running
  446.                rOver.  (The default sub-dir in the distributed SETUP.DAT is
  447.                always the current dir - ie., ".\".)
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.                               rOverBoard BBS Software
  465.                                    Version 1.8
  466.                                        - 6 -
  467.  
  468. Questionnaire Screens:
  469.  
  470.  
  471.   Questionnaire screens (REGISTER.SCR and SURVEY.SCR) are formatted text files
  472. that implement a mini-script language.  The 1st char of every line is either a
  473. space or the start of a 'command'.  The line (minus the 1st char) is always
  474. displayed before the action of the command (if any), except in the case of
  475. comments.  rOver currently accepts the following commands:
  476.  
  477.  
  478. ? : Prompts the user for [Y,n] input.  If the user answers N, the screen is
  479.     aborted.  In the case of REGISTER.SCR, the user is then assigned access
  480.     mask #9.
  481.  
  482.  
  483. @ : This character in column 1 causes the user's name to be affixed to the
  484.     output answer set.  If using the built-in upgrade facilities in conjunction
  485.     with REGISTER.SCR, this command *must* appear in the questionnaire.
  486.  
  487.  
  488. ! : Prompts for up to 40 chars of input.  If the text following this command
  489.     exceeds the width of the user's screen - 40, a <cr> is generated, and the
  490.     input prompt moved to the next line.
  491.  
  492.  
  493. #x : Essentially the same as the ! input prompt, except that input always
  494.      starts on a new line, and up to x lines of input are allowed.  The first
  495.      blank line ends the prompting.  x is required, and must be from 1 to 7.
  496.  
  497.  
  498. For more information about questionnaire screens, see the sample REGISTER.SCR
  499. and/or SURVEY.DAT screens in the distribution package.  You may wish to
  500. experiment with these screens until you are happy with the results.
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.                               rOverBoard BBS Software
  531.                                    Version 1.8
  532.                                        - 7 -
  533.  
  534. The Bulletin Menu :
  535.  
  536.  
  537.    rOverBoard offers three approaches to bulletins, as follows:
  538.  
  539. - Option #1: No BULLETIN.SCR at system start-up
  540.  
  541.    If this file is not found during system start-up, rOver runs sans bulletin.
  542. Nothing is displayed in its "place" in the user logon sequence, and the
  543. B)ulletin-Menu command (from the MAIN Menu) is disabled.
  544.  
  545. - Option #2: Num bulletins = 0
  546.  
  547.    One of the fields on the F8 Maintenance screen is #-bulletins.  If this
  548. field is non-zero, rOver uses option #3 (below).  Otherwise, rOver treats
  549. the bulletin screen exactly like the welcome screen.  It is displayed during
  550. the logon process, just after the welcome screen (if it has been modified
  551. since the user's last call, or this is a new user), and can be re-displayed
  552. via the B)ulletin-Menu command.
  553.  
  554. - Option #3 - Num bulletins > 0
  555.  
  556.    When the #-bulletins has been set to a non-zero value, rOver assumes that
  557. BULLETIN.SCR is a menu of available bulletins, from 1 - #-bulletins.  Each
  558. of these "sub-bulletins" is stored in a separate text file named BULLET??.SCR
  559. where ?? is the number of the bulletin (ie., BULLET1.SCR, etc.).  The maximum
  560. number of such sub-bulletins that may be specified is 99.  After the main
  561. BULLETIN.SCR is displayed, rOver displays the BULLETin Menu, rather than
  562. continuing, as in option #2 (above).
  563.  
  564.    When using sub-bulletins, the date that is checked to determine whether or
  565. not to display the bulletin when the user logs on is the MOST RECENT date of
  566. any of the BULLET?.SCR or BULLETIN.SCR files.
  567.  
  568.    An example of the use of sub-bulletins might be as follows:
  569.  
  570. File:            Contents:
  571.  
  572. BULLETIN.SCR:            Bulletin Menu:
  573.                  This is the list of available bulletins
  574.                  you can read -   #1: How to get access
  575.                                   #2: Why use Zmodem
  576.  
  577. BULLET1.SCR:           How to get Access
  578.                  Here you could list your access requirements
  579.  
  580. BULLET2.SCR:               Zmodem!
  581.                  Zmodem is a better protocol because ...
  582.  
  583.  
  584.    I encourage you to experiment with these screens to gain a better under-
  585. standing of how they operate.  They are much simpler to use than to describe.
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.                               rOverBoard BBS Software
  597.                                    Version 1.8
  598.                                        - 8 -
  599.  
  600. File Listings:
  601.  
  602.  
  603.    All file entries and descriptions are kept in BBSFILES.DAT.  Each line in
  604. this file must be in one of the following formats.  Any line that does not
  605. match one of these formats will be ignored.
  606.  
  607.  
  608. Valid Line Formats:
  609.  
  610. xx FILENAME MM/DD/YY XXXXX Uploader;Description
  611. xx  Informational Message
  612.  
  613. Where: xx       = A valid area # (00 - 31); both digits required
  614.        FILENAME = The name of the file ([d:][path\]name.ext)
  615.        MM/DD/YY = The date the file was originally uploaded
  616.        XXXXX    = The # of times the file has been d/l'ed (max = 65535)
  617.        Uploader = The alias of the person uploading the file
  618.        Description = The description of the file
  619.  
  620.  
  621. The area # must be followed by a single space for file entries or a double
  622. space for informational messages.  Informational messages are comments that
  623. appear interspersed with the files in the L)ist-Files display; they are
  624. otherwise invisible.  The file name must be followed by a single space.  The
  625. Uploader and Description fields *must* be separated by a single semi-colon.
  626. Uploader and Description are the only optional fields; even if they are
  627. missing the semi-colon is still required.  The #_times downloaded field *must*
  628. be a 5-digit number, with leading zeroes.  If the upload date is 01/01/80, the
  629. actual file date will be used for N)ew-Files checking, rather than the date of
  630. the upload.  The upload date _must_ be in MM/DD/YY format.
  631.  
  632.  
  633. Each file area has a default drive/directory used to locate the files that are
  634. listed in that area.  If the entry in BBSFILES contains drive and/or dir info,
  635. this default is ignored.  Such "extended" entries must be FULLY qualified.
  636. This is all transparent to the user, who sees only the base name/extension.
  637.  
  638.  
  639. Special file areas:
  640.  
  641.   Area 0:  In the event that a user has U)pload access, but does not have
  642.            access to ANY areas where uploads are acceptable (Uploads Ok = Y)
  643.            any files the user uploads will be placed in area 0.  If no path
  644.            is specified for area 0 when this happens, the file will be placed
  645.            in the default dir (normally rOver's startup directory).
  646.  
  647.   Area 31: Entries in this area do NOT correspond to real files; they are
  648.            dummy entries present only to prevent files with these names from
  649.            being uploaded.  Area 31 (which does NOT have to be defined as a
  650.            valid file area) is a place for the names of files you neither have
  651.            nor want.  Also note that the user need not have access to area 31.
  652.            rOver will not allow ANY filename that is already in BBSFILES.DAT
  653.            to be uploaded, regardless of the user's access.
  654.  
  655. When adding file areas, note that any files that were already in BBSFILES.DAT
  656. for that area will _not_ be "found" until after such time as BBSMAINT is run
  657. to rebuild the BBSFILES.IDX file.  Files P)ost'ed to new areas, however, will
  658. be accessible immediately.
  659.  
  660.  
  661.  
  662.                               rOverBoard BBS Software
  663.                                    Version 1.8
  664.                                        - 9 -
  665.  
  666. File Listings: (cont)
  667.  
  668.  
  669. A sample BBSFILES.DAT is included in the distribution package.  Using this as
  670. a base, create a small BBSFILES.DAT file of your own, then use rOver to view
  671. the results.  A little trial-and-error should make things crystal clear.
  672.  
  673.  
  674. The index file:
  675.  
  676. BBSFILES.IDX is a static image of the in-memory index that rOver uses to make
  677. file searches ultra-fast.  The index is saved to disk when rOver is shutdown.
  678. In the event you edit BBSFILES.DAT, you will need to use BBSMAINT to rebuild
  679. this file, otherwise rOver will not run.  See the documentation on BBSMAINT
  680. for more information on how to rebuild this index.
  681.  
  682.  
  683. ------------------------------------------------------------------------------
  684.  
  685.  
  686. User Access Control (Access Masks):
  687.  
  688. rOver allows the definition of up to 10 "masks", or groups of access control
  689. switches.  These masks allow you to configure all 170+ user access options
  690. simply by assigning the appropriate mask.  Of the 10 masks that rOver allows,
  691. four have special functions, as follows:
  692.  
  693.    Mask #1  - Assigned to new users when they first log on
  694.    Mask #2  - Assigned to upgraded users (users "accepted" via F7)
  695.    Mask #9  - Assigned to downgraded users (users "rejected" via F7)
  696.    Mask #10 - Assigned to new users who fail to answer the questionnaire
  697.  
  698. The other masks are available for your use, and may be used to emulate the
  699. "access level" approach used by other BBS software.  Don't be fooled, though -
  700. these masks, while convenient, are only the starting point for access control
  701. here.  Once an access mask is assigned to a user, ANY of the various options
  702. can be enabled/disabled for that user, without affecting the access of any
  703. other user.
  704.  
  705. To delete users, you should assign them an access mask which specifies 0
  706. "keep-days" (or manually set their "keep-til-date" to the current date).
  707. BBSMAINT will then delete the record the next time that it is run with the
  708. /U switch.  If you also erase the user's password, they will be treated
  709. exactly like new users should they happen to log on again before maintenance
  710. is done.  Otherwise they will retain their current access (whatever it may
  711. be) until maintenance is done.
  712.  
  713. Although most of the access switches should be pretty straight-forward, a
  714. couple of them are worth of special note, as follows:
  715.  
  716.    "Access ANY message".  Normally, users have access to read private ["(P)"]
  717.    mail only if it is to/from them.  If this switch is enabled, the user will
  718.    be able to read ANY message, private or otherwise.
  719.  
  720.    "Message demi-god".  Normally users are restricted to editing/killing/etc.,
  721.    only message to/from them.  Enabling this switch allows the user to edit,
  722.    kill, xtend, etc. ANY [non-private] message.  These two switches combined
  723.    give the user the power to do anything to any message (in that area).
  724.  
  725.  
  726.  
  727.  
  728.                               rOverBoard BBS Software
  729.                                    Version 1.8
  730.                                       - 10 -
  731.  
  732. Message Areas - Types & Restrictions:
  733.  
  734. Message areas can be configured in several different ways.  You can force all
  735. messages to be addressed to a particular name ("All", or "Sysop"), and allow,
  736. deny, or even force private messages.  You can also designate an area to be
  737. used for on-line BBS listings.  Areas so designated should be set up so that
  738. new messages are addressed to "All" by default, and differ from ordinary msg
  739. areas in that "From" and "Subject" are replaced by "Posted by" and "BBS Name"
  740. (respectively).  Planned enhancements will add discreet prompts for common
  741. BBS list fields, such as phone #, sysop name, and hours of operation.
  742.  
  743. Msg area 0 is where logoff comments will be placed.  If the user does not
  744. have access to msg area 0, he/she will not be given the opportunity to
  745. leave a comment when logging off.  If the user does not have access to any
  746. msg areas, but does have access to the M)ail command, and attempts to enter
  747. the MAIL section, rOver will display an error and return to the MAIN Menu.
  748.  
  749. Msg area 31 is reserved for 'notify' messages.  Any message entered in this
  750. area will be sent to the user at logon (just before the MAIN Menu appears),
  751. regardless of any other mail checking or the state of the /M switch.  The
  752. user need NOT have access to this area in order to receive those messages.
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.  
  790.  
  791.  
  792.  
  793.  
  794.                               rOverBoard BBS Software
  795.                                    Version 1.8
  796.                                       - 11 -
  797.  
  798. Installation and setup:
  799.  
  800. The following is a recommended series of steps for becoming familiar with
  801. rOverBoard and preparing to start your bulletin board.  This is simply a
  802. guideline, not a required procedure.
  803.  
  804. 1)  UnZip SETUP.ZIP into the rOver directory.
  805.  
  806. 2)  Run BBSMAINT /X to rebuild all index files.
  807.  
  808. 3)  Start rOver, using only the /f and/or /s switches (if needed)
  809.  
  810. 4)  Go to the F8:Misc. Maintenance screen, and set (at at minimum) both
  811.     Mail path and .SCReen path.  You can leave them set as is (".\" = the
  812.     current directory), but to keep things neat, you really should at least
  813.     keep the Mail files in another directory.
  814.  
  815. 5)  After saving the new setup information (using CTL-ENTER), press PgDn to
  816.     see the "local" BBS line.  Follow the prompts, and log on as "Sysop".
  817.     Go thru all the opening screens briefly, then review the available msg
  818.     and file areas.  Press F3 (User Edit) followed by PgDn for an idea of
  819.     on what basis you will be able to control user access.  Use ESC to exit.
  820.  
  821. 6)  PgUp back to the Main Menu, and shutdown rOver (ESC).  Using the docs to
  822.     get the complete list of possible .SCR files, create your own customized
  823.     screens as desired.  Also investigate other command line switches you may
  824.     wish to use (ignore /1 and /2 for the time being).
  825.  
  826. 7)  If you have changed the Mail Path, delete MSG*.DAT and MSG*.IDX in the
  827.     current directory.  If you have changed the .SCReen path, move all your
  828.     *.SCR files to the correct sub-directory.  Then run BBSMAINT /Z, just to
  829.     be on the safe side.
  830.  
  831. 8)  Now start rOver up again, this time using any switches (except /1 and /2)
  832.     that you want to test, such as /M or /P.  Before logging on to the local
  833.     node, edit the "Sysop" account (using F2:Change Users), and blank out the
  834.     password field (using CTL-END).  This will force rOver to treat the account
  835.     as a new user when you again log on.
  836.  
  837. 9)  Once you are happy with the .SCReens, turn you attention to the msg/file
  838.     areas.  Using the existing areas only as a guide (and keeping in mind the
  839.     reserved uses of areas 0 and 31 [msgs _and_ files]), decide what areas you
  840.     want, and create them.  You might have to use F3:User to give the Sysop
  841.     account access to the newly created areas!
  842.  
  843. 11) Once you have your areas set, move on to F5:Access Masks.  At a minimum,
  844.     configure the four reserved access masks (1, 2, 9, and 10); you may also
  845.     wish to configure some or all of the remaining masks for convenience.
  846.  
  847. 12) When finished changing the access masks, shutdown rOver, and look at
  848.     BBSFILES.DAT.  Using the sample BBSFILES.DAT as an example, create a new
  849.     file with any filenames / comment entries that you wish rOver to know
  850.     about.  Then run BBSMAINT /Z to rebuild the index and register the changes.
  851.     Alternately, you can simply delete BBSFILES.DAT, and use the P)ost command
  852.     to add entries for pre-existing files.
  853.  
  854. 13) Once you have the board tailored, and are happy with its operation as seen
  855.     by the local line, then call up a patient friend, and work on getting your
  856.     modem to answer the phone (see the section on modems).  Then announce your
  857.     board to the world!
  858.  
  859.  
  860.                               rOverBoard BBS Software
  861.                                    Version 1.8
  862.                                       - 12 -
  863.  
  864. Modem Control:
  865.  
  866.    rOver's absolute minimum requirements (for incoming calls) for Hayes and
  867. compatible modems are shown below.  rOver can support any modem that appends
  868. a <cr> (hex-0d) to its result codes, and uses <cr> to delimit the end of its
  869. init strings.  Contact FLP directly for help with non-Hayes compatibles.
  870.  
  871.      AT S0=1 E0 V0 Q0 M1 X1
  872.  
  873. Note that those are all zeroes, not O's, and that the modem parm should *not*
  874. contain any spaces, as are shown here.  Thus, ATS0=1E0V0M1X1.  These commands
  875. tell the modem the following:
  876.  
  877.      AT    -  Tells the modem to wake up and pay attention
  878.      S0=1  -  Answer the phone after 1 ring (can be 1-255, *not* 0)
  879.      E0    -  No local echo (handled by software)
  880.      V0    -  Numeric result codes (default mode).  To use alpha results,
  881.               change the connect code literals on the F9:Modem Setup screen.
  882.      Q0    -  Force result codes to be returned
  883.      M1    -  Turn the speaker on until the connection is established
  884.               (optional - use M0 to totally disable the speaker)
  885.      X1    -  Enables extended result codes (required for "high speed" calls)
  886.               ("high speed" = 1200 for 300/1200 modems, 2400 for 3/12/24, etc.)
  887.  
  888. rOver supports up to 38.4k baud rates, with or without hardware error handling
  889. such as MNP.  If you need support for higher baud rates (!?), contact FLP.
  890.  
  891. Given the above modem init string, the modem still must be told how to handle
  892. the Data Terminal Ready (DTR) and Carrier Detect (CD) signals.  Almost all
  893. modems have some method of forcing these signals to be 'always on' for use with
  894. older equipment.  rOverBoard requires that both of these signals be 'true', ie.
  895. indicate on or off based on reality.  Some modems have dip-switches to set the
  896. state of these signals, while others (true Hayes') provide software support.
  897. If your modem has dip-switches to alter DTR and CD, you should set them to the
  898. 'true' position (as opposed to 'always on').  If not, odds are that your modem
  899. supports the &Cx and &Dx Hayes commands, and you need to add &C1&D2 to the end
  900. of your modem init string (from above).  &C1 forces the correct detection of
  901. carrier signals, and &D2 forces the modem to hangup and recycle when the DTR
  902. signal is dropped by the host computer.  See your modem documentation with
  903. regard to Data-Terminal-Ready and Carrier-Detect for more information.
  904.  
  905. These modem init strings have been proven on a variety of modem/computer
  906. combinations, and one of the two should do the trick for your modem too:
  907.  
  908. For modems with dip-switches:           For 'true'-Hayes compatibles:
  909.  
  910.     ATS0=1E0V0Q0M1X1                       ATS0=1E0V0Q0M1X1&C1&D2
  911.  
  912. You *can* include other options; these are simply the bare minimums.  rOver
  913. also allows you to change the modem's i/o port and/or IRQ line.  The defaults
  914. will work on most computers and should not be changed unless you know for sure
  915. that your serial ports are 'non-standard'.
  916.  
  917. If your modem requires flow control, always set it to use _hardware_  flow
  918. control (RTS/CTS).  rOver supports only rudimentary software flow control.
  919.  
  920. Note:  Refer to your modem docs for possible special conditions and/or further
  921. info.  Getting the modem to answer the phone is usually the most difficult
  922. part of starting a board; a good understanding of the modem commands is very
  923. useful for this process.
  924.  
  925.  
  926.                               rOverBoard BBS Software
  927.                                    Version 1.8
  928.                                       - 13 -
  929.  
  930. rOver's keyboard:
  931.  
  932. rOver uses a number of keys in special ways.  In addition to the Fkeys, PgUp/
  933. PgDn and Esc, a number of keys have special functions when working with menus,
  934. be they full screen or the one-liners that F4:Time and F5:File call up.  A full
  935. list of special key uses is shown below:
  936.  
  937.    TAB, ^Right      :  Goto next field (Right/Down)
  938.    BackTab, ^Left   :  Goto previous field (Left/Up)
  939.  
  940.    Right/Left       :  Move R/L within field or goto next/prev field
  941.    Up/Down          :  Goto "nearest" field "above"/"below" current field
  942.  
  943.    Home             :  Goto start of current field
  944.    ^Home            :  Goto 1st field on screen
  945.  
  946.    End              :  Goto end of current field
  947.    ^End             :  Erase to end of field
  948.  
  949.    Enter            :  Goto next field (Down/Left)
  950.    ^Enter           :  Save current changes and exit
  951.    Esc              :  Exit without saving changes
  952.  
  953.    Ins              :  Toggles INS Mode (alpha fields only)
  954.    Del              :  Deletes char under cursor (alpha fields only)
  955.  
  956.    + / -            :  Increment/Decrement field (unsigned int fields only)
  957.  
  958.    Space            :  Same as Right Arrow in non-alpha fields
  959.  
  960.    PgUp/PgDn        :  Page thru secondary menu pages (if any)
  961.  
  962.    Fkeys            :  As indicated (if applicable)
  963.  
  964.    ALT + C          :  Clear the screen (of the local monitor only)
  965.                        Does not work from any local menu screen
  966.  
  967.      Note that line 0 treats the keyboard exactly as if it were a modem with
  968. respect to incoming characters except for PgUp/PgDn and indicated function
  969. keys.  Also, all selection of menu and hot-key options must be done from the
  970. keyboard.  Receiving the equivalent character codes from the modem will *not*
  971. be treated as input to menu or hot-key input parsing.
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.                               rOverBoard BBS Software
  993.                                    Version 1.8
  994.                                       - 14 -
  995.  
  996. Multi-tasking considerations:
  997.  
  998. Note that the BBS cannot allocate memory when multi-tasking; if the current
  999. 'block' of user or file pointers is full, and an attempt is made to add another
  1000. (a new user or an upload), the attempt will fail.  In the former case, the user
  1001. will receive the message "No space for new users", and in the latter, "No space
  1002. for uploads.  Cannot save your file".  In the latter event, the file *will* be
  1003. saved and in BBSFILES.DAT, but not accessible.  In both cases the error will be
  1004. logged.  The Dos command prompt displays the number of slots available for new
  1005. users/files before memory allocation will be required.
  1006.  
  1007. As with any Dos shell, do not install any TSRs from rOver's Dos mode.  Also,
  1008. programs that hook the disk I/O interrupt vectors (13h, 25h, 26h) could cause
  1009. rOver to crash, and should be avoided.  Also, any program that tries to trap
  1010. INT 8h (the timer) is in for a rude surprise (rOver runs the clock considerably
  1011. faster than the standard 18.2 tics/second), though as long as it passes the
  1012. interrupts through it will not cause any problems.  Programs that intercept
  1013. this vector before rOver is started, or intercept INT 1Ch instead will function
  1014. normally.
  1015.  
  1016. Later versions of Dos may restrict your access to the files used by rOver
  1017. while in the Dos shell.  In any event, you should *never* attempt to alter
  1018. (ie., edit, rename, delete, etc.) these files while rOver is running.  Viewing
  1019. these files with a read-only utility such as LIST is ok with rOver, but your
  1020. Dos might have objections.
  1021.  
  1022.  
  1023.  
  1024.  
  1025.  
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.  
  1032.  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.                               rOverBoard BBS Software
  1059.                                    Version 1.8
  1060.                                       - 15 -
  1061.  
  1062.  
  1063. Ascii translation:
  1064.  
  1065.      rOver maintains a translate table for use in converting extended ASCII
  1066. characters (those over 127 decimal) into normal ASCII characters, in the
  1067. event the user has indicated they cannot display extended ASCII.  This table
  1068. is customizable from the F8 maintenance screen (page 2).
  1069.  
  1070.  
  1071.  
  1072.  
  1073. ANSI support:
  1074.  
  1075.      rOver does not fully support the ANSI color/graphics specification at
  1076. this time.  Specifically, rOver supports only three of the possible ANSI
  1077. escape sequences.  Any other escape sequence that appears in outgoing text
  1078. will be stripped out (and otherwise ignored).  The supported esc sequences
  1079. are:
  1080.  
  1081.     (Note that ESC below means the ESC char (hex 1b), not "E" "S" "C".)
  1082.  
  1083.     ESC [ 2 J   -  Clear the screen.  This should _not_ be used in NEWUSER.SCR
  1084.                    or BULLETIN.SCR, but is ok in other .SCR files.
  1085.  
  1086.     ESC [ K     -  Clear to end-of-line
  1087.  
  1088.     ESC [ ?? m  -  Change current attribute setting
  1089.  
  1090.  
  1091.     In addition, all possible attributes are not supported by the local
  1092.     monitor, and supported attributes may not appear exactly as on the remote
  1093.     screen.
  1094.  
  1095.  
  1096.     See also the /K switch (also available as an "Active Setting").
  1097.  
  1098.  
  1099.  
  1100.  
  1101.  
  1102.  
  1103.  
  1104.  
  1105.  
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.  
  1120.  
  1121.  
  1122.  
  1123.  
  1124.                               rOverBoard BBS Software
  1125.                                    Version 1.8
  1126.                                       - 16 -
  1127.  
  1128.  
  1129. The user credit system:
  1130.  
  1131. rOverBoard controls file downloads using a "credit", or "point" system.  Each
  1132. user is given an arbitrary number of credits when they first log on (as set on
  1133. the F8:Misc. Maintenance screen).  If a user has insufficient credits (as
  1134. determined by the file size and the credits-per-d/l value for that file area),
  1135. they cannot download a given file.
  1136.  
  1137. When a file is downloaded, the user loses the applicable number of credits
  1138. (ie., credits-per-d/l * file_size_in_k).  Credits can be _gained_ either by
  1139. uploading (at a rate determined by the credits-per-u/l value in the applicable
  1140. area and the file size), or by entering messages (where the number of credits
  1141. is determined by the credits-per-message in the applicable message area).
  1142.  
  1143.  
  1144.  
  1145.  
  1146.  
  1147.  
  1148.  
  1149.  
  1150.  
  1151.  
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.                               rOverBoard BBS Software
  1191.                                    Version 1.8
  1192.                                       - 17 -
  1193.  
  1194. Misc. Notes:
  1195.  
  1196. - In order for rOver to function correctly, you must specify FILES=20 or
  1197.   greater in your CONFIG.SYS file.  If rOver consistently abends trying to
  1198.   open files, you probably need to increase your FILES= parameter.  See your
  1199.   DOS documentation for more details.
  1200.  
  1201. - Events:  If an external-type event is scheduled while the board is down
  1202.   (or shelled to DOS), that event will be ignored.  Internal events,
  1203.   however, will be properly handled.  External events are those with event
  1204.   number of 32 or greater, which force rOver to shutdown.
  1205.  
  1206.  
  1207.   There's lots more, but I'm outta time.  A running version of this document
  1208.   will be available on TWW (301-322-8678), in message area #20.
  1209.