SPONSORED LINKS
Specifiers (argument replacement) for use with command lines in SCFG and many string-related Baja functions. %a User alias or name (may require surrounding with "'s) %b Baud (DTE) rate %c Connect description %d Connect (DCE) rate %e Estimated CPS rate*10 %f File path/name (example: C:\SBBS\NODE1\DOOR.SYS) %g Temp directory (example: C:\SBBS\NODE1\TEMP\) %h HardWare flow control (Y/N) %i COM port IRQ line (if UART) or channel number (if Int 14h driver) %j Data directory (example: C:\SBBS\DATA\) %k Control directory (example: C:\SBBS\CTRL\) %l Maximum lines per message %m Minutes in the user's minute bank %n Node directory (example: C:\SBBS\NODE1\) %o Sysop's name (as specified in SCFG) %p COM port number (0 if local node) %q System's QWK ID (as specified in SCFG) %r Rows on user's terminal screen %s File specification (example: C:\FILES\*.ZIP) or current command string %t Time (in seconds) user has left online %u UART I/O address in hex or F=FOSSIL, B=PC BIOS, E=PS/2, D=DigiBoard %v Synchronet version (example: 200a is Version 2.00 Revision a) %w Timeslice API types supported (decimal bit field) %x User's command shell (internal code) %y COMSPEC environment variable or DOS Command Interpreter (if SBBS4OS2) %z Text directory (example: C:\SBBS\TEXT\) %! EXEC directory (example: C:\SBBS\EXEC\) %# Node number (same as SBBSNNUM environment variable) %* Node number (0 padded to 3 digits) %$ User's credits %% Percent symbol %& Used for DCDWATCH utility %? Platform descriptions (e.g. Win32 or Linux) (v3+ Only) %1 User number %2 User number (0 padded to 2 digits) %3 User number (0 padded to 3 digits) %4 etc...
The Synchronet BBS program (SBBS.EXE or SBBS4OS2.EXE) can be run with optional
command line switches. The switches should be separated by a space. Slash (/)
and dash (-) are ignored, so "SBBS B" and "SBBS /B" are equivalent. Case is
ignored, so "SBBS B" and "SBBS b" are equivalent. To list the available options
from the DOS command line, you may type "SBBS ?". Here is a list of available
switches:
B Use BIOS for video instead of direct screen writes
- Older multitasking software may require this switch
M Modem debug output
- This switch is helpful in solving problems with modem initialization
Q Quit after one call
- SBBS will exit back to DOS (phone off-hook) after one user
X Quit after one call (on hook)
- SBBS will exit back to DOS (phone on-hook) after one user
C# Connection already established at # bps
- If user already connected, pass current connect rate (DCE)
E# External event in # minutes
- If there is a non-Synchronet event coming up, pass minutes left
F Force daily event
- Used to force SBBS to execute its internal daily maintenance
L Local logon only
- If you want Synchronet to immediately go to the local logon prompt
I Don't initialize modem
- If you don't want Synchronet to initialize the modem
D Force Synchronet to think DCD is high
- Normally only used for NULL modem connections
Zs Pass Caller-ID string on command line as 's'
- Used in combination with 'C#' option, normally from front-end mailer
O Execute all pending events and immediately exit
- Used with front-end mailers
R# Additional rioctl call
- This switch is for the internal use of Synchronet only (DO NOT USE)
V Version information
- Displays the detailed version and revision information of SBBS
The Synchronet Configuration Utility (SCFG.EXE, SCFG32.EXE or SCFG4OS2.EXE)
requires at least one command line switch (hard-coded into the included
SBBS.BAT and SBBS.CMD files): the path to your Synchronet CTRL directory
(e.g. "SCFG ..\CTRL"). While no other command line options are normally needed,
the following command line options may be specified:
/M Show free memory in upper right corner
- Show available memory instead of current time (n/a in SCFG4OS2.EXE)
/N Don't use EMS for overlay caching
- Don't use Expanded Memory if detected (only in SCFG.EXE)
/S Don't check directories
- Don't create directories on the disk(s) if they don't exist
/F Force save of config files
- Used by the Synchronet INSTALL program
/U Update all message base status headers
- Forces the update of SMB headers to match current config
/H Don't update message base status headers
- Don't attempt to update SMB headers to match config (if changed)
/T# Set supported time slice APIs to #
- 0=DV if detected(default), 1=Int28, 2=WinOS2, 4=NoDV (SCFG.EXE only)
/B# Set automatic back-up level
- Set number of back-up files (*.CN# files) to keep (default=3 max=10)
During operation, Synchronet may write to several different environment variables which can be utilized by other programs. Some of these environment variables are also used by the utility programs that are included with Synchronet as well as third party programs written for Synchronet. Following is a list of environment variables and a brief explanation of them: SBBSCTRL This variable contains the path of the Synchronet CTRL directory. This variable is NOT set by (and not required to run) SBBS, it must be set manually prior to running any programs which require it (the Synchronet NODE utility, for example). SBBSNODE This environment variable contains the path of the node directory of the current node. This variable is set by SBBS at the time it is executed. Some off-line utilities may require this environment variable be set during boot-up (AUTOEXEC.BAT), in which case it should point to your NODE1 directory. SBBS.EXE will automatically reset this variable to point to the current node directory, for any online programs it may execute. SBBSNNUM This variable contains the NUMBER of the active node. This variable is set by SBBS at the time it is executed. SBBSFILENAME This variable contains the NAME of the file currently being processed (up to 12 characters including '.', not padded with spaces). This variable is set by Synchronet during 'Testable Filetype' events. The same information is written to the file SBBSFILE.NAM in the current node directory. NOTE: Upon returning from a 'Testable Filetype' event, Synchronet will read in information contained in the file SBBSFILE.NAM located in the current node directory to determine if the filename has changed during the testing process. SBBSFILEDESC This variable contains the ONE LINE DESCRIPTION of the file currently being processed (up to 58 characters). This variable is set by Synchronet during 'Testable Filetype' events. The same information is written to the file SBBSFILE.DES in the current node directory. NOTE: Upon returning from a 'Testable Filetype' event, Synchronet will read in information contained in the file SBBSFILE.DES located in the current node directory to determine if the file description has changed during the testing process. DSZLOG This variable is automatically set by Synchronet to point to the file PROTOCOL.LOG in the current node directory. If a transfer protocol has been configured (in SCFG) to support DSZLOG, then this log file will be read in by Synchronet after the transfer is complete, to determine which files were successfully transferred and which files were not.
Example:
Node #: 5 Mar 11 Space: 162,024k Laston: Digital Man 14400 Logons: 23/103 Total: 62,610 Timeon: 322/2430 Total: 5,321,900 Emails: 4/265 Posts: 4/12811 Fbacks: 2/17 Users: 1/592 Uloads: 324k Files: 1/2195 Dloads: 9,308k Files: 52 |
This status screen will be shown when the node is waiting for call if the sysop (User #1) has EXPERT mode turned ON and this node has Status Screen While WFC set to Yes in SCFG->Nodes->Node #->Toggle Options. The first line has the current node number, the current month and day, the amount of free disk space on the drive where the TEMP directory is located (should be on the drive where the majority of uploads are received), the user who was last on this node and with what type of connection. The second line has the number of logons today for this node/system, the total logons for history of the system, the time spent on today (in minutes) for this node/system and total time spent on for history of the system. The third line contains the number of E-mails sent today on the system/total E-mails currently waiting on the system, total number of Posts made on the system today/total posts in all sub-boards, number of feedbacks (E-mail to #1) sent today/total E-mail waiting for User #1, number of New Users today/total user slots on the system. The fourth line has the amount of uploads to the system today (in Kilobytes), number of files uploaded/total files in all directories, amount of downloads today (in Kilobytes) and total files downloaded today. If there are any active nodes or nodes with a critical error count, the status of those nodes will be displayed below the above statistical information.
Anywhere within Synchronet, you can list the users currently online with the
Ctrl-U command.
From the Main, Transfer, Multinode Chat, or Private Chat sections you can list
the current status of all the nodes with the '/L' command.
You can display the status of all nodes from the DOS command line (or batch
file) with the NODE utility.
If the WFC Status Screen is enabled, the status of all active nodes is
displayed.
Node Status Line:
The format of each node status line is as follows:
Node n: username action connection (flags) [sysflags]
Where:
n = node number
username = user's name
action = what the user is currently doing
connection = how the user is connected (bps rate if remote)
flags = letters representing special modes of the node:
A - Activity Alert Disabled:
User of this node will not be notified of
other users logging on or off other nodes.
L - Node is locked for sysop use:
Node is temporarily reserved for sysop
use only.
M - Message waiting for node:
An unreceived node-to-node message is
waiting for this node.
P - Page disabled:
User of this node does not wish to allow
users of other nodes to page him for chat
or send him node-to-node messages.
sysflags = modes that are sysop settable/viewable only:
A - Anonymous:
User on this node is in anonymous mode.
D - Down:
This node will be shutdown as soon as possible.
E - Event:
This node will run it's daily event (if one
is specified) before waiting for another
call.
I - Node will be interrupted:
Node connection will be terminated as soon
as possible.
Q - Quiet:
User on this node is in quiet mode.
R - Rerun:
This node will Rerun when user logs off.
U - User data update:
This user's data has been modified by
another node and needs to be read from
disk.
If the node is not in use, the possible status are:
Offline: Node is not currently running Synchronet
Waiting for Call: Node is waiting for a call.
Networking: Node is currently executing network functions.
New User Logging On: A user is logging on as new.
Waiting for all nodes to become inactive.
Running external event.
Waiting for node # to finish external event.
Each line in the daily caller log has a line type specifier (the first 2 characters). The specifiers and their descriptions follow: !! Critical error !* User auto-deleted !% User expired != New day for statistics !: Ran event @ Modem connection established @- Modem connection terminated @! Modem error @* Caller-ID information @R RIP support detected @W WIP support detected ++ Logon +! Logon error N New user begins application N+ New user finishes application N! New user fails application S+ Sysop enabling function S- Sysop disabling function S! Sysop security error P+ Posted message P- Removed message P! Posting error E Read E-mail E- Deleted E-mail E+ Sent E-mail EN Sent NetMail E! E-mail error C Chat function U+ Upload U- Removed Upload U! Attempted upload D- Download D! Attempted download X- External program execution T- Read text file M+ Moved message Q! QWK error L! Log already exists (possible crash) $+ Gained credits $- Lost credits *+ Gained minutes *- Lost minutes To view today's caller log, hit 'L' from the WFC screen or ";LOG" from the main menu. Yesterday's caller log can be viewed by hitting 'Y' at the WFC screen, or ";YLOG" from the main menu. The log files are stored in the DATA\LOGS directory with a file for each day named in the format: MMDDYY.LOG.
XTRN.DAT
This is the drop file that Synchronet creates for Synchronet specific
external programs. It is an ASCII text file with the format as follows:
Sample Data Description
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Digital Man User name
Vertrauen System name
digital man System operator
The Guru System guru
..\CTRL\ CTRL directory
..\DATA\ DATA directory
5 Total nodes on system
5 Current node number
19448 Time left online (in seconds)
Yes ANSI ? (Yes/No/Mono)
24 Lines per screen
10770335 Credits
99 Security Level
-unused-
12/31/69 Birthdate
M Sex (Gender)
1 User number
714-529-9525 User phone number
0 COM port (0 if no modem or local)
3 COM port IRQ (or channel number) [1]
2f8 COM port I/O address (in hex) [2]
2400 COM port DTE rate
No Modem uses hardware flow ctrl (Y/N)
No Modem locked at DTE rate (Y/N)
ATQ0V0E0M1X4&C1&D2H0 Modem initialization string
Modem special init string
ATV1E1X4 Modem terminal mode init string
ATDT Modem dial prefix
ATH1M0 Modem off-hook string
ATA Modem answer string
795154132 Address of Modem Status Register
11 Number of External Programs
Global War Names of External Programs (or blank
Trade Wars 2002 if user doesn't have access)
Food Fight!
Pit Fiend ][
Dice War
Synchronet Blackjack!
Domain Poker
Phantasia
Emperor
Synchronet Upgrade Door
Credit Card Order Door
AB D F J User's Flags #1
BC G JK N User's Flags #2
A L T User's Exemptions
D User's Restrictions
2b43cfd0 Expiration Date (Unix format in hex)
PO Box 501 User's Address
Yorba Linda, Ca User's Location
92686 User's Zip/Postal Code
A E User's Flags #3
B EFG User's Flags #4
1 Timeslice API types
Rob Swindell User's real name or company name
14400 User's DCE rate
..\EXEC\ EXEC directory (BBS executable files)
..\TEXT\ TEXT directory (TEXT files)
TEMP\ TEMP directory
VERT System's QWK ID
22C8 Node toggle options (in hex)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[1]: IRQ line if UART COM port type or Channel (zero based) if Int 14h type
[2]: I/O base address if UART COM port type or:
F = FOSSIL
B = PC BIOS
E = PS/2 BIOS
D = DigiBoard
MODUSER.DAT
This is an optional file created by external programs to modify the
data of the current user. It is an ASCII text file with the format:
Sample Data Description
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-500 Credit Adjustment
60 Security Level
-unused-
AB E I Flags #1 to add
G Flags #2 to add
A P T Exemptions to add
Restrictions to add
2b43cfd0 Expiration Date (Unix format in hex)
0 Add these number of minutes to bank
XYZ Flags #3 to add
TUV Flags #4 to add
J Flags #1 to remove
L Flags #2 to remove
Flags #3 to remove
Flags #4 to remove
D Exemptions to remove
A Restrictions to remove
If any of the lines in the file are blank, that user item is not
modified. The security level cannot exceed 89.
NOTE: Technical specifications and C source code for Synchronet configuration
and data files can be downloaded from our BBS.
Copyright © 2000 by Rob Swindell
Synchronet BBS Software (Synchronet)
Version 3 is comprised of several documentation,
library, executable, and source code
files, all of which are covered by the
GNU General Public License with the exception of the following portions
covered by
the GNU Lesser General Public License:
SMBLIB and XSDK.
Synchronet Version 2 (for DOS and OS/2) and its source code was released to the
Public Domain by Digital Dynamics
in 1997 and remains Public Domain software today.
Synchronet Version 3 is not Public Domain software.
Rob Swindell
PO Box 501
Yorba Linda, CA 92885
http://www.synchro.net
For the complete Copyright Information please read the Copyright Documentation .