home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Crawly Crypt Collection 1
/
crawlyvol1.bin
/
bbs
/
tb_doc02
/
the_box.doc
Wrap
Text File
|
1988-06-13
|
24KB
|
679 lines
THE-BOX
-------
Preliminary documentation for version 1.02
(C) 1988 by Jac Kersing.
This is the first document about the The-Box Mailer. The document is not
perfect but it is all there is. If anybody thinks (or may-be knows for sure)
he/she can do a better job he/she is VERY welcome. Till then you will have to
do with this.
INTRODUCTION
------------
The-Box is a stand-alone mailer package to be used with PANDORA BBS or a (to be
written) full-screen message editor. The mailer is capabel of sending and
receiving mail (even without a sysop chaperoning...). The-Box can also be used
as a front-end program for PANDORA or any other bulletin board program. It is
not compatible with the OMMM or DUTCHIE message packing programs (use of
different naming convention) so be carefull.
LICENSE
-------
Definitions:
IFNA: The International FidoNet Association, which can be reached at
FidoNet node 1:1/0, or by mail at:
International FidoNet Association
PO Box 41143
St. Louis, MO. 63141
U.S.A.
FidoNet: A public amateur electronic mail network, whose members are
registered with IFNA in St. Louis.
BBS: Electronic Bulletin Board System.
Registered BBS: A bulletin board which is a registered member of FidoNet, as
shown by the most recent node list published by IFNA.
Sysop: The person in charge of the maintenance and operation of any
given BBS.
License:
Each sysop of a registered noncommercial BBS is hereby granted a limited
license to use The-Box as follows:
- You may use the program ONLY in conjunction with the operation and
maintenance of your BBS.
- You accept full responsebility for whatever happens or fails to happen.
- You may copy and distribute the program freely, but ONLY to other sysops.
- You may not charge a fee for copying and distributing the program.
- You may not distribute copies which have been modified in any way.
- You use the program in a friendly way, in accordance with the local law.
- You may only post this program in a BBS where it can be downloaded without
any charges at all.
- You may not use this program in a commercial environment or in a governmental
organisation.
- non-commercial users must register by sending a postcard to the adress below.
You are not allowed to use The-Box in any way if you fail to do this! (Messages
not allowed, a real postcard by the real old-fashioned mail!)
Commercial users:
For commercial use please contact Jac Kersing at 2:283/102 or:
Jac Kersing
Akeleiweg 13
8042 CG Zwolle
The Netherlands.
Support:
User support is voluntary for noncommercial systems. You may not use this
program in a commercial environment or in a governmental organisation without
permission. Please contact above adress for this.
If you have any questions regarding this program then please send them to:
Jac Kersing 2:508/17, topic: The-Box. Or post them in the The-Box and Pandora
Bugs Echomail area at any BBS supporting this echo.
I will try to answer them as soon as possible, but no promisses! (as stated
before user support is VOLUNTARY and I have only 24 hours a day.....)
DISCLAIMER
----------
I accept no responsibility for anything at all. You use this program at your
own risk, if it destroys your system and/or your software I am just VERY very
sorry.
THE-BOX
-------
The-Box is a mailer program. This means that the program is able to receive and
send mail packets from/to other FidoNet compatible programs. The program can be
used as a terminal with serveral down/upload protocols also.
The-Box can be used in several different set-ups. I will cover them first.
SET-UP
------
- Point setup.
This is the lowest level on wich The-Box can work. In this configuration you
do not need the external programs except the editor. (There is no full screen
editor at this moment. You can simply use PANDORA for this purpose.) The-Box
only knows about your boss node, so all mail will be routed through him. Mail
to all adresses will be accepted without check for existance of the destination
node.
- Mail interface for BBS.
In this set-up The-Box accepts all mail for your bulletin board. If a human
user tries to log on, The-Box will start the BBS (if allowed at that time).
The-Box can also be set-up to take care of all other periodical tasks that have
to be performed. In this mode you MUST have a valid node-number because all
mail will be send according the FidoNet routes.
-------------------------------------------------------------------------------
I will continue with this part later on.
Will describe the control file with its valid commands now.
Please read this part carrefully because it SEEMS to be just like BinkleyTerm
BUT some things do differ!
-------------------------------------------------------------------------------
REQUIREMENTS
------------
What you absolutely need to run The-Box:
- Atari ST. The box is tested on an Atari 520ST. I don't expect any problems at
1040 machines. The MegaST may cause some problems because it has a different
TOS version (I tested The-Box on my 520ST with MegaTos and no problems occured,
so I think it's save to use it).
- A command-line shell. This is not an easy subject cause the shell MUST have
the following capabilities: environment (SET command), batch processing WITH
errorlevels and (if the SPAWN mode of The-Box is used) ability to run a program
or batch-file supplied at startup of the shell. If SPAWN is not used PCommand
(shareware) will do, else you will need something like Michtrons Command.prg.
(We're working on our own product. It will be supplied along with the other
programs as soon as it is ready.)
- Diskspace. It is difficult to specify the amount actualy needed, but for a
point with about 3 echomail areas at least 720K must be present.
- As much ram as possible. The ram is used for the program (about 160K ram at
the moment) and (if possible) a ramdisk.
THE CONTROL FILE
----------------
All changes from version 1.00 to version 1.02 can be located easily. They are
marked by ==== under the keyword.
The behaviour of The-Box is controlled by a couple of files. The most important
are the control file and the event file.
This section covers the control file and all valid command. The next section is
for the event file.
The control file is a free style ascii format, case is unimportant. It can be
made using any standart program editor (no Wordstar in document mode, WP or
First Word here!).
The file may be located at two positions. The easiest way is to place it in
the same directory in which The-Box is found. The second (better way in my
opinion) is to place the file in a sub-directory. Now you'll have to tell
The-Box where it can find the file. This is done by an environment variable
called MAILER. The-Box will search the environment for this variable and use
the path specified for almost all files it needs. (See appendix for the use of
environment.)
Example:
If your control file is located on disk B, in the sub-dir MAILER, then use:
SET MAILER=b:\mailer\
The-Box will find the control file (and the other) correctly now.
Valid commands in the control file:
OVERWRITE
---------
This command means that if an incomming file (from another mailer) has the
same name as an already existing file, the new file will overwrite the old one.
This results in a loss of the old file.
If not specified the new file will be renamed, but this will be done only
ONCE. If another file with the same name is received the second file will be
lost.
UNATTENDED
----------
Tell The-Box that it is running without a sysop controlling. The-Box will look
for the correct event and execute this. Format:
UNATTENDED
NODE
----
Specify the nodenumber for this bulletin board. The correct format is:
NODE <zone>:<net>/<node>
AKA
---
Specify an also know as adress. Mail for these nodes is not send but
considered to be at the destination node. Only one AKA may be specified at a
line. Format:
AKA <net>/<node>
POINTNET
--------
Specify the netnumber of our pointnet. Only used by a normal BBS that has some
points. Format:
POINTNET <number>
BOSS
----
Specifies the network number of your boss node. Used by points only. Format:
BOSS <net>/<node>
The zonenumber is not specified because it must be the equal to yours.
BOSSPHONE
---------
Specifies the phone number to be used when calling your boss. Used by points
only. Format:
BOSSPHONE phonenumber
MAILER
======
This keyword must be followed by ONE of the following (insert more lines if
more than one is needed):
no-zedzap - The mailer won't use zmodem file-transfers now.
no-init - The modem won't be initialized every ten minutes.
no-smart - The mailer will behave as stupid as possible.
The command is not usefull for normal users, but it may be usefull during
testing or for advanced users. Format:
MAILER NO-INIT
NO-OVERDRIVE
============
Do not use the SEAlink overdrive mode when transmitting at baudrates higher
than 2400 baud. The-Box will automatically select overdrive mode when the
baudrate exceeds 2400bd.
NOPICKUP
--------
Do not pickup mail for us when we're calling. The route-file of EXPORT may
override this command. Format:
NOPICKUP
LOCAL-COST
==========
Specify the cost for the local events. All mail that can be sent without
exceeding this cost will be sent. The cost for sending the mail to a node is
extracted from the nodelist. Format:
LOCAL-COST <number>
EDITOR
------
Specifies the name of the external message editor. This editor can be started
from The-Box. You should check if enough memory is available to run this
program. Format:
EDITOR path\progname.ext
BBS
---
Specify the methode in which the bulletin board program should be started when
a user calls in. The two possible methods are:
- EXIT. This causes The-Box to terminate operation with an errorlevel equal to
the baudrate of the caller.
- SPAWN. Now The-Box will try to run the command-line shell with the command:
SPAWNBBS baudrate 0 timeleft
You should have a batch file with the name SPAWNBBS for this function to work
properly. (AND specified the SHELL in your environment, see appendix)
LOGLEVEL
--------
Specifies the 'level' for message logging. The messages will be left in the
log-file (if specified). All messages will be showed at the display.
The different levels are:
- 6 ERRORS only. At this level only severe errors (OS errors etc.) will be
written to the log-file.
- 5 ...... All start and stop times (of events) are also logged.
- 4 BRIEF. Add received mail reports to log-file.
- 3 NORMAL Created mail also logged.
- 2 DETAILED Call information is also logged.
- 1 VERBOSE All file transfer information is added.
- 0 SUPER VERBOSE Modem messages also logged.
Use 0 only for debugging purposes because it creates a very very big log-file.
STATUSLOG
---------
This command defines the name of the file to be used for logging purposes.
Format:
STATUSLOG path\name.ext
SYSTEM
------
Specify the name of your System. This name is send to the other system is
advanced mail is used. Format:
SYSTEM <string>
The name should be 59 or less character long. Longer names will be terminated
by the program.
SYSOP
-----
Specify your name. Used for the same purpose as the SYSTEM name. Format:
SYSOP <string>
HOLD
----
Specify the path for the packets (and other internal used files) The-Box has
to send.
Example:
HOLD b:\outmail\
The directory outmail on the B drive will be used by EXPORT to store all
outgoing mail.
Format:
HOLD <path>
NOTE: This directory must be empty at the beginning and should not be used for
ANY other purpose. Please do not use it yourself at any time. The-Box and
utilities will take care of everything.
NETFILE
-------
Specify the path for all incomming files. ALL files received by the mailer
will be stored here. You should check the incomming files regulary.
format:
NETFILE <path>
NOTE: Do not delete file with the extension .pkt, .su?, .mo?, .tu?, .we?, .th?,
.fr? or .sa? IMPORT will take care of these.
NETMAIL
-------
Specify the path for the network messages. This path MUST include the number
of the message file. Example:
NETMAIL b:\msgs\0004
Message area 4 is the netmail area. The message file can be found in the
directory msgs at drive B. Format:
NETMAIL <path><areanumber>
NOTE: The areanumber should contain 4 digits.
DOWNLOAD
========
Specify the directory for files downloaded from within the terminal mode.
Format:
DOWNLOAD <path>
BAUD
====
Specify the baudrate at which the modem will be initialised. This speed is
only used at moment The-Box does not know the modem speed. If a caller is
detected Pandora will switch to the correct speed automaticaly.
It is also possible to have The-Box work at one baudrate all the time. This
can be done by adding the keyword LOCKED between the other words. Format:
BAUD [LOCKED] <speed>
PORT
====
This is a PC only command. It is used to specify the portnumber which The-Box
has to use. Valid numbers are 1 through 8. Format:
PORT <number>
SLOWMODEM
=========
If your modem is not that fast you should add this keyword to your control
file. The-Box will send characters to the modem one by one afterwards.
Format:
SLOWMODEM
INIT
----
Specify the string for modem initialisation. This string will be send to
The-Box every 10 minutes when in unattended mode and at the start of the
program. The init string should NOT contain an auto-answer sequence. The-Box
will check for the phone rings itself and use the ANSWER string for answering
the call. See below for more information on modem strings. Format:
INIT <string>
PREFIX
------
Specify the string for a dail command. This is the first part of the string
(before the number). Format:
PREFIX <string>
SUFFIX
------
Specify the second part of the dail string. This part comes after the
phonenumber. Format:
SUFFIX <string>
RESET
-----
Specify the modem reset string. This string will be send to the modem at
NORMAL program termination. Not send when a caller is connected. Format:
RESET <string>
ANSWER
------
Specify the modem answer string. This string will be send to the modem after
detection (twice) of RING (or RINGING). This string should be used for
answering the phone at this moment only, not for global responce! (So it should
be something like AT A NOT AT S0=1!!!) Format:
ANSWER <string>
BUSY
====
The busy string is sended to the modem every time The-Box executes an external
event (see later on) with an errorlevel of less than 50. Users will get the
busy tone when calling during these events. In addition the INIT string should
be set-up to make the modem hang-up the phone. Format:
BUSY <string>
BANNER
------
Specify the string shown to the caller at the moment he is connected. This
could be the name of your BBS or some important information. It can be one line
only. If more information is needed the file BANNER.TB should be used (max 2K
information!). The-Box will send a line with your node/point number itself. The
caller sees something like this:
+ The-Box v1.00; Node 2:508/17.0; (C) Copyright 1988 by Jac Kersing<CR><LF>
Your banner<CR><LF>
Format:
BANNER <string>
START-BBS
---------
Specify the string to show to the caller when starting the bulletin board
program. This string is send to the caller at the moment The-Box starts your
bulletin board program. Format:
START-BBS <string>
PASSWORD
========
The password are used to protect mail. If a node polls (or The-Box is polling
a node) the password will be transmitted by the calling side. If the passwords
do not match The-Box will immediately hangup. In case a mailpacket was received
it will be renamed to <name>.BAD.
The first argument of password is the password to use. Only 6 characters are
used and all characters will be upper-cased by The-Box.
Next a list of nodenumbers occurs seperated by spaces. Valid numbers are:
2:508/17, 2:508/all, 2:all, all
Format:
PASSWORD <password> <nodenumber> ....
ABOUT
=====
This specifies the name of a file containing some information about your
system. This file will be transmitted whenever the other mailer requests a
non-existend file or the ABOUT file. Format:
ABOUT <filename>
AVAIL
=====
This specifies the name of a file containing a list of all files that can be
requested at your system. This file does not have a standard format and is not
used by The-Box (only transmitted on request). Format:
AVAIL <filename>
OKFILE
======
This is an extremely important file. It contains all filenames, wildcards etc
for files that may be requested. See later on in this manual for details (not
right now, I haven't got the time to write something, see Binkley man for now).
Format:
OKFILE <filename>
MAX-REQUEST
===========
Specifies the maximum number of files that may be requested. The-Box will not
send anymore files during this connection (so the other side may call back
right after The-Box dropped the line) if this number is exceeded. Format:
MAX-REQUEST <number>
The modem strings may contain any valid modem command and the characters '|'
and '!'. These character will be translated to a <CR>. Which of the two you use
depents on the situation. Using a '|' will cause The-Box to wait for a valid
responce from your modem (like OK) before the next command will be issued. When
you are using '!' The-Box will only wait for 1 second after the command.
For example, a valid INIT string is:
INIT AT Z|AT M0 E1 S0=0 X4|
Not valid is:
INIT AT Z|AT M0 E1 S0=1 X4|
~~~~
(Remember: no auto-answer in the init string!)
NOTE: The RESET and INIT strings must be terminated with '|' or '!', PREFIX may
not be terminated at all and ANSWER and SUFFIX must be terminated with '|'.
THE SCHEDULE
------------
This section covers the schedule. The schedule determins the behaviour of
The-Box at a certain moment. The configuration controls the overal behaviour,
the schedule at a certain moment.
The file for the schedule is THE-BOX.EVT and it should be in the same directory
as the config. The-Box will create a file named THE-BOX.SCD itself. This file
is for internal purposes only and should not for any reason be modified (or
accessed by any other program).
If you change the event file The-Box will automatically detect it's a new
version. All forced events earlier that day will not be executed. If they
should be the command-line option FORCE must be used.
The schedule file contains lines like:
Tag day(s) start-time [end-time] [flags]
The meaning of these fields is:
TAG
---
The tag for which the mail should be packed. As soon as The-Box finds an event
with a valid tag it will exit to the external mail packer to pack the mail for
this tag.
There is a special tag called the 'Z'-tag. The-Box won't exit for a 'Z'-tag.
This tag can be used non mail events (the packer won't pack any mail either,
even if it is called!).
The second special case is the '#'-tag. This is no valid tag as it is, but it
has to be followed by a valid tag. The-Box won't exit for this tag, but if the
packer is called (after receiving mail or something like that) all mail for
this event will be packed.
The third (and last) special case is the 'X'-tag. This tag must be followed by
any number from 8 till 300. This causes The-Box to exit with the errorlevel
specified by that number.
Valid tags are for example:
A , Z , S , #A , #S , P , X10 and X255
Not valid:
A# , #Z , #X10 .
DAY(S)
------
This field may contain any of the next (or a combination of them):
SUN , MON , TUE , WED , THU , FRI , SAT , WEEK , WKEND and ALL
More days can be used by seperating them by '+'.
Examples:
SAT+SUN (== WKEND) , WEEK+SAT , MON+TUE+THU
START-TIME
----------
The time this event has to be executed. This may be any time between 0:00 and
23:59. The format is [h]h:mm. Only one event may be valid at any time, so no
two start-times may be equal.
END-TIME
--------
The time this event ends. This may be any time between 0:00 and 23:59 as long
as it is AFTER the start-time and does not pass into the next day. The end-time
is optional for external events.
FLAGS
-----
Valid flags are:
A - Average wait time. The time (+-50%) in seconds to pause between two calls.
Format: A=<nnn> , with 0<nnn<240.
B - BBS. The-Box may start the BBS during this event. Format: B
C - Crash mail. Send waiting crashmail packets. Format: C
D - Dynamic event. This event will terminate as soon as all mail has been send.
Format: D
F - Forced event. This event is always executed, even if the current time is
after the ending time of the event. Format: F
L - Local mail only. During this event mail is only send to nodes with cost
zero. Format: L
M - Mail exit codes. Exit with the specified errorlevel after (arc)mail is
received. Format: M=<mail>,<arcmail> 8<(arc)mail<300.
R - Receive only. No outgoing calls will be made during this schedule.
Format: R
S - Send only. The-Box does not honour incomming calls during this schedule.
Format: S
T - Tries. The number of tries to get the mail to a certain node out.
Format: T=<connected calls>,<not connected calls>
( 0 < calls < 36)
COMMAND LINE OPTIONS
--------------------
The-Box has a couple of command line options, they are:
FORCE - Force all old events. This can be used in those cases you have
===== changed the event file and you want to run all forced events
earlier that day.
DYNAM - Restart dynamic events.
UNATTENDED - Tell The-Box it's running from a batch file.
(Avialable in the config file also.)
BANNER
------
The banner is a text shown to the caller just after The-Box has told which node
is called. It may be specified in two ways. The first is in the control file.
This is the easiest way, but it can only be used for one line of text. If you
want to use more than one line the file BANNER.TB must be used. This file
should be in the some directory the config file is found.
The file may contain ANY printable ascii character. The maximum file length is
2048 characters.
APPENDIX A
----------
As stated before you should use a command-line shell to run The-Box. This
because you will need the batch-file processing and the environment. GEM does
not actively support the environment and no batch-files at all.
The environment:
----------------
First check for the existance of the word SET in the shell. This can be done
easily by typing SET<return>. If the responce is something like 'command not
found' or 'program not found' you will have to look for an other command-line
shell.
To set the path for The-Box simply enter:
SET MAILER=your_path<return>
example:
SET MAILER=b:\mailer\<return>
Notes:
- Use no spaces in the SET command, they are used as delimiters.
- Do not forget to add the backslash ('\') at the end of your path.
The SHELL:
----------
The-Box uses the environment to find the name of the shell it has to run. This
name can be specified by SETting SHELL to the correct program name.
Example:
SET SHELL=a:\command.prg