Select Git revision
appendix.html
appendix.html 15.00 KiB
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<title>Appendix Listing</title>
</head>
<body>
<!--webbot bot="Include" U-Include="_borders/top.htm" TAG="BODY" startspan --><p>
<a href="http://www.synchro.net">
<img border="0" src="images/synclogo_fancyred.png" alt="Synchronet BBS - Multinode Bulletin Board Software" width="626" height="86"></a>
</p>
<hr>
<!--webbot bot="Include" endspan i-checksum="56836" -->
<p><a name="top"></a><a href="sysop.html#TOC">Back to Table of Contents</a></p>
<h2><a name="Appendix_A">[18.1] - Appendix A: Command Line Specifiers</a>
</h2>
<pre>Specifiers (argument replacement) for use with command lines in SCFG and many
string-related Baja functions.
<b>%a</b> User alias or name (may require surrounding with "'s)
<b>%b</b> Baud (DTE) rate
<b>%c</b> Connect description
<b>%d</b> Connect (DCE) rate
<b>%e</b> Estimated CPS rate*10
<b>%f</b> File path/name (example: C:\SBBS\NODE1\DOOR.SYS)
<b>%g</b> Temp directory (example: C:\SBBS\NODE1\TEMP\)
<b>%h</b> HardWare flow control (Y/N)
<b>%i</b> COM port IRQ line (if UART) or channel number (if Int 14h driver)
<b>%j</b> Data directory (example: C:\SBBS\DATA\)
<b>%k</b> Control directory (example: C:\SBBS\CTRL\)
<b>%l</b> Maximum lines per message
<b>%m</b> Minutes in the user's minute bank
<b>%n</b> Node directory (example: C:\SBBS\NODE1\)
<b>%o</b> Sysop's name (as specified in SCFG)
<b>%p</b> COM port number (0 if local node)
<b>%q</b> System's QWK ID (as specified in SCFG)
<b>%r</b> Rows on user's terminal screen
<b>%s</b> File specification (example: C:\FILES\*.ZIP) or current command string
<b>%t</b> Time (in seconds) user has left online
<b>%u</b> UART I/O address in hex or F=FOSSIL, B=PC BIOS, E=PS/2, D=DigiBoard
<b>%v</b> Synchronet version (example: 200a is Version 2.00 Revision a)
<b>%w</b> Timeslice API types supported (decimal bit field)
<b>%x</b> User's command shell (internal code)
<b>%y</b> COMSPEC environment variable or DOS Command Interpreter (if SBBS4OS2)
<b>%z</b> Text directory (example: C:\SBBS\TEXT\)
<b>%!</b> EXEC directory (example: C:\SBBS\EXEC\)
<b>%#</b> Node number (same as SBBSNNUM environment variable)
<b>%*</b> Node number (0 padded to 3 digits)
<b>%$</b> User's credits
<b>%%</b> Percent symbol
<b>%&</b> Used for DCDWATCH utility
<b>%?</b> Platform descriptions (e.g. Win32 or Linux) <i><font color="#FF0000"><b>(v3+ Only)</b></font></i>
<b>%1</b> User number
<b>%2</b> User number (0 padded to 2 digits)
<b>%3</b> User number (0 padded to 3 digits)
<b>%4</b> etc...</pre>
<h2><a name="Appendix_C">[18.3] - Appendix C: SBBS Environment Variables</a>
</h2>
<pre>During operation, Synchronet may write to several different environment
variables which can be utilized by other programs. Some of these environmentvariables 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:
<b>SBBSCTRL</b> 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).
<b>SBBSNODE</b> 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.
<b>SBBSNNUM</b> This variable contains the NUMBER of the active node. This
variable is set by SBBS at the time it is executed.
<b>SBBSFILENAME</b> 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.
<b>SBBSFILEDESC</b> 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.
<b>DSZLOG</b> 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.</pre>
<h2><a name="Appendix_E">[18.5] - Appendix E: Node Status Display</a>
</h2>
<pre>Anywhere within Synchronet's Telnet/RLogin interface, 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.
<b>Node Status Line:</b>
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.</pre>
<h2><a name="Appendix_F">[18.6] - Appendix F: Log File Line Type
Specifiers</a>
</h2>
<pre>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 applicationN+ 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.</pre>
<h2><a name="Appendix_G">[18.7] - Appendix G: File Formats</a>
</h2>
<pre>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:
<b>Sample Data Description</b>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 stringATDT 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
</pre>
<pre>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:
<b>Sample Data Description</b>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-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 Vertrauen.</pre>
<p><a href="#top"><b>Back to Top</b></a></p>
<!--webbot bot="Include" U-Include="_borders/bottom.htm" TAG="BODY" startspan -->
<hr>
<p><b><a href="http://www.synchro.net/copyright.html">Copyright</a> © 2006 by </b> <a href="http://www.synchro.net/author.htm"><b>Rob Swindell</b><br>
</a>
<a href="http://www.synchro.net"><font size="2"><br>
Synchronet BBS Software</font></a> <font size="2"> (Synchronet)
Version 3 is comprised of several documentation,<br>
library, executable, and <a href="http://www.synchro.net/source.html">source code</a>
files, all of which are covered by the<a href="http://www.fsf.org/copyleft/gpl.html">
<br>
GNU General Public License</a> with the exception of the following portions
covered by<br>
the <a href="http://www.fsf.org/copyleft/lesser.html">GNU Lesser General Public License</a>:
SMBLIB and XSDK.<br>
<br>
Synchronet Version 2 (for DOS and OS/2) and its source code was released to the<a href="http://www.fsf.org/philosophy/categories.html#PublicDomainSoftware">
<br>
Public Domain</a> by <a href="ftp://vert.synchro.net/main/sbbs/manifest.txt">Digital Dynamics</a>
in 1997 and remains Public Domain software today.<br>
Synchronet Version 3 is not Public Domain software.</font></p>
<p align="left"><font size="2"><a href="http://www.synchro.net">http://www.synchro.net</a>
</font></p>
<p align="left"><font size="2">For the complete Copyright Information please
read the <a href="http://www.synchro.net/copyright.html">Copyright Document</a>
.</font></p>
<!--webbot bot="Include" endspan i-checksum="15291" -->
</body>
</html>