home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Frozen Fish 1: Amiga
/
FrozenFish-Apr94.iso
/
bbs
/
oct93
/
comm
/
4d-bbsdemo.lha
/
4D-BBSDemo
/
Docs
/
03.Getting_Started
< prev
next >
Wrap
Text File
|
1993-07-02
|
25KB
|
687 lines
Chapter 3:
Getting Started
3.1.0 Command Line Parameters (CLP)
4D-BBS uses these command line parameters (CLP for short) to
allow you to customize it's behavior to suit your needs right from
startup! CLP's are basically arguments used in normal dos commands.
4D-BBS also uses a configuration file that does just about the
same thing the CLP's do, however a CLP will always override the setting
of the cfg file.
All parameters are proceeded with a / or - and should be spaced
apart BETWEEN THE PARAMTERS. 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 # should be replaced by a numerical value, and a $ should be
replaced by a character string. The ! following a CLP denoted the CLP
is switch. Without anything following, or a 0 following, 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 /, within spaces. The commands ARE case
sensitive.
Param Description
----- ------------------------------------------------
A! Enter ARexx Port Server Mode, Wait for Commands.
This brings ths bbs up in WAIT mode and does NOT monitor the
serial port. This mode is used mainly as an ARexx server.
Example: 4D-BBS -A
a$ ARexx Port Name.
This will allow you to change the 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. See
Chapter 10 for more information.
Example: 4D-BBS -aMyNewName.Port
B# True Baud rate of a /o call.
Lets 4D-BBS know the true baud rate if different than the serial
baud rate. Used for loggin, and tranfer time calculations.
Example: 4D-BBS -o1 -b19200 -B2400
Range: 300-115,200
b# Lock the serial baud rate.
This 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. See Chapter 12 for more information on
this.
W/O /o parameter: Lock Serial Port at rate.
With /o parameter: Serial Baud rate for call.
Example: 4D-BBS -b38400
Range: 300-115,200
C# Number of Last callers saved.
This 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
unacellerated Amiga, use 1 or two here to not only 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 datafile.
Datafile containg a list of alternative paths for 4D-BBS to use.
The format of the file is:
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# Hangup behavior of BBS
0 - Don't do anything to hangup (used in a spawn mode)
1 - Drop DTR to hang up modem
2 - Use "+++,,,ATH" to hangup 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 you if 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 -fMYCOOL4D.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 SystemHighBaud After every caller.
This is mostly used in conjuction with the other serial
and baud related CLP's. 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
diffrent baud rate comes in.
Example: 4D-BBS -h
H! Hide screen and don't make active when starting.
This CLP will tell 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 -H
I! Open 4D-BBS in iconified mode instead of full screen.
This is a very handy memory saving option. The user actually
receives a little faster response time because local screens and
windows are not updated. A small title bar will come up and give
you various system status reports including on-line users name
and what they are doing. You can uniconify 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.
This options allows you turn 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 turn your pull down menus
OFF to save memory and do not have an arexx script to turn
your keyboard back on 4D WILL NOT know your typing. There is
an option in the "Defs" pull down menu to toggle this option.
Example: 4D-BBS -K
L# Number of screen lines to use.
This CLP will set the lines displayable to the SysOp. If your
screen/window is not large enough 4d 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! Diasable pull down menus.
This will save some memory if you can live without the pull
down menus. You cannot use them at all if you set this CLP.
The AMIGA key's will not work either (EX: AMIGA C to chat)
The function keys are NOT disabled.
Example: 4D-BBS -M
m$ Replacement file for BBS:Modem.dat.
This allows you to use a different modem data file, in case you
have a few modems and don't want to edit the same file every
time you change the modem. Can also be user in a multiline
situation, when different modems are being used.
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 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.
If you do not run your BBS constantly (IE: a network frontend
spanws the BBS) a nice srcipt can be made to automatically log
you into the BBS using the -N and -P parameters. This would be
the exact same as hitting F10 for SysOp local logon at the BBS
wait screen.
If the user name contains a space in it, surround JUST THIS CLP
with double quation 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 be -o2, also).
This is mainly used by a network front end program to call up
4D-BBS when an carrier is already present. 4D-BBS will send
the opening logon screen, and act as if it had answered 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, 4D-BBS will not actually open the serial port.
No serial I/O will be checked during the session, but everything
else will function as a normal call.
See chapter 14 on Networking for more detailed information about
this.
Example: 4D-BBS -o1 -b19200 -B14400
P$ Forced User Password if using /o.
This works the same way as the "-N" CLP and is the user's
password. This CLP is ONLY used is 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! Tranfer types: RZ/SZ Externals(0) or XPR Libraries(1).
This parameter will determine whether the BBS used the XPR
libraries when transfering 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 very fast/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 multiline BBS, you MUST use XPR libraries.
Example: 4D-BBS -r1
S$ Set the Announce string.
If you want to get a quick message to the on-line user and don't
really want to enter into chat mode, you can use the pull down menu
command ANNOUNCE. This command will first look in ram: for a file
called "Tellem" 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 more for users that do not have Arexx, since 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 comamnds this number will represent the amount of
time given or taken. This number should always be a positive
value. The default is 10 minutes.
Example: D-BBS -T15
Range: 1-99
t# Inactivity timeout before auto-logoff.
How long the user can stay on-line without any activity is
determined by this CLP. The default is four minutes.
Example: 4D-BBS -t7
Range: 1-99
U# Time awared to user for uploads.
When a user uploads a file to the BBS, they can be rewarded by
being given extra time on-line for the upload. This CLP allows
you to set how many extra seconds per kilobyte upladed the user
is given. This function is defaulted to 0; now reward is given.
Example: 4D-BBS -U
Range: 1-99
u# Serial Unit Number.
This command allows you to use a unit other that 0. This can be
be used in conjunction with the -s CLP, but does not have to be.
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 much
information on the system status and defaults to the standard
output. These can include where 4D-BBS is looking for files,
files it finds, current window positions, size and positions
of windows, fonts and sizes currently open, errors in data
files, menus, and other important sytem information.
If you are running 4D-BBS and redirecting output to the NIL:
device, nothing will be echoed, since this suppressed output.
The number following the V parameter signifies the amount
of information 4D-BBS will display.
If you are having problems with 4D-BBS or getting erratic results
from a function, turn on this mode, and see if any extra
information is given to help you solve 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.
This CLP tells 4D-BBS to "talk" about what the user is doing.
The SPEAK: device must be mounted for this to work properly.
Example: 4D-BBS -v1
As many CLP's can be given as necessary. Please look through a
few of the scripts located in your "RunScripts" dir for more examples
of using CLPs.
NOTE: If you have mutiple 4D-BBS's running it id 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.0 Setting up 4D-BBS
4D-BBS is designed such that you can set up almost everything
from within the BBS program. As a matter of fact, the only files that
you need to edit outside the BBS program are the menu files and a few
text files, such as one for logging off. You still can edit all
those files from inside the BBS program by using the text editor on
the sysop menu, though it's more convenient to use your favorite text
editor than the one built into the BBS program.
3.2.1 Understanding The System
4D-BBS can be broken down into 6 different sections. These
sections each have a directory or multiple directories that coincide
with the section. Although you can change these pointers using the
/D parameter or the cfg_ed editor (see appendix B) the default
directory pointers 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 V2.86 the mail directory is no longer needed/used, and the
local mail is stored in the BOARDS:Board_0/ directory.
Directories denoted with a * mean a second level of directories
exists inside this directory. Refer to chapters four through
seven 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 run, if the first six
directories and appropriate data files are not found.
All of the directories do not have to be 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 outage or system crash all these files
would be lost. On the other hand, assigning MENU: to memory would be
an excellent idea! It will speed up the menus, 4D-BBS does not update
anything in the MENU: dir's.
3.2.0 Data Files:
4D-BBS is smart enough to create it's own data files if you start
from scratch, but the above assignments ARE necessary. In addition,
you will need a few text files which reside in the TEXT: directory. A
few are help files for the BBS system, and are supplied on the 4D-BBS
disk. You will need to create or modify other files, which are shown
to the user upon logging on and off.
Text: READMSG.HELP Info on Msg's help commands
Text: READMAIL.HELP Info on Mail help commands
Text: EDITOR.HELP Info on the editors(4d's)
Text: LOGON.TXT.ASCII Shown to user at logon
Text: LOGON.TXT.ANSI
Text: NEWUSER.TXT Text sent when a new user logs on
Text: STATS.TXT.ASCII Also shown at logon (if created)
Text: STATS.TXT.ANSI
Text: LOGOFF.TXT.ASCII Shown to user at logoff
Text: LOGOFF.TXT.ANSI
Boards: origin.dat Default random tagline file for Fido
Boards: Board_1/origin.dat Specific random tagline file for Fido
Boards: board_1/entry.txt *Text shown when user changes to Sub
File: Sect_1/FList.T *BBS stores your file names and sizes
File: Sect_1/Entry.txt *Text shown when user changes to sect
Users: new-list New Users names ONLY
Users: User-List All users names,locations,computers
BBS: Def_say.t Text strings for 4D-BBS to use
BBS: Lastcall.t Last callers and last words
BBS: Modemresp.dat Modem configuration
BBS: Personal.menu Pulldown menu (menu commands & DOS)
BBS: Sysdefs.d Default system Params
BBS: Systotal.Dat Pointers on system totals
BBS: UserDefs.D Default users Params
BBS: Waitscreen.txt Text shown upon startup
BBS: XprSetup.dat XPR Libraries configuration
BBS: BoardDefs.d All info about your custom board cfg
BBS: NetDefs.d Network Address and information
BBS: FileDefs.d All info about your custom file cfg
* The path is generic (Sect_1) can be anything.
The first three files are the help files, which you do not have
to change. The rest of the files you need to modify to suit your
needs. Examples are included on the 4D-BBS disk to give you a good
idea of what they are. You may use these to start out.
You may have noticed, some files have two versions; one for users
who log on in ANSI mode and one who log on in ASCII mode. ".ANSI"
files don't have to have 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 what the user sees after their modem
connects to your BBS and before the logon prompt appears. STATS.TXT
files, which usually show the user's stats such as how many calls have
been made, how many downloads, etc, are shown after the user has
typed in their password.
If you do not want these files to be shown for any reason, just
rename or delete them. The BBS will continue withut producing an
error message.
The NEWUSER.TXT file (no .ASCII or .ANSI extensions here...just
one 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 what your BBS is all about and how the new user can sign up.
As you may have already guessed, the LOGOFF.TXT file is shown
when the user logs off.
3.2.1 Waiting Screen:
This isn't required at the time of setting up, but if you have
been running the BBS for a while and get tired of looking at the same
old waiting screen you can actually design your own ANSI screen and
put it in place of the default screen. All you have to do is call
your file "waitscreen.txt" and put it in the BBS: directory. Be sure
to look at the section on embedded instructonal codes, which will be
veryt useful for your waiting screen.
3.2.2 The Default Sayings File: BBS:Def_Say.t
About 95% of all messages displayed when a user is on-line are
configurable. To change this, there is a file in your bbs: directory
called "Def_say.t". Because this file is extremely long (about 300
lines), trying to define all these would be impractical. You should
make a backup copy of this file before editing it. Most strings are
direct and you shouldn't have any trouble figuring out what the
string is saying and how you can alter it to meet your needs.
This file cannot have ANY new lines or CTRL M's embedded in it.
This will confuse 4D-BBS when reading in the file, and your string
will not print out correctly. The newline identifier is a "\n". Use
this when you wish to have a newline. A clear screen can be
accomplished by using a "\f". All Eic's and ANSI color codes and
animation along with 4D-BBS's <CTRL>P color codes will work. DO NOT
HAVE MORE THEN 99 CHARS TOTAL PER LINE!
3.2.3 Personal Pull Down Menus: BBS:Personal.Menu
You can setup your own set of pull down menu commands on the
4D-BBS screen. This allows the SysOp to execute any pre-defined menu
command instantly. AmigaDos commands are also accessable by
preceeding the command with an *.
The first line of this file is the number of entries (we'll call
this X). This tells 4D-BBS how many commands will follow. The next X
lines are each command as it will be printed in the pulldown menu. A
blank line will seperate these command from the next X lines. The set
is the actual string to be sent to the BBS. All EIC's and color codes
are allowed.
An example file would like like:
6
Umm Show time
Show Sub #
Lets run SpcEmp!
Run Sysop ONCE
Lets do a newcli
Lets Run Ppaint!
p 0
s s
c spcemp/SPCEMP
*DH0:4d -os -G -V
*newshell
*DH0:Ppaint
3.2.4 External Transfer Libraries: BBS:XPRSetup.dat
This file is for the configuration of XPR libraries. Each
library which is references should be in your libs: directory.
Normally case IS significant in using libraries.
The first lint of the file is the the NUMBER of XPR libraries you
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 individuals library's
documentation for a listing of the initialization options.
An example file would look like:
7
X-Compuserve
xprquickb.library
X-Kermit
xprkermit.library
Xmodem
xprxmodem.library T0,C0,K0
Ymodem-1K
xprymodem.library OFile:Sect_0
Ymodem-Batch
xprymodem.library YB,OFile:Sect_0
Ymodem-G
xprymodem.library YG,OFile:Sect_0
Zmodem 1K
xprzmodem.library T?,ON,B5,AN,DN,RN,SN,PFile:sect_0
3.2.5 Keyfile for Registered Users
Registered users should have received 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, you simple need to
install it according to the instructions which accompany it, and you
will be set. The updates should be freely available from any BBS.
3.3.0 Executing the Program:
Many scripts were included in the BBS package. These scripts can
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.
If you are using the default assigns from the cfg_ed editor, then
you will need to make proper assigns for these. If you are using full
paths, rather than assigns, you can skip to section 3.3.1.
To make the proper assigns, you need to execute (or type in) the
following commands. The last part of each command should be changed
to match your system's setup.
Assign BBS: DH0:4D-BBS/BBS
Assign FILE: DH0:4D-BBS/File
Assign MENU: DH0:4D-BBS/Menu
Assign TEXT: DH0:4D-BBS/Text
Assign USERS: DH0:4D-BBS/Users
Assign BOARDS: DH0:4D-BBS/Boards
Assign DOORS: DH0:4D-BBS/Doors
So, now that 4D-BBS knows where the proper locations for its data
files area you are ready to run it!
A script is already setup called "Fast" that will bring the bbs
up and automatically log you in. This script passes to 4D-BBS your
name and password and a few other params. If you wish to logon
yourself to see how things go, try the script "startnormal".
Think of the CLP's like a cfg file, you can alter how the bbs
runs without having to go into the CFG_ED program. You can look at a
few of the scripts found in your "RunScripts" dir and take a look at
the section 3.1.0 again, to get a better understanding of how to
customize the execution of 4D-BBS to meet your needs. Once you
understand what parameters you use most frequently, you can use the
CFG_ED program to make these the default.
For a quick reference to the CLPs, see Appendix 3.