Gold Fish 3/goldfish_volume_3.bin/files/comm/bbs/4d-bbsdemo/docs/text/03.getting_started

Text File | 1993-12-28 | 20.0 KB | 522 lines

Chapter 3:  Getting Started




3.1 Command Line Parameters (CLP)

    4D-BBS uses command line parameters (CLP) to allow you to customize
its behavior to suit your needs right from startup!  CLPs are arguments
used in normal DOS commands.

    4D-BBS also uses a configuration file that imitates the CLPs, however
a CLP will always override the setting of the configuration file.

    All parameters are preceeded with a "/" or "-" and should be spaced
apart BETWEEN THE PARAMETERS.  NO spaces should be between the "/" or "-"
and the actual command itself.  CLPs CAN NOT be stacked by using a single
"/" or "-" with multiple commands.

    A "#" following a CLP should be replaced by a numerical value, and a
"$" should be replaced by a character string.  The "!" following a CLP
indicates the CLP is a switch.  A blank or a "0" following the CLP is
considered off, while a "1" is considered on.

    In the event a space is needed for a parameter, enclose JUST that
parameter including the "/" or "-" within quotation marks.  The commands
ARE case sensitive.

3.1.1 CLP Descriptions

    CLP DESCRIPTION

    A!  Enter ARexx Port Server Mode, Wait for Commands

Brings the BBS up in WAIT mode and does NOT monitor the serial port.  This
mode is used mainly as an ARexx server.  (Refer to Chapter 10.)

Example:  4D-BBS -A

    a$ ARexx Port Name

Allows you to change the base ARexx port name created when 4D-BBS is
started up.  All ARexx doors and scripts should address this name if you
want 4D-BBS to recognize the commands.  (Refer to Chapter 10.)

Example:  4D-BBS -aARexxName

    B# True Baud Rate of "/o" Call

Lets 4D-BBS know the true baud rate if different than the serial baud rate.
Used for login and transfer time calculations.  This command only has an
affect when used with the "b" CLP.

Example:  4D-BBS -o1 -b19200 -B2400 Range:  300-115,200

    b# Lock the Serial Baud Rate

Allows 4D-BBS and your modem to send information at a fixed serial rate.
This is only needed for modems which have data compression capabilities.
(Refer to Chapter 12.)

Without "/o" CLP:  Lock Serial Port at rate With "/o" CLP:  Serial Baud
rate for call

Example:  4D-BBS -b38400 Range:  300-115,200

    C# Number of Last Callers Saved

Allows you to set the number of callers saved to the file "BBS:lastcall.t".
If you have low memory try to keep this number as low as possible.

Example:  4D-BBS -C10 Range:  1-30

    c# Number of Bitplanes to Use (Colors = 2^#)

If you have low memory, run multiple lines, or are running on an
unaccelerated Amiga, use "1" or "2" here not only to save memory, but to
speed up the BBS.  This setting has NO affect on the user's color, as they
will see the full set of colors.

Example:  4D-BBS -c2 Range:  1-4 (2-16 colors)

    D$ Filename of Directories Data File

A data file containing a list of alternative paths for 4D-BBS to use.  The
order of the paths or assigns is as follows:

BBS Path or Assign FILE Path or Assign MENU Path or Assign TEXT Path or
Assign USERS Path or Assign BOARDS Path or Assign DOORS Path or Assign

Example:  4D-BBS -DBBS:AltPaths.Dat

    d# Hang-up Behavior of BBS

        0:  Don't do anything to hang-up (used in a spawn mode)
        1:  Drop DTR to hang up modem
        2:  Use "+++,,,ATH" to hang-up modem

        Example:  4D-BBS -d1

    f$ Font to Use with 4D-BBS

You can use just about any font you wish with 4D-BBS.  It will look in your
"FONTS:" directory and append the ".font" on the end if it is not already
there.  If the requested font is already open in RAM, it will use it.  If
not, it will open your diskfont and use it.

Example:  4D-BBS -fGraphics.font

    G$ Configuration File to Use

Instead of using the default "S:4D.Config" file, you can specify an
optional file for 4D-BBS to get its configuration settings from.  The FULL
path must be given.

Example:  4D-BBS -GS:4D2.config

    h!  Reset to System High Baud After Every Caller

This is mostly used in conjunction with the other serial and baud related
CLPs.  When the BBS is running in continuous answer modem, it will reset
BACK to the system high baud after each call when this parameter is given.
Normally it will stay at the last caller's baud rate, until another call at
a different baud rate comes in.

Example:  4D-BBS -h1

    H!  Hide Screen and Don't Make Active when Starting

Tells 4D-BBS to open its custom screen in the back, and NOT make it the
active screen.  Normally used with "/o1" when being spawned by another
program.

Example:  4D-BBS -H1

    I!  Open 4D-BBS in Iconified Mode Instead of Full Screen

This is a very handy memory saving option.  The user receives a slightly
faster response time as local screens and windows are not updated.  A small
title bar will appear to give you system status reports including on-line
users name and their activity.  You can un-iconify 4D-BBS by quickly
clicking the left then right mouse buttons while pointing in the small
window.  The close gadget will completely shutdown the BBS, so be careful
when using it.

Example:  4D-BBS -I

    K!  Turn Keyboard Input Off when 4D-BBS is Started

Allows you to switch off normal keyboard input, the AMIGA key commands, and
function keys.  Your mouse or an ARexx script is the only way to turn
keyboard input back on.

NOTE:  If you use the CLP of "-M" to switch your pull down menus OFF to
save memory and do not have an ARexx script to turn your keyboard back ON
4D-BBS will not recognize keystrokes.  Use the option in "Defs" pull down
menu to toggle this option.

Example:  4D-BBS -K1

    L# Number of Screen Lines to Use

Sets the number of displayable lines to the SysOp.  If your screen/window
is not large enough 4D-BBS will increase the size.  A number greater than
32 will cause an interlaced screen to be opened.

Example:  4D-BBS -L50 Range:  20-60

    M!  Disable Pull-Down Menus

Saves memory by disabling the pull-down menus.  You cannot use the
pull-down menus or the AMIGA keys if you set this CLP.  The function keys
will NOT be disabled.

Example:  4D-BBS -M1

    m$ Replacement File for BBS:Modem.dat

In the event that you are running multiple modems, allows you to use a
different modem data file without editing the same file for each change of
modem.  Can also be used in a multi-line situation, when different modems
are being used.  Will only be in effect is auto-detect is enabled in the
configuration editor.

Example:  4D-BBS -mBBS:ModemUSR.dat

    N$ Forced User Name if Using "/o"

The string following N will be used as the user name, and the user will not
be prompted for one.  The CLP "-P" is normally associated with this
command.  If BOTH "-N" and "-P" are given with the "/o1" or "/os" CLP, and
the name or password is incorrect, 4D-BBS will quit returning an error
code.  If just "-N" and "/o1" or "/os" is given the user will be prompted
for a password.  If the password is given incorrectly three times, 4D-BBS
will quit returning an error.

In the event the BBS is spawned from another program (i.e.  the BBS is not
responsible for responding to the phone line) a script can be written to
automatically log you into the BBS using the "/os", "-N" and "-P"
parameters.  This will function as pressing F10 for the SysOp local logon
from the BBS wait screen.

If the user name contains a space in it, surround just this CLP with double
quotation marks.

Example:  4D-BBS -os "-NJohn Doe" "-Pjane"

    o!  Logon Once Remote, Without a Waiting Screen
    os Logon Once Local, Without a Waiting Screen (can also be -o2)

This is mainly used by a network front end program to call up 4D-BBS when a
carrier is present.  4D-BBS will send the opening logon screen, and act as
if it had responded to the phone.  Once the call is complete, the BBS will
shut down, and return control to the calling program.

For a remote spawn, the calling program will need to pass the "-b" CLP to
tell 4D-BBS what serial rate to use.  The "-B" CLP should also be passed to
tell 4D-BBS what the true carrier rate is.

For a local spawn ("/os") 4D-BBS will not actually open the serial port.
The serial I/O will not checked during the session, but everything else
will function as a normal call.  (Refer to Chapter 14 for more information
on Networking.)

Example:  4D-BBS -o1 -b19200 -B14400

    P$ Forced User Password if Using "/o" and "/N"

Works in the same way as the "-N" CLP and is the users password.  This CLP
is ONLY used when BOTH "-o" and "-N" parameters are provided otherwise it
is ignored.  See the N CLP for more information on this.

Example:  4D-BBS -os -NSysop -PNotell

    r!  Transfer types:  RZ/SZ Externals(0) or XPR Libraries(1)

Determines whether the BBS uses the XPR libraries when transferring files
or the two external programs called RZ/SZ.  RZ/SZ can ONLY be used on
serial port 0, but are written in 100% assembler and are very fast and
efficient.  The XPR libraries give the BBS more flexibility and a wider
range of transfer protocols to use.  They are not as efficient as RZ/SZ,
but can be used on any serial port.

If you are running a multi-line BBS, you MUST use XPR libraries.

Example:  4D-BBS -r1

    S$ Set the Announce String

To get a quick message to the on-line user without entering into chat mode,
you can use the pull-down menu command ANNOUNCE.  This command will first
locate a file called "Tellem" in RAM.  This file can be anything, and if
it's there it will be typed to the users screen.  If it is not found,
4D-BBS will send the string set by this CLP.

This function is primarily for users that do not have ARexx, as the ARexx
"messqueue" command is a cleaner way to send messages to an on-line user.

The default string for this option is:  "System request -> BBS will be
going down in a few moments."

Example:  4D-BBS "-SI'm Sorry, I can not chat with you right now."

    s$ Serial Device Name for 4D-BBS to Use

If you wish to use a serial device other than "serial.device" you can
specify the particular device name here.

Example:  4D-BBS -sgvpser.device

    T# Time Added or Subtracted with F7/F8 or Menu Commands

When time is given to the on-line user via the function keys or pull-down
menu commands, this number will represent the amount of time given or
taken.  This number should always indicate a positive value.  The default
is 10 minutes.

Example:  D-BBS -T15 Range:  1-99

    t# Inactivity Timeout Before Auto-Logoff

Allowable time the user can stay on-line without any activity is determined
by this CLP.  The default is 4 minutes.

Example:  4D-BBS -t7 Range:  1-99

    U# Time Awarded to User for Uploads

When a user uploads a file to the BBS, user can be rewarded by being given
extra time on-line for the upload.  This CLP allows you to set the number
of extra seconds per Kilobyte uploaded the user is given.  This function is
defaulted to "0", no reward given.

Example:  4D-BBS -U Range:  1-99

    u# Serial Unit Number

Allows you to use a unit other than "0".  This can be be used in
conjunction with the "-s" CLP, but is not necessary.

Example:  4D-BBS -u2

    V# Verbose Listing of CLP Settings and System Information

Verbose can be used as a debugging mode.  4D-BBS will send additional
information on the system status and defaults to the standard output.
These can include 4D-BBS file locations, successful file opens, current
window positions, size and positions of windows, fonts and font sizes
currently open, errors in data files, menus, and other important system
information.

If you are running 4D-BBS and redirecting output to the "NIL:" device,
nothing will be echoed, since this suppresses output.  The number following
the "V" parameter signifies the amount of information 4D-BBS will display.

If you are experiencing errors with 4D-BBS or getting erratic results from
a function, enable this mode to see if any additional information is given
to help you resolve the problem.  If you call for support on a problem, you
will be requested to run the BBS in this mode to aid in problem solving.

Example:  4D-BBS -V1 Range:  0-9

    v!  Enable 4D-BBS Function Announcements

Tells 4D-BBS to "talk" about user activity.  The "SPEAK:" device must be
mounted for this to work properly.

Example:  4D-BBS -v1

As many CLPs can be given as is necessary.  Please look through a few of
the scripts located in your "RunScripts" directory for more examples of
using CLPs.

NOTE:  If you are running multiple BBSs it is necessary to set each of them
to a different serial unit if you are not logging on locally.  4D-BBS will
handle changing the ARexx port name so it is a unique name.

3.2 Set Up

    4D-BBS gives you the flexibility to customize most settings from
within the BBS program.  The only files necessary to edit outside the BBS
program are the menu files.  You can edit text files from inside the BBS
program by using the text editor on the SysOp menu.  You may find it more
convenient to use your favorite text editor rather than the editor built
into the BBS program.

3.2.1 Understanding the System

    4D-BBS can be broken down into 6 different sections with a directory
or multiple directories to coincide with each section.  Although you can
change these directory paths using the "/D" parameter or the configuration
editor (see Appendix B), the default directory paths are:

        System Files Directory BBS:
    * Message Bases Directory BOARDS:
    * File Transfers Directory FILE:
    * Text Files Directory TEXT:
        Menus Directory MENU:
    * Users Directory USERS:
    * Doors Main Directory DOORS:

    Note:  As of V1.65 the "MAIL:" directory is no longer used, and the
default directory for local mail is "BOARDS:Board_0/".

    Directories marked with an "*" indicate a sub-directory exists.
(Refer to chapters 4-7 for more information on an individual directory.)

    Each of the above directories contain specific data files for that
section.  In most cases, 4D-BBS will not execute if the first 6 directories
and appropriate data files are not found.

    It is not necessary that all directories be located on the same
device.  You may assign them to any kind of device:  floppy drives,
external memory, hard disks, etc.  However, we DO NOT recommend you assign
"BBS:" or "USERS:" to memory.  These directories contain important system
and user data.  In the case of a power failure or system crash all these
files would be lost.  It is recommended to assign "MENU:" to memory as it
speeds up the menus.  4D-BBS does not update anything in the "MENU:"
directory.

3.3 Data/Text Files

    4D-BBS creates its own data files if you start from scratch, but the
above directory paths are necessary.  In addition, you will need the
following files.  Most files are supplied on the 4D-BBS disk.  You will
need to modify several of these files in order to customize your BBS.

    Text:  READMSG.HELP Message reading commands
    Text:  READMAIL.HELP Mail reading commands
    Text:  EDITOR.HELP Message entry system commands
    Text:  LOGON.TXT.ASCII Shown at logon before name entry
    Text:  LOGON.TXT.ANSI Shown at logon before name entry
    Text:  NEWUSER.TXT.ASCII Text sent to new user before registration
    Text:  NEWUSER.TXT.ANSI Text sent to new user before registration
    Text:  POSTNEWUSER.TXT.ASCII Text sent to new user after registration
    Text:  POSTNEWUSER.TXT.ANSI Text sent to new user after registration
    Text:  STATS.TXT.ASCII Shown at logon after name entry
    Text:  STATS.TXT.ANSI Shown at logon after name entry
    Text:  LOGOFF.TXT.ASCII Shown at logoff
    Text:  LOGOFF.TXT.ANSI Shown at logoff

    Boards:  origin.dat Default random tagline file for Fido
    Boards:  Board_#/origin.dat *Specific random tagline file for Fido sub
#
    Boards:  board_#/entry.txt *Text shown when user changes to sub #

    File:  Sect_#/FList.T *BBS stores file name and size for section #
    File:  Sect_#/Entry.txt *Text shown when user changes to section #

    Users:  new-list New user name only
    Users:  User-List All user names, locations, computers

    BBS:  Def_say.t Text strings for 4D-BBS
    BBS:  Lastcall.t Last callers and last words
    BBS:  Modemresp.dat Modem configuration
    BBS:  Personal.menu Pull-down menu commands
    BBS:  Sysdefs.d Default system parameters
    BBS:  Systotal.Dat System totals information
    BBS:  UserDefs.D Default users parameters
    BBS:  Waitscreen.txt Text shown while waiting for caller
    BBS:  XprSetup.dat XPR libraries configuration
    BBS:  BoardDefs.d Default message base settings
    BBS:  NetDefs.d Network address and information
    BBS:  FileDefs.d Default file transfer settings

                                *Path is default and definable in
editors.

    The first 3 files are the help files, which do not require changes.
The remaining files may be modified to suit your needs.  Examples are
included on the 4D-BBS disk.  You may use these to begin with.

    Some files have two versions; one for users who log on in ANSI mode
and one for users who log on in ASCII mode.  ".ANSI" files do not need ANSI
sequences, but ".ASCII" files should have plain text only.  You can produce
".ANSI" files with an ANSI text editor such as ANSI Master.

    The "LOGON.TXT" files are visible to the user after their modem
connects to the BBS and before the logon prompt appears.  "STATS.TXT"
files, which usually show the user's statistics, are shown after the user
has typed in their password.

    If you do not want these files to be shown, you may rename or delete
them.  The BBS will continue without producing an error message if these
files are not found.

    The "NEWUSER.TXT" file is shown to the user after they log on as "NEW"
and before the user registration procedure starts.  This file is often used
to explain your BBS and how the new user can sign up.

    "LOGOFF.TXT" file is shown when the user logs off.

3.3.1 Waiting Screen

    This is not required at the time of set-up, but you can design a
custom ANSI waiting screen in place of the default screen.  For this custom
screen, call your file "waitscreen.txt" and place it in the "BBS:"
directory.  Be sure to look at the section on embedded instructional codes
(Appendix A6), which will be very useful for your waiting screen.  (Refer
to Chapter 10 for more information regarding waiting screen commands.)



3.3.2 External Transfer Libraries:  BBS:XPRSetup.dat

    This file is for the configuration of XPR libraries.  Each library is
referenced in your "LIBS:" directory.  Normally case is significant in
using libraries.

    The first line of the file is the NUMBER of XPR libraries your system
has.  There is a maximum of 10 libraries.  After the first line, each
library will have 2 lines.  The first line will be the name of the library
as presented to the user.  The second line is a combination of the FULL
library name, a space, and any initialization options which the library
needs.  Refer to the individual library's documentation for a listing of
the initialization options.  An example file would be:

    1:  7
    2:  X-Compuserve
    3:  xprquickb.library
    4:  X-Kermit
    5:  xprkermit.library
    6:  Xmodem
    7:  xprxmodem.library T0,C0,K0
    8:  Ymodem-1K
    9:  xprymodem.library OFile:Sect_0
    10:  Ymodem-Batch
    11:  xprymodem.library YB,OFile:Sect_0
    12:  Ymodem-G
    13:  prymodem.library YG,OFile:Sect_0
    14:  Zmodem 1K
    15:  xprzmodem.library T?,ON,B5,AN,DN,RN,SN,PFile:sect_0

3.3.3 Keyfile for Registered Users

    Registered users will receive a keyfile with 4D-BBS.  This keyfile
needs to be named "4D-BBS.Key" and placed into the "BBS:" directory.

    Without the keyfile, 4D-BBS will be locked into DEMO mode, allowing a
maximum of 30 minute calls, 5 message bases, and 5 file transfer sections.

    Whenever a new version of 4D-BBS is released, install it according to
the instructions which accompany it, and you will be set.  The updates
should be freely available from any BBS.

3.4 Executing the Program

    Use the "StartBBS" script which the installer created to run the BBS.

    Several scripts are also included in the BBS package.  These scripts range
from SysOp one-time startup with workbench screen to normal continual wait
mode.  It is best if you familiarize yourself with the CLP list explained
earlier and write your own shell executable scripts.

    Think of the CLPs as a secondary configuration file:  you can alter
how the BBS runs without having to go into the configuration editor.  You
can look at a few of the scripts found in your "RunScripts" directory and
review section 3.1, to better understand how to customize the execution of
4D-BBS.  Once you understand what parameters you use most frequently, you
can use the configuration editor program to make these the default.  (For a
quick reference to the CLPs, see Appendix A3.)