README.DOC for TBBS Version 2.3
Last Updated 01/23/95
INTRODUCTION
This file, README.DOC, serves to present information about the
product which is not reflected in the TBBS documentation. This
includes documentation errors, additions, and clarifications. PLEASE
TAKE THE TIME NOW TO READ THROUGH THIS FILE, or do so at your
earliest convenience.
SOFTWARE MODS
Even the best software has bugs when it is as complex as TBBS. In
order to keep your software current, eSoft distributes a program
update system to fix any bugs which we find in the software. You
can use this system to protect your software investment. Each fix
(called a mod) is assigned a number. This release includes all mods
up to and including:
┌───┐
│ 0 │ <--- MOD LEVEL OF THE SOFTWARE ON THESE DISKETTES
└───┘
The software update program (UPDATE.EXE) is on this diskette. The
latest software update data file (UPDATE.BIN) is always available at
no charge for download from the eSoft, Inc. Support Board (for
access information, refer to the "In Case of Trouble..." card
included in your TBBS package). If you are experiencing difficulty
with the software, obtain and apply all newer mods before taking any
other action.
-------------------------------------------------------------------
IMPORTANT
-------------------------------------------------------------------
TBBS now requires at least an 80386 microprocessor. To continue
enhancing the performance of TBBS as well as to facilitate the
addition of several new features it was necessary to implement CPU
instructions that depend on the presence of a 386 (or greater).
TBBS will NOT install or run on lesser systems.
-------------------------------------------------------------------
UPGRADE COMPATIBILITY ISSUES
-------------------------------------------------------------------
TBBS 2.3 now supports mixed case names and subject text fields in
messages. If you wish to return to the TBBS 2.2 upper case only
methods, add the /CM switch to your MLTBBS line.
Enclosed files now show the file size in addition to the name. To
return to the TBBS 2.2 method, use EDLANG to remove the display of
the second parameter (%2) in Record 841.
TBBS now allows a starting date or message number at the forward
read message prompt. Use EDLANG to remove the words ", or date"
from record 203 to restore TBBS 2.2 compatibility in presentation.
TBBS now allows searching and tagging from the download prompt.
Use EDLANG to restore the TBBS 2.2 prompt if that level of backward
compatibility is required by editing Records 838 and 839 to empty
strings, and Change "<S>earch, " to "<L>ist, or <H>elp" in record 320.
Note: The second line of the TBBS 2.2 record 320 is now in record 840
and reads identically to TBBS 2.2 and needs no changes.
TBBS now allows making a file invisible from the TYPE=14 command. To
restore TBBS 2.2 presentation compatibility use EDLANG to change
"<D>el" to "<D>elete", change "<V>is" to "<V>isible", and remove
"<I>nvis, " and "<S>earch, "from Record 321.
TBBS now allows the <B>ack and <W>ait commands on the read message
pause line. For compatibility, the prompts are shipped configured
to the TBBS 2.2 presentation (even though the new commands are
active). Use Edlang to redesign the prompt as you wish. Record
number 843 (shipped as an empty string) is the "<B>ack, " prompt,
while record 844 is the "<W>ait, " prompt.
If you had used the INIT or PRECONDITION string S0=0 in TBBS 2.2
to make a modem incapable of answering the phone, you will need
to change that string to S0=00 in TBBS 2.3 to achieve the same
effect. S0=0 will cause TBBS to enter passive answer mode, and
that will defeat your original purpose (see below for details
on passive answer).
If you were using the TBBS 2.2 RIP KIT, you do not have to make
any changes to run with TBBS 2.3. However, you no longer need
to have /O:RIPOM on your MLTBBS command line, and if you do it
will just waste memory. Also, RIP support has been enhanced
significantly in TBBS 2.3, and you may well wish to use some of
the new TBBS 2.3 RIP capability. See the discussion of the
integrated RIP support below and in TBBSRIP.DOC.
Issues When .LNG files are Converted
------------------------------------
The TBBS installation program converts TBBS 2.2 language files to
TBBS 2.3 format by copying the TBBS 2.2 strings across as-is, and
then adding the new TBBS 2.3 STANDARD.LNG strings to them. Two
issues arise in such a conversion:
1. If the language file being converted is not English, the new
TBBS 2.3 strings must be translated, beginning with Record 658.
2. A few of the TBBS 2.2 strings have been broken into more strings
in TBBS 2.3, and some commands have added command letters. Those
changes must be addressed with small EDLANG changes to have a
fully TBBS 2.3 ready .LNG file that allows all TBBS 2.3 features
to be active, and all prompts to look fully normal.
These EDLANG changes in detail are:
Commands with added letters:
Record 635: add "STCR" to the END of the string to enable the
<S>earch, <T>ag, <C>lear, and <R>eview options in download
command prompts.
Record 637: add "WB" to the END of the string to enable the
<W>ait and <B>ack commands on the read message pause prompt.
Record 656: add "IS" to the END of the string to enable the
<I>nvisible and <S>earch options in a TYPE=14 command.
Prompt Strings with changes:
Record 3: Add a carriage return to the end of the string.
Record 203: Change "number," to "number, date,"
Record 236: Change ": " to "..." and add a carriage return to
the end of the line.
Record 237: Delete the second line of the string, leaving a
carriage return at the end of the first line.
Record 320: Change "<L>ist, or <H>elp" to "<S>earch, " and
delete the second line of this record.
Record 321: Change "<D>elete" to "<D>el", "<V>isible" to "<V>is"
and ", <L>ist, or <H>elp" to ", <I>nvis, <L>ist, <S>earch, or <H>elp".
These changes will make a converted TBBS 2.2 .LNG file fully
TBBS 2.3 compatible.
Note: If this seems like more work than making any custom changes
again, you may always just copy in the TBBS 2.3 STANDARD.LNG file
from your release disk and edit it using EDLANG.
-------------------------------------------------------------------
DOCUMENTATION OMISSIONS
-------------------------------------------------------------------
This section outlines features that were added to the software after
the documentation was prepared. They are presented here, with each
identified by a centered headline description.
Miscellaneous Changes
---------------------
The /A command line switch for MLTBBS has been added to control the
behavior of TBBS with regard to the the full-screen ANSI message
editor, full-screen QAL (questionnaire) mode, and full-screen file
select and tagging interface. When used, this switch tells TBBS NOT
to force these features for users who have tested positively for
ANSI capability during the ANSI poll at login, but which have set
"ANSI=No" in their TBBS configuration. Without this switch, TBBS
will give any user who CANANSI the full screen interfaces, even if
ANSI is suppressed elsewhere.
The MLTBBS command line switch /H has been added to make all
external events "hard". Normally a user who has no time limit set
may run a file transfer (upload or download) past the event time
and the event will run after the transfer completes. This is also
true of network mail handlers such as TIMS and PIMP. If the /H
switch is specified, then any user still active two minutes past the
time of the event will be killed, so the event will happen.
Note: The /H switch is NOT needed to handle modem failures, etc.
TBBS will always kill those lines for an event. This switch only
determines whether file transfers may run past an event or not.
Dropping carrier or timing out after uploading a file enclosure for
a message will now cause TBBS to save the message automatically.
This allows a user to enter a message, select to enclose a file,
start the upload, and walk away if desired.
File maintenance (Type 14 menu command) now allows you to make a
file invisible.
The FAR file format has been modified slightly. If the first two
lines of the FAR file begin with the tilde character (~) they will
be used as the "header" for display with the full-screen file area
select mechanism. (See "Additional Menu Command Opt Data Switches"
for Type 4 elsewhere in this README.DOC file.) The tilde character
is also used to control which comments are displayed when the
full-screen select mechanism is used; comments will be displayed
when the /Y switch is used only if the comment has the tilde
character (~) as the second character of the comment line entry.
The FAR file format has also been modified to allow up to all four
of the A flag groups instead of only one at a time. You may also
use P=, P<, and P> to specify privilege level comparisons. For
example:
TEST.DIR 'A1=X---.--- A2=XXX...-- P<100' Test File Area
...makes the specified A flag comparisons, as well as a check to see
that the user's privilege level is less than 100 in order to show
the corresponding file area to the user.
TBBS no longer clears the screen upon entry to an option module.
Most option modules clear the screen themselves upon startup under
most circumstances, however, so this may not be noticed in most
cases.
Improved Modem Handling
-----------------------
TBBS 2.3 has much more robust modem handling than TBBS 2.2 did.
It can recover from more modem and serial port failures, and it
will not hang on external events or fail to shut down because of
hardware failure in most cases.
If TBBS has modem and/or serial hardware problems that keep the
system from coming offline with the Alt-F3 keystroke, simply
repeating the keystroke will force TBBS down -- ignoring any hardware
problems. In addition, TBBS 2.3 will force lines down at external
event time, even if they have hardware problems, in a maximum of
two minutes after the time the event would have run without the
modem or serial port failure.
A security feature in TBBS 2.3 lowers DTR when Carrier Detect is
lost on a line, and leaves it low until the software re-initializes
the line. This means that even in the event of software or
hardware failure, no user can enter a session left by another user.
It also means that if the TBBS system locks up for any reason, the
modems will stop answering the phone once the software no longer
can respond to them, even with the traditional TBBS "active answer"
method of handling the modems.
In addition, TBBS now supports "passive answer," meaning that
you can optionally have TBBS detect an incoming ring indication
and answer the modem actively, instead of placing modems in
auto-answer mode. UNDERSTAND THAT THIS IS ONLY NECESSARY IN CASES
WHERE A MODEM IS DEFECTIVE IN DESIGN AND ANSWERS THE PHONE WHEN
THE DTR SIGNAL IS LOW (which is NOT normal, industry-standard
modem behavior). The above mentioned DTR handling change makes
all other advantages of passive answer be present in the normal TBBS
active answer mode.
TBBS assumes passive answer mode when the modem command S0=0
(disable auto-answer) is present in either the init or
pre-conditioning modem strings in CEDIT. Note that this feature
does not work with some modems, and can even cause some modems to
lock up and cease functioning. eSoft strongly recommends the use
of ACTIVE answer rather than passive answer except in unusual
circumstances, as it is generally much more reliable.
Note: If you were using S0=0 to prevent a modem answering on a line
you use for dial-out only, you need to change this to S0=00 to
avoid having TBBS 2.3 see this as a request for passive answering.
ULEDIT Enhancements
-------------------
ULEDIT supports user address fields directly (on a new, third screen
you can reach by pressing F5 repeatedly while viewing a user
record). In addition, a powerful, fully user-definable printing
capability has been added to let you generate mailing labels, lists,
new user letters, and more. Refer to the file ULEDIT.DOC for details
on the new ULEDIT printing options.
Adding Messages From a Text File
--------------------------------
TBBS 2.3 includes the ability to add messages to the message base
from text files. This feature is intended primarily for TDBS
developers who can, using this feature with a DOTBBS command in
TDBS, can now create messages from their programs.
The first step to creating a message from a file is to create the
text file. This file has a very specific format as follows:
All lines preceding the first blank line are considered part of the
header. All text after the first blank line is considered to be
part of the message body (up to a maximum of your CEDIT setting for
maximum message size). All header lines have the form:
X:data
where X: can be:
F: The FROM field of the message
T: The TO field of the message
S: The SUBJECT of the message
E: The name of a file to enclose with the message
(NOTE: If the file name begins with an asterisk (*),
then the file is deleted after the message is generated)
P: Indicates a message that should be private
R: Indicates a message that should generate a return receipt
W: Indicates a message that should be allowed to word wrap
No data is associated with the P:, R: and W: header lines.
A simple example (note that although indented here for readability,
all lines should be flush left):
F:SYSOP
T:%USER%
S:WELCOME!
E:C:\TBBS\BBSGUIDE.ZIP
P:
We are glad to have received your call %FIRST%! We try to
make all new users of the system feel at home, and to do that
we have enclosed a file that tells about our BBS and how to
use it. To download the file, just press E after this message
is displayed. I have your address as:
%USER%
%ADDR1%
%CITY%, %STATE% %ZIP%
If this isn't correct, please press R from the main menu to
Re-register with the proper address. This address is not
given out, and is only used to mail you our literature packet.
As you can see, insertion parameters are permitted and will be
expanded when the message is created.
Once the file is created in the format above, you trigger a Type 7
(message enter) menu command with the usual Opt Data, along with the
switch /C:<filename>, where <filename> is the name of the text file
with optional path (without a specific path, TBBS will search the
TBBSPATH for the file).
Here is an example menu command that shows usage of this feature:
KEY=^@
TYPE=7
OPTDATA=E-Mail /C:NEWUSER.MSG
Changes to the File Download System
-----------------------------------
TBBS 2.3 features "file tagging," a technique where a user may tag
or mark files that he wishes to download, then download the tagged
files as a batch. This has impact in several ways that were not
outlined in the manual:
- The Type 10 menu command now performs a check for tagged files.
If files have been tagged but not yet downloaded, the user will be
alerted to this fact and given an opportunity to perform a
download prior to completing the logoff operation. The /P:proto
switch has been added to the TYPE=10 command to allow you to
specify the protocols available for any batch downloaded at
logoff. The format ofthe switch is the same as for any file
download command (e.g. TYPE=34).
- Files tagged for download are stored in temporary files of the
name FSTAGxx.$$$ where "xx" is the line number the user is on.
These tag files use the same format as TBBS .DIR files. See
Chapter 6 of the TBBS manual for details on the format.
Additionally, any entry that begins with an asterisk (*) indicates
to TBBS that the file should be deleted after it is downloaded
successfully.
- TBBS is limited to approximately 100 tagged files per user. The
actual number of files that can be tagged depends on the length of
the path and file names tagged.
- TBBS can now "stage" the download of files from CD-ROM. This means
that they are copied from the CD-ROM to the local hard disk before
the download begins to reduce overall system impact. This feature
is configured using CEDIT. Select "Other" from the menu bar, then
"File Handling Options" from the drop-down menu. Context
sensitive help explains the various options.
- TBBS also supports remote CD-ROM staging with popular third party
handlers such as MFM/LAN or CopyIt/2. This too is setup using
CEDIT on the "File Handling Options" screen.
- ZMODEM downloads now report batch information, used by some
communications programs to display batch progress as well as file
progress.
Additional Menu Command Opt Data Switches
-----------------------------------------
Some menu command types have Opt Data switches that were not
documented in the manual. By menu command type number, they are:
Type 4, 46
The /Z switch enables the full-screen ANSI file interface with
file tagging. ANSI or VT-100 is required. If the user does not
have this support, TBBS will revert to the older style TTY file
interface method. On the Type 4 command, you may also place a
number between 1 and 6 after the /Z (such as /Z2, /Z4, etc.) if
desired; this forces TBBS to present the area listing using the
specified number of columns on-screen.
The /Y switch, when used in conjunction with the /Z switch
(mentioned above), causes TBBS to display comments in a .DIR or
.FAR file in addition to the files or file areas normally
displayed. (The default, when this switch is not present, is
not to display the comments.)
The /NV switch is used in conjunction with the /Z switch to
inhibit the context sensitive cursor movements during file
tagging. Without /NV, TBBS will move up a line or down a line
based on the last cursor movement when a file is tagged. This
allows tagging a batch of files by hitting space bar only. The
/NV switch inhibits this movement, and the cursor will only
move when the caller moves it explicitly.
Type 4, 46, and 47
The /M switch on uploads enables batch uploads to a .DIR area.
Type 10
The logoff command now accepts the /P:<protolist> switch to
restrict the protocol selection for a tagged file batch that
is downloaded at logoff. Format is identical to this same
switch on all file download commands.
Type 14
This file area maintenance facility now accepts the /Z switch
(discussed previously with the Type 4, 46 commands) to enable a
full-screen interface mode.
Type 48
This .DIR file delete function now accepts the /Z switch to
enable a full-screen interface mode.
Type 1
This file display command will now accept the /NC switch to
inhibit the normal clear screen when it returns to a menu.
Type=13
This Free/Bill command now will accept the /B switch to inhibit
only billing class time, while leaving total call time active.
The /C switch turns all billing back to normal (i.e. cancels
the effect of either a /B or a /F switch on this command). If
you wish to move from a /F to a /B condition, you must use a
Type=13 with a /C first.
Additional Insertion Parameters
-------------------------------
The following insertion parameters are present but not documented in
the manual:
%CANRIP%
Returns X if the RIP polling function found Remote Imaging
Protocol (RIP) emulation support to be available and enabled on
the caller's terminal; returns . otherwise.
%LANG%
Returns a single upper case letter corresponding to the language
Currently selected by the caller.
%LAST% and
%CLAST%
Returns the user's "last" name. %CLAST% returns this name in all
upper case letters, while %LAST% returns the name in mixed case.
TBBS determines the last name according to an algorithm that will
usually find what a human being would consider the last name minus
any suffixes such as Jr, Sr, III, MD, PHD, etc. It will usually
recognize compound last names such as "Van Buren" even though they
contain spaces. But it CANNOT be 100% accurate in all cases. So
it can be fooled. But it gets the last name right under all but
very difficult circumstances.
%M0%
A menu parameter (see Chapter 6 of the TBBS manual) that returns
the name of the menu being executed.
%MDMBPS%
Reports the speed of the modem connection using new TBBS 2.3
extended modem awareness, i.e., more accurately than the older
%BPS% insertion parameter.
%BPS%
(This parameter was supported in TBBS 2.2.) Reports the closest
"standard" data rate reflecting the connect speed of the modem.
Intended for backward compatibility; more accurate results can
be obtained by using the new %MDMBPS% parameter described above.
%RND%
Returns a random two-digit value from 00 to 99. It is useful
for generating random file displays with Type 1 menu commands.
New Menu Command Types
----------------------
The following menu command types were added after the manual went to
press:
Type 17
This command allows dynamic reselection of the currently set
language for a caller. The Opt Data is a single letter for the
language the user should be changed to. This also changes the
user's top level menu to 0000 for language A, 00LB for language
B, 00LC for language C, and so on. If the top level menu had
previously been overridden (by using the Type 35 menu command)
then the top level menu will NOT be changed, and must explicitly
be changed by another Type 35 command.
New QAL command
---------------
The QAL command Erase: <filespec> was added after the manual went to
print. This command allows you to erase a specific file name (wild
cards are not allowed). The syntax is:
Erase: <filespec>
Example:
Erase: C:\TBBS\QAL\MYQA.SVY
Note: Do not erase a file which is in USE! File system damage can
result if you do!
RIP Implementation Changes
--------------------------
RIP, the Remote Imaging Protocol, is now a standard part of TBBS
instead of a separate RIP Kit as it was with TBBS 2.2. All RIP
support previously offered by RIPOM (part of the RIP Kit) has been
internalized within TBBS itself. TBBS has also been enhanced to
support additional RIP functionality.
+----------------------------------------------------+
| Documentation for RIP and RIP-specific features |
| is included separately in the file TBBSRIP.DOC, |
| which you can find on the TBBS master disks. |
+----------------------------------------------------+
The following is a brief description of the changes and additions
that involve RIP support. Consult the TBBSRIP.DOC file for
additional details:
- RIP configuration for TBBS is contained in the file RIP.CFG. If
not available, it will look for RIPOM.CFG for backward
compatibility.
- The RIP_ON: command within the RIP configuration file (RIP.CFG) is
now orphaned, and exists for backward compatibility only. If
present, then the flags specified will be used to determine
whether the user is in RIP mode or not for the Type 204 command
insertion strings of the format:
Type=204 Opt Data=<RIP_Seq> <Cmd_Type> <Opt_Data>
If the RIP_ON: command is not present in the RIP configuration
file, then the new TBBS 2.3 method of determining RIP by matching
language letters will be used for these commands.
+----------------------------------------+
| eSoft recommends that you remove the |
| RIP_ON: command for maximum TBBS 2.3 |
| functionality once you upgrade. |
+----------------------------------------+
- A new configuration command for the RIP configuration file
(RIP.CFG) has been added. The RIP_LANG: command defines which
language letter(s) are RIP format files. The syntax is as
follows:
RIP_LANG: a[, b[, c...]]
Where a, b, c, etc. represent the letters of language files
defined by LANGUAGE.BBS which are RIP format. Two example:
RIP_LANG: B
RIP_LANG: B, D
In the former example, language B is RIP. In the latter, both B
and D languages are RIP.
TBBS uses this language letter association to determine whether
automatic, internal RIP processing is required or not. If a user
select a language associated by the RIP_LANG: command, the RIP
processing is assumed, and any other language letter means that
RIP processing will not be enabled.
- The RIPSEQn_TYPES: command has also been added to the RIP
configuration file (RIP.CFG), and allows the definition of which
internal TBBS command types require RIP prefix strings. TBBS will
automatically provide these prefixes when a RIP language (as
defined by the RIP_LANG: command) is active. This eliminates the
need for Type 204 prefix string commands (as needed with TBBS 2.2
and RIP Kit) in most cases. The syntax is:
RIPSEQn_TYPES: n[, n[, n...]]
Where n is a decimal menu command type or types which should have
the RIPSEQn string sent as a prefix. You may also use a value of
"OM" for n to indicate that all option module calls and returns
from DOTBBS commands should be prefixed with the indicated RIP
sequence. A value of "MENU" indicates a RIP prefix sequence that
is sent prior to displaying menu text. Examples:
RIPSEQ1_TYPES: 1, 2, 4, 20, 34, 46, 48
RIPSEQ2_TYPES: 32, 33, OM, MENU
These examples indicate that menu command types 1, 2, 4, 20, 34,
46 and 48 should be prefixed by the string defined by the RIPSEQ1:
command, and the menu command types 32, 33 and all option modules,
returns from DOTBBS commands, and menu text displays should be
prefixed by the string defined by the RIPSEQ2: command.
With this definition, no further special menu handling is required
to assure proper handling of internal TBBS commands when using
RIP.
+---------------------------------------------+
| You may remove any Type 204 style command |
| prefixing from your TBBS menus if desired |
| once conversion to TBBS 2.3 is complete. |
+---------------------------------------------+
- The RIP_POLL: command has also been added to the RIP configuration
file (RIP.CFG), and causes TBBS to poll (a test) for caller's
support of RIP emulation prior to the opening language selection
prompt. The syntax is:
RIP_POLL: NO | YES | AUTO=x
RIP_POLL: NO is the default, and indicates that TBBS should not
perform a RIP poll.
RIP_POLL: YES causes TBBS to do a RIP poll, record the answer, but
take no other action.
RIP_POLL: AUTO=x causes TBBS to do a RIP poll, record the answer,
and if the answer is that RIP is supported, immediately switch the
language to the language indicated by the single letter "x" in
AUTO=x.
Example:
RIP_POLL: AUTO=b
Means poll for RIP, and if the caller can do RIP, immediately
switch to language B. Note that if AUTO is selected, and the
language is switched by a positive RIP poll, then any opening
language selection menu prompt is skipped. The opening language
prompt will only occur if the poll is negative.
The answer to a RIP poll may be queried through the use of the new
insertion parameter %CANRIP% which will return an "X" is the
caller is RIP capable, and a "." otherwise.
If you have also set CEDIT to request an ANSI poll, then either
RIP_POLL: YES or RIP_POLL: AUTO=c will poll for both RIP and ANSI
prior to any other action after connection. The normal position
for an ANSI poll (after login) will be suppressed in this case, as
the poll will already have occurred. From this single poll, the
two insertion parameters %CANANSI% and %CANRIP% will be set to
reflect the capabilities of the caller.
- The Type 204 command has been extended to support RIP conditional
execution of menu entries. The syntax is:
Type=204 Opt Data=0 <Cmd_Type> <Opt_Data>
For those familiar with the TBBS RIP Kit, note that this would
appear to execute RIP sequence zero. This command will execute
the menu option specified by <Cmd_Type> with the Opt Data
specified by <Opt_Data> but only if the user is currently using a
RIP language. Otherwise, the command is ignored. This allows
menu commands to be conditionally executed based on whether the
caller has RIP active or not. An example:
Type=204 Opt Data=0 5 RIP1
This command will be a Type 5 menu command with Opt Data "RIP1"
only if the caller is in a RIP language.