Source: SPITFIRE.DOCEdition: searchable Web reading editionPresentation: historical wording retained
5.0 - SPITFIRE FILE PATHS
-------------------------
SPITFIRE supports paths for the files which are accessed in the
process of its execution. Using the individual file paths created
by SPITFIRE (SYSTEM, WORK, MESSAGE, DISPLAY and EXTERNAL), your
directories are more manageable.
The SYSTEM files path is the directory in which you have set up
SPITFIRE (usually C:\SF) and contains files required for the execution
of SPITFIRE. The WORK files path contains files which SPITFIRE
accesses and writes to periodically in the process of program
execution. The DISPLAY files path contains all files which are
displayed to the caller while logged on the BBS. The MESSAGE files
path contains all files used by the message section of SPITFIRE. The
EXTERNAL files path includes the files necessary to provide the caller
with optional transfer protocols other than those provided in SPITFIRE.
**NOTE** All DISPLAY files are optional. Should the Sysop choose
not to use these files, SPITFIRE will operate just fine. In fact,
SPITFIRE will in most instances display a default message if a display
file is not found. The DISPLAY files merely provide an additional
means by which the Sysop can create unique screens to personalize
their BBS system.
The system files that were created when setting up SPITFIRE
MUST reside in the main SPITFIRE directory (also referred to as the
SPITFIRE Home directory). The WORK, MESSAGE, DISPLAY and EXTERNAL
file paths are created by SPITFIRE or can be modified by pressing
ALT+P at the "SPITFIRE Ready For Use" prompt. (Refer to the section -
CONFIGURING SPITFIRE FILE PATHS of the SPITFIRE manual.)
The following sections discuss, individually, files used by
SPITFIRE. After the file description, a (SYSTEM), (WORK), (MESSAGE)
or (DISPLAY) is included to help you determine in which directory the
file should be placed. No files which will be used in your External
Protocol Path will be found. These are not included in the SPITFIRE
package because these are separate programs written by other
programmers.
5.1 - SPITFIRE SYSTEM FILES
---------------------------
There are five file types that comprise SPITFIRE and allow it
to function - System, Work, Message, Display and External Protocol.
The first is SYSTEM FILES. System Files are mandatory for
SPITFIRE's operation and MUST reside in your main (also referred to
as HOME) SPITFIRE directory from which you run SPITFIRE.
SPITFIRE.EXE - Main System Program. (SYSTEM)
SPITFIRE.OVR - SPITFIRE Overlay File. (SYSTEM)
SFMAIN.MNU - SPITFIRE Main Menu. (SYSTEM)
SFMSG.MNU - SPITFIRE Message Menu. (SYSTEM)
SFFILE.MNU - SPITFIRE File Menu. (SYSTEM)
SFSYSOP.MNU - SPITFIRE Sysop Menu. (SYSTEM)
The above-mentioned files MUST be present for SPITFIRE to run.
SPITFIRE will halt if these files are not found in the directory from
which you are running your system.
The following system files will be created by SPITFIRE if they
are not already present.
SFNODE.DAT - Configuration information for this node. (SYSTEM)
SFFAREA.DAT - File Area system information. (SYSTEM)
SFMCONF.DAT - Message Conference system information. (SYSTEM)
SFEVENTS.DAT - Stores information regarding scheduled events.(SYSTEM)
Other system files which will need to reside in the SPITFIRE
home directory include:
SFREMOTE.BAT - Used for remote Drop to DOS. (SYSTEM)
SF.BAT - Batch file for invoking SPITFIRE. (SYSTEM)
SFMAIN.BAT - Executes Sysop configurable command option
available from the Main Menu. (SYSTEM)
SFMAIN.DAT - File created that contains caller information.
SPITFIRE creates this file when a caller uses
the Main Menu Sysop Configurable Command to
execute a third party program. This file is
automatically erased when the caller returns
to SPITFIRE. (SYSTEM)
SFMESS.BAT - Executes Sysop configurable command option
available from the Message Menu. (SYSTEM)
SFMESS.DAT - File created that contains caller information.
SPITFIRE creates this file when a caller uses
the Message Menu Sysop Configurable Command to
execute a third party program. This file is
automatically erased when the caller returns
to SPITFIRE. (SYSTEM)
SFFILE.BAT - Executes Sysop configurable command option
available from the File Menu. (SYSTEM)
SFFILE.DAT - File created that contains caller information.
SPITFIRE creates this file when a caller uses
the File Menu Sysop Configurable Command to
execute a third party program. This file is
automatically erased when the caller returns
to SPITFIRE. (SYSTEM)
SFSYSOP.BAT - Executes the Sysop Configurable Command option
that is available from the Sysop Menu. (SYSTEM)
SFSYSOP.DAT - File created that contains caller information.
SPITFIRE creates this file when a caller uses
the Sysop Menu Configurable Command option.
This file is automatically erased when the caller
returns to SPITFIRE. (SYSTEM)
SFDOOR.MNU - SPITFIRE Door Menu. (SYSTEM)
SFDOORS.DAT - File created that contains caller information.
SPITFIRE creates this when a caller uses the
SPITFIRE door feature and erases it when the
caller returns to SPITFIRE. (SYSTEM)
DOOR.SYS - Universal door file that contains caller information.
SPITFIRE creates this when a caller uses the
SPITFIRE door feature. (SYSTEM)
SFORDER.MNU - SPITFIRE Questionnaire/Order Menu. (SYSTEM)
SFCHAT.CAP - Text file of chat captures. (SYSTEM)
CALLERS.TMP - Temporary file for recording callers' activity.
This file is later appended to CALLERS.LOG file
in the WORK file path and erased. (SYSTEM)
DAILYLMT.DAT - Determines daily time limits, number of downloadable
files and bytes, quick log on capability, number of
node chats, etc. for each security level (SYSTEM)
SFINIT.BAT - Batch file, if found, is executed after the caller
logs off and prior to initializing the modem. (SYSTEM)
SFLOGON.BAT - Batch file, if found, is executed when a caller logs
onto the BBS and after the system information is
displayed. (SYSTEM)
SFSEC<X>.BAT - Batch file, if found, is executed after a caller
logs onto the BBS provided the caller's security is
equal to <X> of the SFSEC<X>. (SYSTEM)
BADINIT.BAT - Batch file executed when modem initialization fails,
i.e., SPITFIRE reports the modem is not responding
properly. (SYSTEM)
SFFAX.BAT - Batch file executed after SPITFIRE answers the phone
and testing establishes the incoming call is a fax
connection. (SYSTEM)
SPITFIRE.HLP - Help with all commands for all menus. This file can be
modified using SFHELP. Consult the documentation
accompanying SFHELP. NOTE: Systems using the
Sysop Configurable Command option(s) will need to
modify this help file with SFHELP to include an
explanation of the added feature(s). (SYSTEM)
SFPROTCO.HLP - Extra help with Uploads/Downloads. This is a simple
text file that you can modify with your favorite text
editor, provided it saves in ASCII format. (SYSTEM)
LAKOTA.COM - SPITFIRE companion utility which allows messages
to be downloaded and uploaded in QWK format. (SYSTEM)
SFPCKMSG.COM - SPITFIRE companion utility which purges old
messages from the message base. SPITFIRE shells to
SFPCKMSG.COM when packing messages, either as Event M
or from the Sysop Menu. (SYSTEM)
SFPCKUSR.COM - SPITFIRE companion utility that purges inactive
callers and/or callers that are marked for deletion
from SPITFIRE's caller database, SFUSERS.DAT. (SYSTEM)
FA<x>.TXT - Text file which contains the drive and directory
of extended download directories for the appropriate
File Area. <x> represents the File Area number.
(SYSTEM)
The SFREMOTE.BAT, SFPROTCO.HLP, SFDOOR.MNU, SFORDER.MNU, SF.BAT,
DAILYLMT.DAT, SPITFIRE.HLP, SFINIT.BAT, SFSEC<X>.BAT, SFLOGON.BAT,
SFMESS.BAT, SFMAIN.BAT, SFFILE.BAT, SFSYSOP.BAT and BADINIT.BAT may be
edited to your own personal tastes.
*NOTE* Any Sysop operating a multi-node system must have a copy of
all the system files being used by a particular node in that
node's main SPITFIRE directory. While some files such as
SPITFIRE.EXE are mandatory, other files, such as SFINIT.BAT,
may be optional.
5.2 - SPITFIRE MESSAGE FILES
----------------------------
All files relating to message conferences reside in the MESSAGE
file path. SPITFIRE supports up to 784 message conferences and for
each message conference on the system a SFMSG<X>.DAT, SFMSG<X>.PTR,
SFMSG<X>.LMR and SFMSG<X>.IDX file is created. (<X> refers to the
number of the corresponding message conference and will range from
1 to 784.)
SFMSG<x>.DAT - All messages are contained here. (MESSAGE)
SFMSG<x>.PTR - Message data pointer file. (MESSAGE)
SFMSG<x>.IDX - Message index file. (MESSAGE)
SFMSG<x>.LMR - Last message read pointer file. (MESSAGE)
* NOTE * Any Sysop operating a multi-node system should be aware that
SPITFIRE allows all nodes to share a common MESSAGE file
path.
5.3 - SPITFIRE WORK FILES
-------------------------
The third file type is WORK FILES. Although not all of these
files are required to run SPITFIRE, you will, no doubt, find them
invaluable in the operation of your BBS system. These files are
accessed routinely and are periodically written to during the course
of SPITFIRE's execution. If the REQUIRED work files are not found,
SPITFIRE will create them, with the exception of SFCALLOG.DAT. The
SFCALLOG.DAT is not created, but included in the SPITFIRE distribution
package and must be copied over to the directory configured as the
WORK FILE PATH. (SFNEWU.QUE, SFORDER<x>.QUE, SFUPCASE.DAT, SFNOUP.DAT
and SFMSGPCK.BAT are not required and must be created by the Sysop.
SFSYSTEM.DAT - Starting date, number of callers, etc. (WORK)
SFUSERS.DAT - Caller data file. (WORK)
SFUSERS.PTR - Caller data pointer file. (WORK)
SFUSERS.LST - Text file created when caller's data file is
printed to disk from the Sysop Menu (WORK)
CALLERS.LOG - Record of the BBS callers' activities. (WORK)
SFCALLOG.DAT - Stores information used to write CALLERS.LOG. (WORK)
HEYSYSOP.LOG - Record of special Sysop notification. (WORK)
SFNEWU.QUE - New caller questionnaire. (WORK)
SFNEWU.REP - Contains new caller questionnaire replies. (WORK)
SFORDER<x>.QUE - Questionnaires/Order Forms available to callers
from the Main Menu. (WORK)
SFORDER<x>.REP - Contains callers' responses to the Main Menu
Questionnaires/Order Forms. (WORK)
JOKER.DAT - List of undesirable caller names. (WORK)
SFBBSLST.DAT - Contains list of other boards to call. (WORK)
SFILEREQ.LOG - Log file of caller's file requests for files
that are stored OFFLINE or which are included
in the SFFILES.BBS list but can not be found
in the download directory. (WORK)
SFUPCASE.DAT - Keywords in a file description that will
be converted to upper case. (WORK)
SFNOUP.DAT - List of files the Sysop does not want uploaded
to the BBS. (WORK)
SFMSG.TXT - A text file that can be imported when entering
or replying to messages if logged on locally. (WORK)
SFMSGPCK.BAT - Batch file, if found, is executed immediately
after packing the message base. (WORK)
SFPURGED.USR - List of callers purged from the BBS. Contains
caller's name, address and security level at the
time of the purge. (WORK)
SFWHOSON.DAT - Contains information regarding who is logged onto
each node. (WORK)
BBSNAME.DAT - Net-mail tag line data. (WORK)
** NOTE ** Any Sysop operating a multi-node system should be aware that
SPITFIRE allows all nodes to share a common WORK file path.
5.4 - SPITFIRE DISPLAY FILES
----------------------------
SPITFIRE display files must be placed in the directory which the
Sysop has configured as the DISPLAY FILE PATH. SPITFIRE display files
use three graphic formats. Files with an extension of .BBS use the
ASCII (non-color) format. Files with an extension of .CLR use the ANSI
(color) format. Files using a .RIP extension use the Remote Imaging
Protocol, commonly referred to as RIP graphics format.
If the display files are not found, SPITFIRE will run just the
same and in many instances display a default message to the caller.
Display files can be created using your favorite text editor or screen
generating program.
Below is the list of display files available in SPITFIRE. In
this listing, as well as throughout the remainder of the manual, if the
display file name is followed by the code characters [BCR], it can be
created using each of the three graphic formats, using the appropriate
extension of .BBS (ASCII), .CLR (ANSI) or .RIP (RIP). If the display
file name is followed by the code characters of [BC ], it can be
created using the graphic format with the appropriate extension of .BBS
(ASCII) or .CLR (ANSI). If the display file uses a specific graphic
format, the appropriate extension will follow the display file name.
For instance, .BBS would indicate the file must be created using the
ASCII format only. The display file a caller sees will depend on the
Graphic mode the caller selects when logging onto the BBS.
<x>.[BCR] - Displays to the caller at log on if the caller record
number equals <x>. (DISPLAY)
<x>SEC.[BCR] - Displays to all callers with a security level equal
to <x>. (DISPLAY)
ALL.[BCR] - Displays to all callers upon log on, unless their
security allows for a quick log on. (DISPLAY)
BULLETIN.[BCR] - Menu listing of bulletins (BULLET<x> files) available
to the caller. (DISPLAY)
BULLET<x>.[BCR] - Displays to the caller when <x> bulletin is selected
from the Bulletin Menu where <x> can equal 1 to 99.
(DISPLAY)
CHATDONE.[BC ] - Displays to callers after completing a chat with the
Sysop. (DISPLAY)
DLMT.[BCR] - Displays to callers when downloads exceed the daily
limit. (DISPLAY)
DORBUL<x>.[BCR] - This file displays to callers when <x> bulletin
is selected from the Door Bulletin Menu, where
<x> can equal 1 to 99. (DISPLAY)
EVENTIME.[BCR] - Displays to a caller who logs on and has their log
on-time adjusted so an on-time event can be completed
at a specified time. (DISPLAY)
FILECTRL.RIP - RIP graphic display file which can be used as a
control panel while the caller is in the File section
of the BBS. (DISPLAY)
FILE<x>.[BCR] - File menu that is displayed to callers whose security
level is equal to <x>. (DISPLAY)
FILST<x>.[BCR] - Listing of available File Areas to callers whose
security level is equal to <x>. (DISPLAY)
GOODBYE.[BCR] - Displays to callers when logging off the BBS.
(DISPLAY)
LOCKOUT.[BCR] - Displays to a caller at log on if the caller is
marked as locked out or is found in JOKER.DAT.
(DISPLAY)
MAINCTRL.RIP - RIP graphic display file which can be used as a
control panel while the caller is in the Main section
of the BBS. (DISPLAY)
MAIN<x>.[BCR] - Main menu that is displayed to callers whose security
level is equal to <x>. (DISPLAY)
MAXUSERS.[BCR] - Displays to new callers when the maximum number of
callers have been reached. (DISPLAY)
MSGCTRL.RIP - RIP graphic display file which can be used as a
control panel while the caller is in the Message
section of the BBS. (DISPLAY)
MSG<x>.[BCR] - Message menu that is displayed to callers whose
security level is equal to <x>. (DISPLAY)
MGLST<x>.[BCR] - Listing of available Message Conferences displayed
to callers whose security level is equal to <x>.
(DISPLAY)
NEEDSYS.[BC ] - Displays to callers prior to the connection being
terminated using the ALT+F1 key. (DISPLAY)
NEWUSER.[BCR] - Displays to new callers (normally rules of the BBS).
(DISPLAY)
NOSPACE.[BCR] - Displays to a caller attempting to upload when the
disk space available is less than what the Sysop has
configured at the ALT+Z Upload Disk Space Requirement
option. (DISPLAY)
PRIVATE.[BCR] - Contains message displayed to callers logging onto
a private system if they exist in the caller database
but their security is not equal to or greater than
the ALT+Z's Private Security Level option. (DISPLAY)
SF1STM.[BCR] - Displays to the caller when entering the Message
Section the first time per log on. (DISPLAY)
SF1STF.[BCR] - Displays to the caller when entering the file
section the first time per log on. (DISPLAY)
SF2SLOW.BBS - Displays to a caller who connects at a baud rate
lower than what the Sysop has configured as the
minimum baud rate allowed on the BBS. (DISPLAY)
SFASLEEP.[BC ] - Displays to a caller who has not entered a keystroke
for the amount of time configured by the Sysop at the
ALT+Z's No Activity Time Limit, prior to logging them
off the BBS. (DISPLAY)
SFBATCHD.[BCR] - Display file of the Batch Download Menu. (DISPLAY)
SFBATCHU.[BCR] - Display file of the Batch Upload Menu. (DISPLAY)
SFBDAY.[BCR] - Displays to a caller on their birthday. (DISPLAY)
SFDOOR<x>.[BCR] - Displays to callers entering the corresponding
SPITFIRE Door program. <x> can be an alphabetical
character A through Z, with the exception of G and Q,
which are reserved for use by SPITFIRE. (DISPLAY)
SFDORBAK.[BCR] - Displays to a caller upon returning to the SPITFIRE
BBS after completing a door program if the Sysop has
configured the BBS to require a password when
returning from a door. Normally used to prompt the
caller for his/her password. (DISPLAY)
SFDORBUL.[BCR] - Lists the door bulletins available to the caller
from the SPITFIRE Door Menu. (DISPLAY)
SFDOWN.[BCR] - Displays to callers prior to a download. (DISPLAY)
SFDR<x>.[BCR] - Door menus for each of the corresponding security
levels available on the BBS. (DISPLAY)
SFEXTDN.BBS - Contains a list of external download file transfer
protocols available on the BBS. (DISPLAY)
SFEXTUP.BBS - Contains a list of external upload file transfer
protocols available on the BBS. (DISPLAY)
SFFILES.BBS - Display file containing the names of files available
for downloading in each of the file areas on the BBS.
This is the only exception to the rule of placing a
Display File in the Display File Path. A SFFILES.BBS
should be placed in each download directory; listing
the files available for download from that particular
File Area. (DOWNLOAD DIRECTORIES)
SFFILES.<x> - ASCII text listing of files available for download
from a CD Rom file area. <x> represents the number
of the File Area. (DISPLAY)
SFIL<x>.[BCR] - Displays to callers when selecting a specific file
area. <x> would correspond to the file area
selected. (DISPLAY)
SFIMPEXP.[BCR] - ANSI and non-ANSI menus displayed when logging on
locally and selecting either the <D>..Download or
<U>..Upload option from the File Menu. (DISPLAY)
SFMAINT.[BCR] - Displays to the caller after WELCOME1.[BCR] and
prior to the caller entering their name if system
maintenance is being performed. After this file
displays, the caller is logged off the BBS. (DISPLAY)
SFMSG<x>.[BCR] - Displays to callers when selecting a specific
message conference. <x> would correspond to the
conference selected. (DISPLAY)
SFMQDONE.[BCR] - Displays to a caller attempting to answer a Main
questionnaire/order form a second time when it is
configured to limit callers to one response.
(DISPLAY)
SFNOD<x>.[BCR] - Displays to callers after the ALL.[BCR] and prior
to the <X>SEC.[BCR]. <x> would correspond to the
BBS node number. (DISPLAY)
SFNOTIME.[BCR] - Displays to callers who attempt to log on after
using their daily allotted time. (DISPLAY)
SFNWSLTR.[BCR] - Sysop's newsletter available from the Main Menu.
(DISPLAY)
SFONFAIL.[BCR] - Displayed to a caller who logs on the BBS and fails
to enter the correct password. This could be used to
inform the caller that someone with the same name
already accesses the BBS and they should attempt to
log on using a nickname or their middle initial.
(DISPLAY)
SFORD<x>.[BCR] - Questionnaire/Order Form Menu displayed to caller
with a corresponding <x> security level. (DISPLAY)
SFPAGED.[BCR] - Displays if the Sysop has the page on and a caller
attempts to page the Sysop again when the Sysop has
not answered the first page. (DISPLAY)
SFPGOFF.[BCR] - Displays to callers paging the Sysop when the
Sysop has the page feature turned off. (DISPLAY)
SFPRELOG.BBS - The first file displayed upon log on. (DISPLAY)
SFPROMSG.[BCR] - Displays to the caller prior to selecting a default
file transfer protocol. Sysops should use this
display file to inform callers that if a default
transfer protocol is selected, External Transfer
Protocols will not be available to them. (DISPLAY)
SFRATIO.[BCR] - Displays to callers after a download if their
download/upload ratio exceeds configured settings
and a VWR (Violation Warning Ratio) exists for the
caller's security level in DAILYLMT.DAT. (DISPLAY)
SFREMIND.[BCR] - Displays to callers upon log on if the caller was
logged off during the previous session due to
inactivity. (DISPLAY)
SFSUBCHG.[BCR] - Displays to the caller when the callers subscription
has expired. When this file is displayed to the
caller, SPITFIRE will change the caller's security
to the Expired Security (configured by the Sysop
in SPITFIRE's ALT+Z configuration window.) (DISPLAY)
SFTIMEUP.[BC ] - Displays to a caller whose log on-time has expired.
(DISPLAY)
SFUNANS.[BCR] - Displays to a caller when the Sysop has the page
turned on and the Sysop does not answer the page.
If SFPAGED.[BCR] is found in the display file
directory, SPITFIRE will not allow additional pages
if the first page remains unanswered. (DISPLAY)
SFUP.[BCR] - Displays to callers prior to an upload. (DISPLAY)
SOP<x>.[BCR] - Sysop Menu display files created for specific
security levels where <x> would correspond to
the caller's security level. (DISPLAY)
SUBWARN.[BCR] - Displays to warn a caller that his/her subscription
is nearing expiration. The Sysop configures the
Expiration Warning days from SPITFIRE's ALT+Z
configuration window. This screen will begin
displaying to the caller this number of days prior
to the subscription expiration. (DISPLAY)
THOUGHTS.BBS - Contains thoughts created for SPITFIRE with
THOUGHTS.EXE. (DISPLAY)
TOOMANY.[BCR] - Displays to callers who exceeds the daily limit
of calls. (DISPLAY)
SYSINIT.[BC ] - Displays to the caller upon entering chat if the
Sysop initiated the chat. (DISPLAY)
USERINIT.[BC ] - Displays to caller upon entering chat with the
Sysop if the caller paged the Sysop and requested
the chat. (DISPLAY)
WELCOME1.[BCR] - The second file displayed upon log on. (DISPLAY)
WELCOME<x>.[BCR]- WELCOME2.BBS/CLR/RIP through WELCOME9.BBS/CLR/RIP
are displayed in numerical order after a caller
enters their name and password and gains access
to the BBS. (DISPLAY)
* NOTE * Any Sysop operating a multi-node system should be aware that
SPITFIRE will allow all nodes to share a common DISPLAY file
path.
SPITFIRE supports the use of ANSI and RIP Graphics display files.
The Sysop must use the ALT+T (Toggle SPITFIRE Switches) window to
configure the BBS to support ANSI Graphics and/or to support RIP
Graphics. The ANSI files use the file extension .CLR (color) and the
RIP files use the file extension of .RIP. Provided the BBS is
configured to make RIP Graphics available, when a caller logs onto
the BBS, SPITFIRE tests to verify whether the caller is calling with
a RIP terminal program. If the caller is using a RIP terminal
communications program, the caller is prompted to select one of the
following graphic formats: <A>nsi, <R>ip, or <N>one. If RIP Graphics
is selected, the display files with an extension of .RIP are displayed
to the caller, if found.
If the BBS does not make RIP Graphics available but is configured
to support ANSI Graphics, or if SPITFIRE determines that the caller is
not calling with a RIP terminal program, then the caller is prompted
with: "Do You Want ANSI Graphics? <y/N>". If the caller selects ANSI
Graphics, display files with an extension of .CLR will be displayed
to the caller, if found. If the BBS is not configured to support
ANSI or RIP Graphics or if the caller elects not to use color graphics,
ASCII display files with an extension of .BBS will be displayed to
the caller, if found.
Provided the caller is using a RIP terminal program and SPITFIRE
is configured to allow RIP Graphics, if SPITFIRE does not find the
appropriate .RIP file to display, then the appropriate .CLR file will
be displayed. In the event ANSI Graphics are available and SPITFIRE
does not find the appropriate .CLR file to display, then SPITFIRE
will display the appropriate .BBS file. If the appropriate .RIP,
.CLR, or .BBS display files are not found, SPITFIRE will, in most
cases, display a default message.
IMPORTANT: In the event, ANSI/Graphics are available be sure to
load the ANSI driver (DEVICE=ANSI.SYS) from within your CONFIG.SYS.
NOTE: When making ANSI graphics available to callers, duplicate
all display <filename>.BBS files to ANSI files and call them
<filename>.CLR. Similarly, when making RIP graphics available to
callers, duplicate all display <filename>.BBS files to RIP files and
call them <filename>.RIP. For an attractive BBS, display files should
be created for each of the available Graphic formats.
Display files which are available within SPITFIRE using only the
RIP Graphic format are:
MAINCTRL.RIP FILECTRL.RIP MSGCTRL.RIP
Display files which use only the ASCII (.BBS) and ANSI (.CLR)
graphic format include:
SFASLEEP.BBS/CLR SFTIMEUP.BBS/CLR USERINIT.BBS/CLR
SYSINIT.BBS/CLR CHATDONE.BBS/CLR NEEDSYS.BBS/CLR
The display files listed below are only available within SPITFIRE
as ASCII (extension of .BBS) files:
THOUGHTS.BBS SFEXTDN.BBS SFEXTUP.BBS
SFFILES.BBS SFPRELOG.BBS SF2SLOW.BBS
SPITFIRE automatically displays SFFILES.BBS in color if the
caller selected ANSI or RIP color graphics when logging on the BBS.
In the event a file line is not colored like the others, but rather
uses the caller's default color, it is because the comma in the file
size is either not located properly or does not exist. SPITFIRE
utilizes the comma in the file size to determine the coloring of the
SFFILES.BBS listings.
SPITFIRE's display files may be created using special control
codes. These special control codes allow specific information
to be displayed within the display file or will perform a specific
task when encountered within a display file. The control codes are
valid for each of the graphic formats (.BBS, .CLR, and .RIP). For
additional information on the display file control codes, refer to
section, ABOUT SPITFIRE DISPLAY FILES of this manual.
5.5 - SPITFIRE MENU FILES
-------------------------
Menu files contain all the information needed for SPITFIRE to
dynamically build each caller's menus, dependent on the caller's
security level.
SPITFIRE displays a feature only if a caller's security level is
high enough to access it. Therefore, callers do not necessarily see
every possible choice in a given menu. This places the Sysop in
control and allows the BBS to be tailored to meet their individual
needs.
The format used for the SFMAIN.MNU, SFSYSOP.MNU, SFMSG.MNU and
SFFILE.MNU is:
Command Character,Command Description,,Security Level,Command Identifier
Knowing this, let's use the following example:
B,<B>.... Bulletins,,5,A
The "B" is the Command Character. This is the letter the
caller must type to access this particular option. In
this instance "B" is used to select Bulletins.
"<B>.... Bulletins" is the Command Description and represents
how the file entry appears in SPITFIRE's default menu on the
screen.
"5" is the minimum Security Level required for the caller to
access this function or, for that matter, even see it!
"A" is the SPITFIRE Command Character Identifier and should
NEVER be changed. The Command Character Identifier is
constant in SPITFIRE programming. This character is
DIFFERENT for every command.
After exploring a bit, you'll find that SPITFIRE allows the Sysop
to design menus which suit their personal taste, as well as control
what commands are available to what callers. The SFFILE.MNU file that
comes with the SPITFIRE package sets the <D>.... Download A File
security at 10. While a caller is on-line, hit F2 to change the
caller's security to 9 and notice that the Download feature is no
longer available for that caller.
THERE ARE THREE RULES CONCERNING MENU LINES!
1) You CANNOT change the Command Character Identifier from what it
is in the original distribution package menu!
2) You CANNOT assign the same Command Letter to two commands in the
same menu!
3) You CANNOT make the total length of the line more than 40
characters long!
Therefore, it is possible to change the Bulletins option described
above to read:
A,<A>.... Announcements,,5,A
Just remember: NEVER change the Command Character Identifier (the
last character on each entry line), and NEVER use a Command Letter more
than once in each menu.
SPITFIRE uses the following Menu Files:
SFMAIN.MNU - Main Menu (SYSTEM)
SFMSG.MNU - Message Menu (SYSTEM)
SFFILE.MNU - File Menu (SYSTEM)
SFSYSOP.MNU - Sysop Menu (SYSTEM)
SFDOOR.MNU - Door Menu (SYSTEM)
SFORDER.MNU - Questionnaire Menu (SYSTEM)
Refer to SPITFIRE DOORS section of this manual for information
regarding the structure of SFDOOR.MNU. Refer to the SPITFIRE
QUESTIONNAIRES section of this manual for information regarding the
structure of SFORDER.MNU.
You can use the DOS EDIT program or any text editor that is
capable of saving in ASCII format to edit the *.MNU files.
Should you edit these menu files and come up with some very nice
looking menus, please share the information so other Sysops using
SPITFIRE may benefit from your discovery.
SPITFIRE uses the following display menu files:
MAIN<x>.BBS - Non-ANSI Main Menu (DISPLAY)
MAIN<x>.CLR - Color Main Menu (DISPLAY)
MAIN<x>.RIP - RIP Graphic Main Menu (DISPLAY)
FILE<x>.BBS - Non-ANSI File Menu (DISPLAY)
FILE<x>.CLR - Color File Menu (DISPLAY)
FILE<x>.RIP - RIP Graphic File Menu (DISPLAY)
MSG<x>.BBS - Non-ANSI Message Menu (DISPLAY)
MSG<x>.CLR - Color Message Menu (DISPLAY)
MSG<x>.RIP - RIP Graphic Message Menu (DISPLAY)
SOP<x>.BBS - Non-ANSI Sysop Menu (DISPLAY)
SOP<x>.CLR - Color Sysop Menu (DISPLAY)
SOP<x>.RIP - RIP Graphic Sysop Menu (DISPLAY)
SFDR<x>.BBS - Non-ANSI Doors Menu (DISPLAY)
SFDR<x>.CLR - Color Doors Menu (DISPLAY)
SFDR<x>.RIP - RIP Graphic Doors Menu (DISPLAY)
SFORD<x>.BBS - Non-ANSI Questionnaire Menu (DISPLAY)
SFORD<x>.CLR - Color Questionnaire Menu (DISPLAY)
SFORD<x>.RIP - RIP Graphic Questionnaire Menu (DISPLAY)
SFBATCHU.BBS - Non-ANSI Batch Upload Menu (DISPLAY)
SFBATCHU.CLR - Color Batch Upload Menu (DISPLAY)
SFBATCHU.RIP - RIP Graphic Batch Upload Menu (DISPLAY)
SFBATCHD.BBS - Non-ANSI Batch Download Menu (DISPLAY)
SFBATCHD.CLR - Color Batch Download Menu (DISPLAY)
SFBATCHD.RIP - RIP Graphic Batch Download Menu (DISPLAY)
SFIMPEXP.CLR - Color Local Log-on Import/Export Menu
(DISPLAY)
SFIMPEXP.BBS - Non-ANSI Local Log-on Import/Export Menu
(DISPLAY)
SFIMPEXP.RIP - RIP Graphic Local Log-on Import/Export Menu
(DISPLAY)
Each of the Menu display files listed below are supported in
SPITFIRE using the ASCII text (.BBS extension), ANSI graphics (.CLR
extension) and/or RIP graphics (.RIP extension).
MAIN<x> FILE<x> MSG<x> SFDR<x> SOP<x>
SFORD<x> SFBATCHU SFBATCHD SFIMPEXP
"x" represents the security level of the current caller. For
example, if a caller with a security level of 10 calls using a RIP
terminal program and selects RIP graphics, then SPITFIRE searches
for files named MAIN10.RIP, MSG10.RIP, FILE10.RIP, SFDR10.RIP, etc.
If a caller with a security level of 10 calls and opts to use ANSI
Graphics, then SPITFIRE searches for files named MAIN10.CLR, MSG10.CLR,
FILE10.CLR, SFDR10.CLR, etc. to display as the color menus. Similarly,
if a caller with a security level of 10 calls and chooses not to use
RIP graphics or ANSI Graphics, then SPITFIRE searches for files named
MAIN10.BBS, MSG10.BBS, FILE10.BBS, SFDR10.BBS, etc. In the event these
files are not found, then SPITFIRE displays the default menus.
The reason for different RIP, ANSI and Non-ANSI display menu files
for each security level is to control what commands are shown to the
caller. For example, if the BBS requires a security level of 10 to be
able to download a file, then FILE10.RIP, FILE10.CLR and FILE10.BBS
must be created to show the <D>... Download A File command while
FILE9.RIP, FILE9.CLR and FILE9.BBS would not show the command. Display
file menus using RIP, ANSI, or non-Ansi graphics will need to be
created for each security level assigned to callers on the BBS if you
decide to use SPITFIRE display file menus rather than using SPITFIRE's
default menus and you have also configured your BBS to support ANSI
and/or RIP graphics. The exception to the security defined Non-ANSI,
ANSI, and RIP menus are the menus used for the batch file transfer and
the local log on import/export menu. The batch file transfer menus are
simply named SFBATCHU and SFBATCHD with the appropriate extension of
BBS, CLR, or RIP. The import/export menu which displays when logged
on locally is named SFIMPEXP.[BCR].
Buffalo Creek Software provides a utility to create the RIP,
ANSI, and non-ANSI menu files. The name of this utility is MKSFMENU.
You can download it from Buffalo Creek's BBS at 515-225-8496.
Your SPITFIRE distribution package includes sample MAIN10, MSG10
FILE10, SFBATCHU, SFBATCHD, SFIMPEXP, and SOP999 display menu files in
each of the available graphic formats (non-ANSI using the .BBS
extension, ANSI graphics using the .CLR extension, and RIP graphics
using the .RIP extension).
5.6 - SPITFIRE FILE CLARIFICATIONS
----------------------------------
The following files deserve a more in-depth explanation:
SFFILES.BBS - Resides in each File Area and lists files available
(DL FILE AREA) for download from that area. This file can be created
using any text editor as long as it saves in ASCII
format. Here are the guidelines required in creating
an SFFILES.BBS that will work properly with SPITFIRE.
1--------10--------20--------30--------40--------50--------60--------70
SF36-1.ZIP 325,000 08-20-99 SPITFIRE Bulletin Board System V3.6
The FILENAME must begin at column 1
The FILE SIZE must end at column 21
The FILE DATE must end at column 31
The FILE DESCRIPTION must start at column 34
When the SFFILES.BBS displays to a caller who is
using either RIP or ANSI Color Graphics and a file
line is not colored like the others, but rather uses
the caller's default color, it is because the comma
in the file size is either not located properly or
does not exist. SPITFIRE uses the comma in the file
size to determine whether the line is a file listing
or part of the file area header.
DAILYLMT.DAT - This file controls, per security level, the amount
(SYSTEM) of time a caller has each day, each call, kilobytes
allowed to be downloaded per day, files allowed to
be downloaded per day, node chats allowed, time
allowed per node chat, quick log on access, when and
if a caller will be warned of file ratio violation,
and when/if the file ratio violation will be enforced.
Below is a list of abbreviations used in DAILYLMT.DAT and what each
abbreviation represents:
MPC - Minutes Per Call
MPD - Minutes Per Day
QL - Quick Log-on
DLPD - Downloads Per Day
KB - Kilobytes (allowed to be downloaded per day)
#OCA - Number Of Chats Allowed
TPNC - Time In Minutes Per Node Chat
VWR - Violation Warning Ratio
VER - Violation Enforcement Ratio
A line should be created in DAILYLMT.DAT for each security level
you allow on your BBS. Each line should begin with the numeric value
of the security level whose parameters are being defined. The syntax
for each line in the DAILYLMT.DAT is:
10,MPC=45,MPD=60,QL,DLPD=15,KB=2000,#OCA=5,TPNC=5,VWR=15,VER=25
where:
10 represents the security level for which the subsequent
parameters apply.
MPC=45 represents the maximum time in minutes a caller with this
security level is allowed for each call to the BBS. This
overrides the Log On Time Limit defined at SPITFIRE's ALT+Z
configuration.
MPD=60 represents the total daily time limit in minutes a caller
of this security level is allowed. This overrides the
Daily Time Limit defined at the ALT+Z SPITFIRE configuration
screen.
QL allows a remote caller with this security level to quickly log
on the BBS. This remote quick log on is similar to a local
quick log. After the initial log on, a caller with this
security is immediately displayed the Main Menu, avoiding the
display of WELCOME2.[BCR] to WELCOME9.[BCR], ALL.[BCR],
etc. It should be noted, <x>SEC.[BCR] and <x>.[BCR] will
display to callers with quick log on capability. To require a
normal log on, simply omit the QL from the DAILYLMT.DAT line.
DLPD=15 represents the maximum number of files a caller with this
security will be allowed to download each day.
KB=2000 represents the maximum number of kilobytes a caller with this
security level will be allowed to download each day.
#OCA=5 sets the maximum Number Of Chats Allowed (node chats) each day
on a multi-node system for this security level. The SPITFIRE
default is 5. To disable node chats for a particular security
level, set this parameter to #OCA=0. The #OCA=<x> is only
applicable to multi-node systems.
TPNC=5 designates the Time (in minutes) Per Node Chat allowed for
this security level. SPITFIRE defaults to 5 minutes per node
chat. The TPNC=<x> is only applicable to multi-node systems.
VWR=15 represents the Violation Warning Ratio for this security level.
When the upload/download ratio exceeds 1 upload for each VWR
value downloaded, SFRATIO.[BCR], if found, is displayed to
the caller. Both the number of files AND the kilobytes
downloaded must exceed the ratio before SFRATIO.[BCR] is
displayed to the caller. If you do not wish to warn the
caller, simply do not include the VWR parameter in the
DAILYLMT.DAT for this security level.
VER=25 represents the Violation Enforcement Ratio for this security
level. When the upload/download ratio exceeds 1 upload for
each VER value downloaded, SPITFIRE alters the caller's
security to what the Sysop has configured at the U/D Ratio
Violation Security in the ALT+Z configuration screen. Both
the number of files AND the kilobytes downloaded must exceed
the ratio before the caller's security is altered. If
you do not wish to enforce the ratio violation for this
security level, simply do not include the VER parameter in
the DAILYLMT.DAT for this security level.
**NOTE** A warning should be displayed prior to enforcing the upload/
download ratio which would alter the caller's security level.
It is highly recommended that the difference between the
violation warning and the violation enforcement should be
greater than the amount of files the caller may download in
a batch download. Using the word Batch at the end of a line
in SFEXTDN.BBS limits downloads per batch to 6, so a difference
of at least 6 is recommended. Using the word Usefile, at the
end of a line in SFEXTDN.BBS limits downloads per batch to 99,
so a difference of 99 is recommended. (Refer to the section -
EXTERNAL BATCH DOWNLOAD PROTOCOLS - of this manual for a full
explanation.) If the difference between the violation warning
and the violation enforcement is not equal to or greater than
the amount of files a caller can download in a single batch,
it is possible during a batch download for a caller to have their
security altered without ever being warned of the impending
status change.
If SPITFIRE finds the VWR and VER are defined for the security
level of the caller, each time a file is downloaded, SPITFIRE
performs the following calculations to determine if a caller has
violated the upload/download ratio requirement:
The number of files downloaded by a caller is divided by the
number of files uploaded AND the number of kilobytes downloaded
by the caller is divided by the number of kilobytes uploaded by
the caller. SPITFIRE must verify that both the file ratio and
the kilobyte ratio have been violated. If the results of both
the file and kilobyte calculation are greater than the value
defined for the VER (Violation Enforcement Ratio), SPITFIRE will
then alter the caller's security level to that configured at the
U/D Ratio Violation Security.
SPITFIRE will return the caller to their original security once
the caller's upload/download ratio is again within the required
ratio limits. The SFUSERS.DAT file contains a field which stores
information regarding the caller's original security level. When
a caller uploads a file to the BBS, SPITFIRE first checks to see
if the caller's current security level is less than the original
security level. If so, SPITFIRE performs the same computations
as described above. If the results of the file or kilobyte
calculation is less than the VER (Violation Enforcement Ratio),
the caller's original security level is restored. Keep in mind,
for this to work properly, the VER (Violation Enforcement Ratio)
must be configured the same for both security levels, the
security that is being monitored and the U/D Ratio Violation
Security.
Using the sample DAILYLMT.DAT from above, all callers with a security
level of 10 are allowed 45 minutes per call, 60 minutes per day, 15
downloads per day with a limit of 2,000 kilobytes per day, 5 node chats
of up to 5 minutes per node chat, will be displayed SFRATIO.[BCR], if
it exists, when the upload/download ratio of 1 to 15 is exceeded, and
will have their security altered when the upload/download ratio of 1
to 25 is exceeded.
DAILYLMT.ZIP is included in the SPITFIRE distribution package or
can be downloaded from Buffalo Creek's BBS. DAILYLMT.COM is a menu
driven program that is used to create and maintain DAILYLMT.DAT.
SFRATIO.[BCR] - It's rare when a caller's uploads exceed their
(DISPLAY) downloads. Some callers get in the habit of taking
and never give much consideration toward uploading.
This file is displayed after a download is completed
that causes the caller's U/D ratio to violate the
warning ratio (VWR) configured in DAILYLMT.DAT
(provided the DAILYLMT.DAT for the caller's security
level contains a VWR - Violation Warning Ratio).
SFRATIO.[BCR] will then be displayed to the
caller showing your "friendly" words of advice
whenever this situation presents itself. If you are
not concerned about a caller's U/D ratio, simply do
not include this file in the display file directory.
JOKER.DAT - JOKER.DAT contains a list of all names you don't
(WORK) want to allow on your board. It may be used to
list names like: Dr. Phreak, Micro Muck, Lord Havoc,
Killer, etc.. Also, if any line in JOKER.DAT is
preceded with an @ followed by text, no one with
that portion of the text in any part of their name
will be allowed to log on to the BBS. These feature
is primarily intended to scrutinize those who
attempt to log on a BBS using profane words. The
'@<text>' feature should be used with caution since
it would be quite easy to unintentionally deny
someone access. JOKER.DAT is an ASCII file that has
each name listed on a separate line, such as:
Dr. Phreak
Micro Muck
Lord Havoc
@damn
All Callers
When locking a caller out of a SPITFIRE BBS system
or marking the caller for deletion, SPITFIRE prompts
you as to whether you wish to add the name to
JOKER.DAT. If you respond with a Yes, the name is
automatically added to JOKER.DAT. SPITFIRE allows a
caller to be locked out or marked for deletion using
ALT+A at the "Ready..." prompt or from the Sysop Menu.
A caller may also be locked out by pressing ALT+L
while the caller is logged on the BBS. A caller may
be added to JOKER.DAT using any of these features.
LOCKOUT.[BCR] - SPITFIRE reads JOKER.DAT line-by-line and compares
(DISPLAY) the names in the file against the caller's first
and last name. If a match is found, then the
LOCKOUT.[BCR] is displayed to the caller and the
caller is logged off the BBS!
LAKOTA.COM - If LAKOTA.COM exists in the SPITFIRE home directory,
(SYSTEM) callers may download messages in QWK format, using
an offline mail reader to read/reply to messages,
and upload reply packets into SPITFIRE's message
base. LAKOTA, a SPITFIRE QWK Mail System, is
available using Option L of the Message Menu. If
you do not wish to have this option available to
callers, the security in SFMSG.MNU for this feature
should be set high enough so the caller is not able
to access it. For more information refer to the
documentation that accompanies LAKOTA.COM.
FA<x>.TXT - To use SPITFIRE's extended download directory feature,
(SYSTEM) create a FA<x>.TXT, where <x> is equal the File Area
number, and place it in the SPITFIRE home directory.
FA<x>.TXT is a simple text file which can be created
using your favorite text editor, as long as it saves
in ASCII text. Each line of FA<x>.TXT should contain
the drive and directory of any extended download
directories for the File Area. For instance, if File
Area 5 was configured for Games, the contents of the
FA5.TXT in the SPITFIRE Home directory might look like
this:
F:\GAMES
G:\NEWGAMES
If SPITFIRE does not find the file to download, read,
view, etc. in the configured download directory (the
primary download directory) it will then look for the
appropriate FA<x>.TXT in the SPITFIRE Home directory.
The number of extended download directories that can
be configured using FA<x>.TXT is unlimited. However,
the SFFILES.BBS in the primary download directory (or
the SFFILE.<x> for areas configured as a CD Rom file
area) should list all files available for downloading
from all download paths, including any of the extended
download directories.
The FA<x>.TXT, extended download directory feature,
provides additional CD Rom support. However, the
Sysop should be aware when using this feature that if
the File Area is not configured as a CD Rom File Area
and the file to be downloaded exists on a CD Rom disc,
the file is directly transferred to the caller from
the CD Rom drive rather than being copied to the disk
drive. Secondly, if the File Area is configured as a
CD Rom File Area and the ALT+T's Search CD Rom Area
SFFILES.BBS is toggled to Yes, SPITFIRE will search
the SFFILES.<x>, rather than the drive. Therefore,
the file must be listed in the SFFILES.<x> in order
for SPITFIRE to find the file.
SFNWSLTR.[BCR] - File which displays to the caller when they request
(DISPLAY) the <N>...Newsletter from the Main Menu. SPITFIRE
will also notify the caller if this file has been
updated since they last logged on the BBS. This file
can be used to send special informational messages to
callers regarding the system.
SFNOUP.DAT - SFNOUP.DAT contains a list of files which the
(WORK) Sysop does not wish to have uploaded to the BBS.
SFNOUP.DAT will allow complete use of DOS's wildcard
feature. Simply create an ASCII file that has each
name listed on a separate line, such as:
NUCALLER.*
WIN*.*
PERVERT.COM
*.GIF
When erasing a file from the file menu, SPITFIRE
prompts you as to whether you wish to have the file
added to SFNOUP.DAT. Responding with a Y for Yes,
will add the erased file's name to SFNOUP.DAT.
NUCALLER.* - SPITFIRE will flag this file for download when a
(FILE AREA #1) new caller logs onto the BBS. After completing
the new caller questionnaire, the new caller is
given the opportunity to download the file named
NUCALLER. The Sysop may select the desired
extension for NUCALLER, i.e., .TXT, .ZIP, .ARJ, etc.
Suggested uses for NUCALLER.* might be to include
any rules for participating on the BBS, subscription
applications, RIP icons specific to the BBS, etc.
NUCALLER.* must be placed in the first file area
on the BBS. To disable this feature, simply do not
place a NUCALLER.* in File Area #1.
Sysops should be aware, however, that if there is
more than one NUCALLER.* file (i.e., NUCALLER.TXT and
NUCALLER.ZIP) in the first file area, SPITFIRE will
send the first NUCALLER.* file it finds. It is
therefore recommended that NUCALLER.* be added to
SFNOUP.DAT to prevent callers from uploading any
NUCALLER.* files and eliminating the possibility of
having the wrong NUCALLER.* file sent to new callers.
SFFAX.BAT - After SPITFIRE answers the incoming call, it then
(SYSTEM) tests the modem result message for the configured
FAX Connection Result Message (configured by the
Sysop at SPITFIRE's ALT+M configuration window).
If the modem result message matches the Fax
Connection Result Message, then SPITFIRE shells to
a batch file in the SPITFIRE home directory named
SFFAX.BAT. The SFFAX.BAT needs to be written so
that it contains the commands necessary to execute
the Fax software so that the Fax can be properly
received.
SFILEREQ.LOG - SPITFIRE will allow a caller to make file requests
when certain conditions exist. The Sysop can mark
a file OFFLINE by replacing the file size in the
file description of SFFILES.BBS with the word
OFFLINE. The word OFFLINE must start at column 15.
For example:
1--------10----5---20--------30--------40--------50--------60--------70
SF36-1.ZIP OFFLINE 08-20-99 SPITFIRE Bulletin Board System V3.6
SPITFIRE also treats a file listed in SFFILES.BBS but
which is not located in the download directory as a
file request.
When a file marked as OFFLINE is tagged for download,
or when SPITFIRE is unable to locate a tagged file in
the download directory, SPITFIRE treats these as file
requests. SPITFIRE records all file requests to the
SFILEREQ.LOG file located in the SPITFIRE Work
directory. If the SFILEREQ.LOG does not exist,
SPITFIRE will create it when a file request is made.
If the SFILEREQ.LOG does exist, SPITFIRE will append
any new file requests to the existing log. SPITFIRE
records the name of the caller requesting the file,
the name of the file, the date and time of the file
request to SFILEREQ.LOG.
SFPCKMSG.COM - SPITFIRE shells to SFPCKMSG.COM for purging
(SYSTEM) messages either as Event M or when selected from
the SPITFIRE Sysop Menu. Criteria for packing
messages is determined according to how the Sysop
has configured the Message Conference record.
The purge criteria is set independently for each
conference available on the BBS.
SFPCKUSR.COM - SPITFIRE shells to SFPCKUSR when the Sysop selects
(SYSTEM) the Pack User File option from the SPITFIRE Sysop
Menu. SFPCKUSR is used to purge callers marked for
deletion and/or inactive callers. A caller is
considered inactive if they have not called the
BBS in <x> amount of days. The Sysop determines
the value of <x>.
SFPCKUSR may also be set up to run as a scheduled
event in SPITFIRE. Refer to the section - EVENT
MENU EXPLANATION - for additional information on
scheduled events.
SFUPCASE.DAT - A list of keywords that are converted to or left
(WORK) in upper case when converting file descriptions.
This is a simple text file that lists these
keywords, one per line.
SFREMOTE.BAT - This batch file is used with the remote Drop to
(SYSTEM) DOS feature and should be used with a carrier
detect utility such as WATCHDOG, RemDoor or Doorway.
If connection is terminated while a caller is at
the DOS level the system is reset provided such a
utility is used. If you have included SF.BAT in the
AUTOEXEC.BAT, SPITFIRE will automatically boot on
system start up. Using such a utility is highly
recommended, but none are included in the SPITFIRE
distribution package since these programs are written
by other authors. However, these utilities may be
downloaded from Buffalo Creek, as well as from
numerous other BBS systems. When shelling to
SFREMOTE.BAT, SPITFIRE sends a parameter to
SFREMOTE.BAT which is the number of the COM port.
SF.BAT - Batch file which invokes SPITFIRE. This file
(SYSTEM) contains the necessary data for the scheduled
events feature within SPITFIRE to work properly.
Refer to section - EVENT MENU EXPLANATION - of
this manual for more information on Scheduled
Events. It also contains the data necessary to
execute programs using the SPITFIRE Door feature.
Refer to the section - SPITFIRE DOORS SECTION -
of this manual for more information on SPITFIRE
Doors.
SFMAIN.BAT - Batch file which executes the Sysop configurable
(SYSTEM) Main Menu option.
SFFILE.BAT - Batch file which executes the Sysop configurable
(SYSTEM) File Menu option.
SFMESS.BAT - Batch file which executes the Sysop configurable
(SYSTEM) Message Menu option.
SFSYSOP.BAT - Batch file which executes the Sysop configurable
(SYSTEM) Sysop Menu option.
SFMSGPCK.BAT - Batch file that executes immediately after packing
(WORK) the message base. SFMSGPCK.BAT might be used
to create a file archive of the SPITFIRE message
base after it is packed. SFMSGPCK.BAT may be used
by some net-mail drivers to perform some necessary
duties required after packing the message base.
SFINIT.BAT - Batch file executes, if it exists, after a caller
(SYSTEM) hangs up and prior to the modem being initialized.
This allows utilities (such as a last 10 caller
listing or checking the integrity of uploaded files)
to be executed between callers to the BBS.
SFPGOFF.[BCR] - This file displays to the caller in the event
(DISPLAY) the caller pages the Sysop and the Sysop has the
page feature turned off.
SFUNANS.[BCR] - This file displayed to the screen in the event a
(DISPLAY) caller has paged the Sysop and the Sysop does not
answer the page.
SFPAGED.[BCR] - This file displays to the caller in the event
(DISPLAY) the Sysop has the page turned on and the caller
attempts to page the Sysop again when the first page
remains unanswered. If this file exists in the
display file directory, the Sysop will only receive
the first page. Any additional pages will cause
SFPAGED.[BCR] to display to the caller. If you wish
to receive multiple pages, simply do not include the
SFPAGED.[BCR] files in the display file directory.
BBSNAME.DAT - Simple one line text file that is placed in the
(WORK) Work file directory and contains information
about the BBS from which the net-mail message
originates. SPITFIRE will tag this on the end of
each net-mail message.
SFSEC<x>.BAT - This batch file, if it exists, executes after the
(SYSTEM) caller logs on the BBS, provided the caller's
security is equal to <x> in the batch file name.
One example for utilizing this would be if your BBS
serves as a hub for net-mail. All callers who use
your BBS for mail could be assigned a set security
level. Upon logging on the BBS, the SFSEC<x>.BAT
could contain commands that would allow the caller
to immediately initiate the mail transfer process.
BADINIT.BAT - This batch file, if it exists, executes in the
(SYSTEM) event the modem fails to respond when initialized
between callers. Commands could be placed in the
batch file to issue modem commands to reset your
modem or to reboot your system with Buffalo
Creek Software's KOLDBOOT utility. (KOLDBOOT may
be downloaded from Buffalo Creek's BBS.)
<x>SEC.[BCR] - This feature allows the Sysop to send a special
(DISPLAY) notice to all callers of a certain security
level. This file is not automatically erased.
(<x> equals the security level of the callers to
whom you wish to send the special message.)
<x>.[BCR] - This feature allows the Sysop to send a special
(DISPLAY) message to a specific caller, where <x> equals the
caller's record number. Once the caller has
received it, SPITFIRE automatically erases it.
Example: John Doe is Caller Record # 95 on your system. If you have
a file named "95.BBS", SPITFIRE will display this file
when John Doe logs on and then erase it after it has been
received. Your callers log will have a notation that the
special message was sent.
**NOTE** In the event you use <x>.[BCR] to send special messages
to callers and you purge callers from the caller data base
by packing SFUSERS.DAT, please note that the <x>.[BCR] may
no longer match the caller for whom the message was intended.
5.7 - ABOUT SPITFIRE DISPLAY FILES
----------------------------------
SPITFIRE provides complete flexibility when it comes to creating
display files. The Sysop can use this flexibility to make their BBS
as unique and personalized as he/she desires. In addition, SPITFIRE
will recognizes both display file control characters or display file
control strings which can be built into the non-ANSI (.BBS), ANSI
(.CLR), and/or RIP (.RIP) display files for even more flexibility.
The display file control characters and control strings SPITFIRE uses
are:
Ctrl Ctrl Ctrl Character / Ctrl String
Char String Feature Description
^B @PROMPTOFF@ Inhibits the display of the "More Prompt".
When this is placed in a display file, then the
<More?> prompt will not interrupt the display of
the file.
^C @NOABORT@ When placed in a display file, it prevents the
caller from interrupting and/or aborting the
screen display.
^D @FNAME@ Displays caller's first name.
^E @SUBDATE@ Displays the number of subscription days a
caller has remaining before his/her subscription
will expire, provided the subscription date for
the caller is configured.
^F @CITYSTATE@ Displays the caller's city and state/province.
^G @BEEP@ Transmits a beep over the caller's PC speaker.
^J @UPLOADS@ Displays the number of files uploaded by the
caller.
^K @DOWNLOADS@ Displays the number of files downloaded by the
caller.
^L @CLS@ Clears the display screen for the remote caller.
^N @ABORTON@ Allows caller to interrupt the screen display.
This will nullify the affect of a previous ^C
or @NOABORT@ in the display screen.
^O @ORGLOG@ Displays the caller's original log on date.
^P @PROMPT@ Exhibits a "More Prompt" in the display. When
SPITFIRE finds a ^P or @PROMPT@, the <More?>
prompt is displayed to the screen. It should be
mentioned that if a ^P or @PROMPT@ is preceded
by a ^B or @PROMPTOFF@ (disables the display of
the "More Prompt"), the ^P or @PROMPT will
nullify the affect of the ^B or @PROMPTOFF@
control code/string. It should also be noted
that when a ^P or @PROMPT@ is used in a .RIP
display file, it will only be functional to the
remote caller. On the local monitor, the screen
will display as if no ^P or @PROMPT@ existed
within the display file.
^Q @LOGTIME@ Displays the number of minutes allowed this log
on.
^R @PHONENUM@ Displays the caller's phone number.
^S @LASTCALL@ Displays the date of the caller's last call.
^T @PASSWORD@ Displays the caller's password.
^U @BIRTHDATE@ Displays the caller's date of birth.
^V @NAME@ Displays the caller's full name.
^W @UPK@ Displays the number of K uploaded.
^X @DOWNK@ Displays the number of K downloaded.
^Y @SLEVEL@ Displays the caller's security level.
Some planning is required when using display control characters or
strings. For instance, do not use control characters or strings that
write information to the screen (such as ^D, @FNAME@, ^F, @CITYSTATE@,
^J, @UPLOADS@, ^K, @DOWNLOADS@, etc.) inside of a box. The characters
inserted will throw the box completely out of line.
Below is the list of control characters used in SPITFIRE display files
and their extended ASCII value:
^B - extended ASCII value of 002 ^P - extended ASCII value of 016
^C - extended ASCII value of 003 ^Q - extended ASCII value of 017
^D - extended ASCII value of 004 ^R - extended ASCII value of 018
^E - extended ASCII value of 005 ^S - extended ASCII value of 019
^F - extended ASCII value of 006 ^T - extended ASCII value of 020
^G - extended ASCII value of 007 ^U - extended ASCII value of 021
^J - extended ASCII value of 010 ^V - extended ASCII value of 022
^K - extended ASCII value of 011 ^W - extended ASCII value of 023
^L - extended ASCII value of 012 ^X - extended ASCII value of 024
^N - extended ASCII value of 014 ^Y - extended ASCII value of 025
^O - extended ASCII value of 015
5.8 - BACKUP FILES
------------------
When performing Sysop maintenance such as modifying Message
Conferences or modifying File Areas, SPITFIRE makes "Backup" copies
for you. If disk space is a problem on your board copy the backup
files to disk or delete them. SPITFIRE backup files include:
SFMCONF.$$$ - Message Conferences Backup File
SFFAREA.$$$ - File Areas Backup File
5.9 - THOUGHTS.BBS
------------------
SPITFIRE displays a thought to callers if a file named
THOUGHTS.BBS is found in the directory configured as your display
file path. The program to create THOUGHTS.BBS can be downloaded
from Buffalo Creek's BBS at 515-225-8496 or you can optionally
download a ready-made THOUGHTS.BBS file.