home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / MNBBS232.ZIP / MINIBBS.DOC < prev    next >
Encoding:
Text File  |  1995-05-07  |  16.2 KB  |  378 lines
  1.    
  2.    
  3.    MiniBBS v2.3            Copyright (C) 1995  T. Mitchell            05/07/95
  4.    ===========================================================================
  5.  
  6.       MiniBBS is a door that enables your users to setup and operate their own
  7.    "mini-bbs" style message conference.  Once a user has added an area, that
  8.    user, the "mini-Sysop", may delete and undelete individual messages, delete
  9.    all messages in their area, and even upload an Ansi file to be displayed to
  10.    anyone who enters that mini-bbs.  Currently, up to sixteen mini-bbs areas
  11.    are available (only four if unregistered).  Previous versions allowed up to
  12.    eight areas when registered.  See "SYSOP Menu" in this file for more
  13.    information.  Each area may be configured as private or as a limited access
  14.    area.  This door REQUIRES Ansi.
  15.  
  16.       MiniBBS (versions v1.90+) is now compatible with multinode systems.
  17.    Multiple users may operate the door, but only a single node may access any
  18.    one of the sixteen conferences at one time.
  19.  
  20.       MiniBBS is being distributed as shareware.  If you have any comments,
  21.    complaints, and/or suggestions for MiniBBS, you are welcome to write to the
  22.    address found in REGISTER.TXT.
  23.  
  24.       Unregistered copies of MiniBBS may be distributed free of charge if all
  25.    of the original files are included without modification.
  26.  
  27.       MiniBBS is distributed without warranty.  The author will not be
  28.    responsible for damages or losses caused by the use or attempted use of
  29.    MiniBBS.    USE THIS PROGRAM AT YOUR OWN RISK!!
  30.  
  31.       MiniBBS was written and compiled with:
  32.          Turbo Pascal  Copyright (c) 1983,1992 by Borland International, Inc.
  33.          RMDoor        Copyright (c) 1991-1993 by Mark Goodwin and Randy Hunt
  34.                                                    (registered)
  35.  
  36.    Upgrading From  V2.0+
  37.    ---------------------
  38.  
  39.    To upgrade from V2.00 or later, UnZip MINBBS23.ZIP into your MiniBBS
  40.    directory.  You may need to reconfigure the maintenance utility.
  41.  
  42.  
  43.    Upgrading From  V1.0 thru V1.9
  44.    ------------------------------
  45.  
  46.    1.  UnZip MINBBS23.ZIP to your MiniBBS directory.
  47.    2.  Run UPGRADE.EXE.  This will upgrade your datafiles to the new format.
  48.            You MUST use this for everything to work properly!  You may now
  49.            delete UPGRADE.EXE, it will not be needed again.
  50.    3.  The maintenance utility, MMAINT.EXE, should be ran as a daily event.
  51.            Read the included documentation, MMAINT.DOC.
  52.  
  53.  
  54.    Installation
  55.    ------------
  56.  
  57.    Installation Using SETUP.EXE
  58.    ----------------------------
  59.    
  60.    1. Create a directory for MiniBBS (it should only be used by MiniBBS).
  61.  
  62.       Ex:   MD \bbs\doors\minibbs
  63.  
  64.    2. UnZip MINBBS23.ZIP to this directory.  
  65.    
  66.    3. Run SETUP.EXE to configure MiniBBS to your system.
  67.    
  68.       Note: SETUP.EXE creates both a batch file & a config file for MiniBBS,
  69.             the default filenames are MINIBBS.BAT & MB.CFG.  You may now enter
  70.             your filenames on the command line (setup v2.1+).  Both filenames
  71.             must be entered.  If not, the default names are used.  (One must
  72.             end with '.bat' and the other '.cfg').
  73.  
  74.    4. Copy MiniBBS.BAT to the proper directory (such as \bbs) and rename it
  75.          if necessary.
  76.  
  77.    5. If you are using a locked serial port, you must enter the locked baud
  78.          rate for MiniBBS to function properly.
  79.  
  80.    6. Read the steps for the Manual Installation, they may contain needed
  81.          information for non-standard configurations.
  82.  
  83.    Manual Installation
  84.    -------------------
  85.  
  86.    1. Creating A Config File.
  87.  
  88.       Line 1:  Door Data File Type.
  89.                   PCB for PCBoard, GAP for DOOR.SYS (GAP),
  90.                   RBBS for RBBS, WC for WildCat!, WWIV for WWIV,
  91.                   SF for SpitFire, or TRIBBS for TriBBS.
  92.       Line 2:  Path to the door drop file.
  93.       Line 3:  BBS Name.
  94.       Line 4:  Sysop's Name.
  95.                   If registered, this must be your real name.  If you
  96.                   registered using an alias, this line should contain your
  97.                   alias and you should enter your real name on line 7.
  98.                   This is not case sensitive. 
  99.       Line 5:  Locked Baud Rate.
  100.                   If your serial port is not locked, enter 0 on this line.
  101.                   Note: If the Com Port is locked, you MUST enter the locked
  102.                   rate on this line.
  103.       Line 6:  Registration Code.
  104.       Line 7:  This line should contain your real name if you registered
  105.                   using an alias.  Otherwise, don't add this line.
  106.       Line 8:  Specify your Sysop/Co-Sysop Security Level.  Anyone with
  107.                   this security level (and higher) will have Sysop Access
  108.                   within MiniBBS.  To disable, enter 0 on this line or do not
  109.                   include this line in your config file.  (This is new to
  110.                   v2.0 & you may still manually set users' access in MiniBBS.)
  111.       Line 9:  Specify your Subscriber's Security Level.  Anyone with this
  112.                   security level (and higher) will automatically be set to
  113.                   Subscriber Access (unless they have Sysop Access).  See
  114.                   'Time Limits & Access' under the Sysop Menu.  When a user's
  115.                   security drops below this value, they are set back to
  116.                   Non-Subscriber Access.
  117.  
  118.  
  119.       The following is a sample config file:
  120.  
  121.          TRIBBS
  122.          C:\tribbs\
  123.          Noname BBS
  124.          John Doe
  125.          38400
  126.          0
  127.  
  128.    2. Creating A Batch File.
  129.  
  130.       If you are not familiar with creating a door batch file, refer to your
  131.       BBS program documentation.
  132.  
  133.       A sample batch file for TriBBS:
  134.  
  135.          C:
  136.          cd\tribbs\doors\minibbs
  137.          minibbs.exe mb.cfg
  138.          cd\tribbs
  139.          board
  140.  
  141.    3. Non-Standard Com Port IRQ.
  142.  
  143.       A Non-Standard IRQ can be used by specifying the Irq number
  144.       after the name of the config file on the command line:
  145.  
  146.       Example:   minibbs.exe mb.cfg 2
  147.  
  148.    4. Running In Local Mode (without using a BBS).
  149.  
  150.           MINIBBS.EXE MB.CFG /L   <ENTER>
  151.  
  152.    5. Using Multinodes with a RBBS or WWIV door data file.
  153.  
  154.       The node number is not automatically passed to the door with these
  155.       two door types.  If you are using either of these with a multi node
  156.       system, add the following switch:
  157.  
  158.           /N[node]  as in:
  159.  
  160.           MINIBBS.EXE MB.CFG /N3       (for node 3)
  161.  
  162.       Note: If you need to use both a non-standard irq (as in number 3 above)
  163.             and a node switch, always put the irq first:
  164.              
  165.           MINIBBS.EXE MB.CFG 2 /n3     (IRQ is 2, Node 3)
  166.  
  167.    6. Setup MMAINT.EXE as either a daily or weekly event.
  168.  
  169.  
  170.    Main Menu Commands
  171.    ------------------
  172.  
  173.    A thru H   Select Message Area.  (A thru P if using 16 areas).
  174.    Y          Add a new area if one is available.
  175.    ?          Instructions/Explanation of how you are using this door.
  176.                  The first is USERINFO.ANS, for all users.  The second file
  177.                  is MINSYSOP.ANS, for users who define their own area. You
  178.                  are encouraged to personalize these for your BBS.
  179.    W          Other Nodes.  If callers on other nodes are operating MiniBBS
  180.                  also, they will be listed here.
  181.    X or Q     Exit to BBS.
  182.    S          Sysop Menu.
  183.  
  184.  
  185.    Message Area Commands
  186.    ---------------------
  187.  
  188.    N   Read New Messages.
  189.    R   Read Messages, either Forward or Reverse.
  190.    E   Enter A Message.
  191.    U   User List.  List of users (aliases) who use this area.
  192.    Q   Quit back to Main Menu.
  193.    S   This is the Mini-Sysop's Menu.  The main BBS sysop will have access
  194.        also.  Commands Available:
  195.  
  196.              U   Upload Ansi Screen.
  197.                     To enable this option, see the Sysop's Menu.
  198.              R   Remove Ansi Screen.
  199.                     To replace a screen, it does not have to be removed first.
  200.                     When a new ansi screen is uploaded, it overwrites the
  201.                     current file.
  202.              D   Delete All Messages.  This removes all messages, but does not
  203.                     reset the message numbers.
  204.              P   Pack Message File.  This will remove deleted messages from
  205.                     the message file.  (Deleted messages are displayed to the
  206.                     mini-sysop and anyone with sysop access.)
  207.              C   Change Name Of Mini-BBS Area.
  208.              Q   Quit to previous menu.
  209.  
  210.  
  211.    Commands Available While Reading Messages
  212.    -----------------------------------------
  213.  
  214.    N, +   Next Message.
  215.    E      Enter Message.  The Sysop & the mini-Sysop may address a message to
  216.              "@user@".  The message appears to be addressed to the current
  217.              user online.  Unlike writing a message to "All", this message
  218.              is included in the user's personal mail search upon entering
  219.              a mini-bbs.
  220.    L, -   Last (Previous) Message.  Not Available while reading new messages.
  221.    D      Delete Message.  Marks message as deleted.  The message is not
  222.              actually deleted.  (Pack messages will remove deleted messages.)
  223.    U      Undelete Message.  Message is again visible by all.
  224.    R      Reply.  This allows you to reply to the current message with the
  225.              option of quoting.
  226.    Q      Quit.
  227.  
  228.  
  229.    Changing Text And TextBackGround Colors When Entering Messages
  230.    --------------------------------------------------------------
  231.  
  232.    You may select the color of the text in your messages by using a syntax
  233.    similar to that in a few other BBS message editors:
  234.  
  235.        @Xbt
  236.  
  237.    Enter "@X" (Or "@x") followed by two hexadecimal digits (0-9,a-f).
  238.    The first hex digit (b) will the TextBackground Color.  The second hex
  239.    digit (t) will set the Text Color.
  240.  
  241.    BackGround Colors:  0-Black, 1-Blue, 2-Green, 3-Cyan, 4-Red, 5-Magenta,
  242.        6-Brown, 7-White.  8 thru F are the same as 0 thru 7, respectively, but
  243.        with Blinking text.  One exception is E, which is Yellow with Blinking
  244.        text.
  245.  
  246.    Text Colors:  0-Black, 1-Blue, 2-Green, 3-Cyan, 4-Red, 5-Magenta, 6-Brown,
  247.        7-White, 8-Dark Grey, 9-Light Blue, A-Light Green, B-Light Cyan,
  248.        C-Light Red, D-Light Magenta, E-Yellow, F-Bright White.
  249.  
  250.  
  251.    Sysop Menu
  252.    ----------
  253.  
  254.    U :    Edit Users.
  255.    B :    Edit Message Boards.
  256.    T :    Set Time Limits For Access Levels.  (Only Available When Registered)
  257.              This sets the maximum time allowed in MiniBBS per day for three
  258.              access levels: Non-Subscriber, Subscriber, & Sysop.
  259.              After setting these, you select the minimum access required to
  260.              create a minibbs.  This gives you the option of only letting
  261.              subscribers to your BBS have a minibbs (all other users may still
  262.              enter the door and read & write messages).  This option works
  263.              with the 'Subscriber Access Level' in line 9 (or selection "I" in
  264.              the Setup program) of your config file.  Subscribers of this
  265.              security level are automatically set to subscriber access in
  266.              MiniBBS.  NOTE:  Line 8 (selection H of Setup) of the config
  267.              file is the security level to give a user SYSOP access.  Make
  268.              sure you don't confuse the two!  To disable either one, enter
  269.              0 for the security level.
  270.    S :    Setup X/Y/Zmodem Uploads.
  271.    R :    Reset Entire Door.  This erases all data files, including bulletin
  272.              paths, time limits, Gsz/Dsz path, etc.
  273.    P :    Set path and filenames for MiniBBS bulletins.  If not set, default
  274.              bulletins will be created in the current (MiniBBS) directory as
  275.              MINIBBS.ANS and MINIBBS.BBS.
  276.    I :    Increases number of available areas from 8 to 16 (In REGISTERED
  277.              versions only).  You may use the default 8 areas, but if you 
  278.              select this command, you cannot drop back down to 8 unless
  279.              you Reset MiniBBS.
  280.    Q :    Return to main menu.
  281.  
  282.  
  283.    User Editor  (Sysop Menu)
  284.    -------------------------
  285.  
  286.    A   Change access level to NON-REGISTERED, REGISTERED, or SYSOP-ACCESS.
  287.           (SYSOP-ACCESS will give a user complete access with MiniBBS.  Only
  288.           give your Co-Sysops this access level.)
  289.    R   Resets User's Time Used Today.
  290.    D   Delete User.
  291.  
  292.  
  293.    Message Area Editor  (Sysop Menu)
  294.    ---------------------------------
  295.  
  296.    C   Change the name of this area.
  297.    S   Change the operator of this area.  
  298.    R   Remove this area.
  299.    D   Delete all messages in this area.
  300.    K   Pack Message File.  This removes deleted messages from message file.
  301.    !   Make This Area Private (or with limited access).
  302.           You must select the users who will have access.
  303.           Three different types of limited access are available:
  304.              1: Only the Selected Users may enter this area.
  305.              2: Only Selected Users may enter this area.  They can only
  306.                 write messages which will be available to the Mini-Sysop.
  307.                 (This might be used for role playing game moves)
  308.              3: All users may enter this area and read messages, but only
  309.                 Selected Users may write messages.  (Possibly for use of
  310.                 a role playing game discussion by its players)
  311.              4: Subscribers Only.  (MiniBBS must be Registered for this type.)
  312.    E   Edit Selected List.  Edit the list of "Selected Users" who have
  313.           access to this minibbs area.
  314.              A   Add User.  Add user to the list.  You can scan the whole
  315.                     userlist of MiniBBS to give certain users access.
  316.              S   Scan Selected Users.  This scans the list of users who have
  317.                     been given access to this area.  You may remove individual
  318.                     users here.
  319.              !   Make This Area Public.  This deletes the list of Selected
  320.                     Users and gives everyone full access to this area.
  321.  
  322.  
  323.    Set Time Limits  (Sysop Menu)
  324.    -----------------------------
  325.                           Default Values
  326.    Non-Subscriber:           15 Minutes
  327.    Subscriber:               25 Minutes  (45 if registered)
  328.    Sysop Access:             35 Minutes  (60 if registered)
  329.  
  330.    Minimum Access Required To Create A MiniBBS:  Non-Subscriber (default)
  331.    
  332.       This may be set to either 'Non-Subscriber' or 'Subscriber'.
  333.  
  334.  
  335.    Setup X/Y/Zmodem Uploads (DSZ or GSZ)
  336.    -------------------------------------
  337.  
  338.    You may optionally allow Mini-Sysops to upload an ansi screen to be
  339.    displayed when a user enters their area.
  340.  
  341.    Com Port:
  342.         This will be read from your BBS's door drop file.  Some door drop
  343.         (DOOR.SYS for example) will contain 0 for the comport when you log on
  344.         your BBS local.  This should be fine.  If 0 is displayed and mini-
  345.         sysops can't upload, try using a different door drop file type.
  346.  
  347.    Port Address:
  348.         If you are using COM1 through COM4 with the standard address, you do
  349.         not need to change this.  (If you do need to use a non standard
  350.         address here, then you must also enter the Irq value as described
  351.         above on the command line in the MiniBBS batch file.  If an Irq value
  352.         is not present, this will be ignored.)  To enter or change this, you
  353.         must be logged onto the node for which this needs to be changed.
  354.  
  355.    IRQ: This displays the Irq value that you entered on the command line in
  356.         the MiniBBS batch file.  If none was specified, this uses the standard
  357.         irq.
  358.  
  359.    Path: This is the path to DSZ or GSZ.  You must edit this while on Node 1.
  360.  
  361.    NOTE: DSZ.COM and GSZ.EXE are Copyright 1991 by Omen Technology Inc.
  362.          DSZ or GSZ can be used if provided by you.  It is your responsibility
  363.          to abide by their registration requirements.  Read DSZ.DOC/GSZ.DOC
  364.          for information about registering.
  365.  
  366.  
  367.  
  368.  
  369.      MiniBBS, and other great BBS & Door software, can be found at:
  370.  
  371.  
  372.        THE BLACK REALMS     (812) 424-3781  24Hrs/7days  14400bps
  373.             Home of "The Pub" and the all new "The Pub ][". 
  374.                          SysOp:  Matthew Elzer
  375.  
  376.        COMPUTER FREAKS BBS  (812) 897-5751  24Hrs/7days  14400bps
  377.                          SysOp:  John Howard
  378.