Synchronet v3.20d-Win32 (install) has been released (Mar-2025).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
util:sbbsecho [2020/03/10 21:56] – [SCFG] missing closing paren digital manutil:sbbsecho [2025/04/09 14:20] (current) – Document areas.ini digital man
Line 1: Line 1:
-====== SBBSecho ======+====== SBBSecho - FidoNet Tosser ======
    
 Synchronet's FidoNet EchoMail Program Synchronet's FidoNet EchoMail Program
Line 65: Line 65:
 </file> </file>
  
 +An alternative method is to instead subscribe/link to the echoes (on your hub/uplink) you wish to carry on your BBS (e.g. via AreaFix request netmail message) and then as SBBSecho attempts to import received packets, it will add unknown areas to your ''[[dir:data]]/badareas.lst'' file. Import that file (''badareas.lst'') into SCFG->Message Areas->FidoNet. SBBSecho will automatically remove "known" areas from the ''badareas.lst'' file after they've been added to SCFG. You will lose some received EchoMail messages using this scheme.
 ===== Area File ===== ===== Area File =====
  
-By default, SBBSecho will try to open an //Area File// (by default, ''[[dir:data]]/areas.bbs''). The Area File can be used to associate FidoNet EchoTags with sub-boards configured in [[util:SCFG]]->Message Areas. You can also specify downlinks and pass-through areas in an Area File, if need be. The Area File is optional, not strictly needed, when you have the "Automatically Add New Subs to Area List" option enabled and set to "List Only" in [[util:EchoCfg]]->EchoMail Settings.+By default, SBBSecho will try to open an //Area File// (by default, ''[[dir:data]]/areas.bbs'').
  
-To successfully operate without an Area File, you must have your hub configured in [[util:EchoCfg]]->Linked Nodes with its "Uplink for Message Groups" setting set to the //short name// of the message group you created for this network in [[util:SCFG]]->Message Areas.+The Area File can be used to associate FidoNet EchoTags with sub-boards configured in [[util:SCFG]]->Message Areas. You can also specify downlinks and pass-through areas in an Area File, if need be.
  
-You will need an Area File if you are to have any downlinks (nodes for which you are //their// hub to the network).+The Area File is optional, not strictly needed, when you have the "Automatically Add New Subs to Area List" option enabled and set to "List Only" in [[util:EchoCfg]]->EchoMail Settings. To successfully operate **without** an Area File, you must have your hub configured in [[util:EchoCfg]]->Linked Nodes with its "Uplink for Message Groups" setting set to the //short name// of the message group you created for this network in [[util:SCFG]]->Message Areas.
  
-[[util:SCFG]] can also export a group of message areas (sub-boards) to an SBBSecho-compatible Area File using the Message Group "Export Areas..." option:+You **will** need an Area File if you are to have any downlinks (nodes for which you are //their// hub to the network). 
 + 
 +[[util:SCFG]] can also export a group of message areas (sub-boards) to an SBBSecho-compatible Area File (in either ''areas.bbs'' or ''areas.ini'' format) using the Message Group "Export Areas..." option:
 <file> <file>
 ╔═══════════════════════════════════════╗ ╔═══════════════════════════════════════╗
Line 80: Line 83:
 ║ │subs.txt       Synchronet Sub-boards ║ ║ │subs.txt       Synchronet Sub-boards ║
 ->│areas.bbs      SBBSecho Area File   <- ->│areas.bbs      SBBSecho Area File   <-
 +->│areas.ini      SBBSecho Area File   <-
 ║ │backbone.na    FidoNet EchoList      ║ ║ │backbone.na    FidoNet EchoList      ║
 +║ │newsgroup.lst  USENET Newsgroup List ║
 ╚═══════════════════════════════════════╝ ╚═══════════════════════════════════════╝
 </file> </file>
Line 87: Line 92:
  
 ==== Format ==== ==== Format ====
 +
 +Two area file formats are supported by SBBSecho (pick one):   
 +  * areas.bbs - historic/legacy style, one echo/area per line  
 +  * areas.ini - more modern style, one echo/area per [section] 
 +
 +=== areas.bbs ===
  
 Each line of the SBBSecho Area File (e.g. ''areas.bbs'') represents an EchoMail message //area// in the following format: Each line of the SBBSecho Area File (e.g. ''areas.bbs'') represents an EchoMail message //area// in the following format:
   CODE TAG LINK [LINK] [...]   CODE TAG LINK [LINK] [...]
 +
 Where each field is separated by white-space (space or tab characters) and the fields are: Where each field is separated by white-space (space or tab characters) and the fields are:
  
-=== CODE ===+== CODE ==
 The ''CODE'' field is the internal code of the sub-board. The ''CODE'' field is the internal code of the sub-board.
  
 Internal codes consist of a combination of the Message Group's "code prefix" and the Sub-board's "code suffix". The full internal code may be as long as 16 characters and may not contain white-space or any invalid filename characters. Internal codes consist of a combination of the Message Group's "code prefix" and the Sub-board's "code suffix". The full internal code may be as long as 16 characters and may not contain white-space or any invalid filename characters.
  
-== Pass-through Areas ==+= Pass-through Areas =
 Any unrecognized internal codes are considered //pass-through// (not imported into your BBS's message areas). Using "''P''" for the internal code of pass-through areas will prevent warnings from being logged about the internal code not being found in your BBS's message base configuration (i.e. in ''[[util:SCFG]]''->Message Areas). Any unrecognized internal codes are considered //pass-through// (not imported into your BBS's message areas). Using "''P''" for the internal code of pass-through areas will prevent warnings from being logged about the internal code not being found in your BBS's message base configuration (i.e. in ''[[util:SCFG]]''->Message Areas).
  
-=== TAG ===+== TAG ==
 The ''TAG'' field is the FTN area tag (or echo tag) as shown in your FTN network's agreed upon echo list file (e.g. ''BACKBONE.NA'' for the FidoNet North American backbone). Area tags may not contain white-space characters. The ''TAG'' field is the FTN area tag (or echo tag) as shown in your FTN network's agreed upon echo list file (e.g. ''BACKBONE.NA'' for the FidoNet North American backbone). Area tags may not contain white-space characters.
  
-== Long Tags ==+**Long Tags**\\
 Although standard FidoNet echo tags (AKA "area tag") may be as long as 35 characters, Synchronet's Sub-board //short names// are limited to a length of 25 characters. As of July 28, 2018, Synchronet v3.17a will import (e.g. from a ''BACKBONE.NA'' file) echo tags longer than 25 characters into the "Newsgroup" name of the sub-board. Each sub-board's "Newsgroup" name can accommodate a length of up to 63 characters (no spaces). Likewise, when exporting message areas from SCFG or SBBSecho (e.g. to an ''areas.bbs'' file), if a "Newsgroup" name is defined for a message area, it will be used for the exported echo tag of that exported area. Although standard FidoNet echo tags (AKA "area tag") may be as long as 35 characters, Synchronet's Sub-board //short names// are limited to a length of 25 characters. As of July 28, 2018, Synchronet v3.17a will import (e.g. from a ''BACKBONE.NA'' file) echo tags longer than 25 characters into the "Newsgroup" name of the sub-board. Each sub-board's "Newsgroup" name can accommodate a length of up to 63 characters (no spaces). Likewise, when exporting message areas from SCFG or SBBSecho (e.g. to an ''areas.bbs'' file), if a "Newsgroup" name is defined for a message area, it will be used for the exported echo tag of that exported area.
  
-== Bad Echo Area == +**Bad Echo Area**\\
 If an area's ''TAG'' field value is a ''*'' (asterisk), then the area will be considered a "bad echo" area and will receive all messages for areas not otherwise specified in this file (sort of a 'catch-all' bin for 'unknown' areas). You can have **only one** "bad echo" area configured in your Area File. To //re-toss// (move) messages from the "bad echo" area into newly added or linked sub-boards, run SBBSecho with the ''-r'' command-line option.  If an area's ''TAG'' field value is a ''*'' (asterisk), then the area will be considered a "bad echo" area and will receive all messages for areas not otherwise specified in this file (sort of a 'catch-all' bin for 'unknown' areas). You can have **only one** "bad echo" area configured in your Area File. To //re-toss// (move) messages from the "bad echo" area into newly added or linked sub-boards, run SBBSecho with the ''-r'' command-line option. 
  
-=== LINK ===+== LINK ==
 Each ''LINK'' field is an FTN address which you wish to import mail from and export mail to. At the very least, your uplink's (hub's) address should be listed here. Your address should **NOT** be listed here. If multiple link fields are specified, you should specify the full 3D or 4D address for each. Links can be remotely added or removed from the Area File by authenticated Nodes using AreaFix. Each ''LINK'' field is an FTN address which you wish to import mail from and export mail to. At the very least, your uplink's (hub's) address should be listed here. Your address should **NOT** be listed here. If multiple link fields are specified, you should specify the full 3D or 4D address for each. Links can be remotely added or removed from the Area File by authenticated Nodes using AreaFix.
  
-Lines beginning with a semicolon (;) are considered comments, and are ignored. +=== Example ===
-==== Example ====+
  
 <file> <file>
Line 123: Line 133:
  
 The amount of spacing (white-space characters including horizontal tabs and spaces) between each element in the line is not important. Each line may be up to 1024 characters in length. The amount of spacing (white-space characters including horizontal tabs and spaces) between each element in the line is not important. Each line may be up to 1024 characters in length.
 +
 +**Note**:
 +  * Only the code and tag fields are required                            
 +  * The code and tag fields are case in-sensitive                        
 +  * The link fields must be 2D, 3D, or 4D FidoNet-style node addresses   
 +  * The '[' and ']' characters are not part of the link syntax           
 +  * Lines beginning with a semicolon (;) are ignored (i.e. comments)     
 +  * Leading white-space characters are ignored                           
 +  * Blank lines are ignored                                              
 +  * A tag value of '*' indicates a bad echo (unknown) area               
 +  * A code value of 'P' indicates a pass-through message area            
 +  * This file may be import/exported to/from your Message Areas in SCFG  
 +  * This file may be remotely modified by authorized nodes using AreaMgr 
 +
 +=== areas.ini ===
 +
 +<file areas.ini>
 +[tag]                                                                  
 +sub = code                                                             
 +links = link [link ...]                                                
 +pass-through = true or false (default: false)                          
 +</file>
 +                                                                       
 +Example ''areas.ini'' Area Section:                                        
 +                                                                       
 +   [BBS_CARNIVAL]                                                      
 +   sub = FIDO_BBS_CARN                                                 
 +   links = 1:218/700                                                   
 +                                                                       
 +**Note**:                                                              
 +  * Each area definition begins with the [tag] line (the '[' and ']' characters are required)                           
 +  * The code and tag values are case in-sensitive                       
 +  * The link values must be 2D, 3D, or 4D FidoNet-style node addresses  
 +  * The '[' and ']' characters are not part of the link syntax          
 +  * Lines beginning with a semicolon (;) are ignored (i.e. comments)    
 +  * Leading white-space characters are ignored                          
 +  * Blank lines are ignored                                               
 +  * A tag value (section name) of '*' indicates a bad echo (unknown) area 
 +  * This file may be import/exported to/from your Message Areas in SCFG   
 +  * This file may be remotely modified by authorized nodes using AreaMgr  
  
 ===== Configure ===== ===== Configure =====
Line 317: Line 367:
 Log Timestmap Format defines the format of the date/time-stamps added   Log Timestmap Format defines the format of the date/time-stamps added  
 along with each log message to the log file (e.g. ''sbbsecho.log'').    along with each log message to the log file (e.g. ''sbbsecho.log'').   
-The timestamp format is defined using standard C ''strftime'' notation.+The timestamp format is defined using standard C ''[[custom:strftime]]'' notation.
 The default format is: ''%Y-%m-%d %H:%M:%S''.            The default format is: ''%Y-%m-%d %H:%M:%S''.           
 For SBBSecho v2 timestamp format, use ''%m/%d/%y %H:%M:%S''.             For SBBSecho v2 timestamp format, use ''%m/%d/%y %H:%M:%S''.            
Line 520: Line 570:
  
 == AreaFix Password == == AreaFix Password ==
-AreaFix passwords are required to be included in the //Subject// line of received AreaFix requests (NetMail messages). +AreaFix passwords (AKA AreaManager passwords) are required to be included in the //Subject// line of received AreaFix/AreaManager requests (NetMail messages). 
-AreaFix Passwords are case insensitive.                         +AreaFix Passwords are case insensitive and cannot contain spaces.                         
 This setting may be managed by the node using AreaFix requests.  This setting may be managed by the node using AreaFix requests. 
  
Line 771: Line 821:
 from any additionally configured EchoLists which they have from any additionally configured EchoLists which they have
 access to. access to.
 +
 +== Zone Blind SEEN-BY and PATH Lines ==
 +Zone Blind SEEN-BY and PATH Lines when Enabled will cause SBBSecho to assume that node numbers are not duplicated across zones and that a net/node combination in either of these Kludge lines should be used to identify a spcific node regardless of which zone that node is located in (thus breaking the rules of FidoNet 3D addressing).
 +
 +If you are having trouble with FidoNet echomail crossing Zone boundaries which does not add all the SEEN-BY and PATH nodes, then enable this option with the limit of "4".
  
 === Paths and Filenames === === Paths and Filenames ===
Line 818: Line 873:
  
 == Area File == == Area File ==
-This is the path and filename of the file that SBBSecho will +This is the path of the file SBBSecho will use as your primary       
-use as it's EchoMail Message Area File.  By default SBBSecho looks for +list of FidoNet-style message areas.  This file is only required     
-the file ''areas.bbs'' in the //data// directory defined in SCFG. +to exist if you need SBBSecho to support Area Manager operations.    
 +                                                                     
 +Two area file formats are supported by SBBSecho (pick one):          
 +  * areas.bbs - historic/legacy style, one echo/area per line         
 +  * areas.ini - more modern style, one echo/area per [section]        
 +                                                                    
 == Bad Area File == == Bad Area File ==
  
Line 944: Line 1003:
 == AreaFix Keys == == AreaFix Keys ==
 These are the keys required for a node to be able to gain These are the keys required for a node to be able to gain
-access to this particular echo list.  These flags are defined +access to this particular echo list.  These keys are then given 
-for each node from the 'Linked Nodes...' sub-menu.+to chosen nodes in the 'Linked Nodes...' sub-menu.
 Selecting this option will bring you to a sub-menu where you Selecting this option will bring you to a sub-menu where you
 may add and remove keys for this EchoList. may add and remove keys for this EchoList.
Line 957: Line 1016:
 ==== Instances ==== ==== Instances ====
  
-SBBSecho is designed to run only one instance at a time. A mutual-exclusion file (''[[dir:ctrl]]/sbbsecho.bsy'') is used to insure that multiple instances of SBBSecho are not allowed to execute concurrently. If SBBSecho crashes or is externally-killed without being able clean up after itself, it's possible this mutex file will be left behind and prevent SBBSecho from running normally for quite some time (depending on the configuration value of ''BSY Mutex File Timeout'').+SBBSecho is designed to run only one instance at a time. A mutual-exclusion file (''[[dir:ctrl]]/sbbsecho.bsy'') is used to insure that multiple instances of SBBSecho are not allowed to execute concurrently. If SBBSecho crashes or is externally-killed without being able to clean up after itself, it's possible this mutex file will be left behind and prevent SBBSecho from running normally for quite some time (depending on the configuration value of ''BSY Mutex File Timeout'').
  
 If you get the following error message (on the console and/or the log file) and you can confirm that SBBSecho is not actually running, you can safely delete the mutex file to allow SBBSecho to again run normally: If you get the following error message (on the console and/or the log file) and you can confirm that SBBSecho is not actually running, you can safely delete the mutex file to allow SBBSecho to again run normally:
Line 1022: Line 1081:
 Remote area manager, or AreaFix, commands are used by linked nodes in order to Remote area manager, or AreaFix, commands are used by linked nodes in order to
 turn echo areas off and on, list currently connected areas, and more. turn echo areas off and on, list currently connected areas, and more.
-The following text is from the file ''[[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/exec/areamgr.hlp|areangr.hlp]]'' which, after installation of+The following text is from the file ''[[https://gitlab.synchro.net/main/sbbs/-/raw/master/exec/areamgr.hlp|areamgr.hlp]]'' which, after installation of
 SBBSecho, should be located in your Synchronet ''[[dir:exec]]'' directory. This file lists the SBBSecho, should be located in your Synchronet ''[[dir:exec]]'' directory. This file lists the
 area manager commands available to the linked nodes which have been configured using area manager commands available to the linked nodes which have been configured using
 the ''[[util:echocfg]]'' program: the ''[[util:echocfg]]'' program:
 <file> <file>
-Address all requests to 'SBBSecho' or 'AreaFix' (without quotes). +Address all Area Management requests to 'AreaFix' (without quotes). 
-Your Area Manager password goes on the subject line.+Your Area Manager password goes in the message subject followed optionally 
 +by -R, -L, or -Q for Rescan, List, or Query functions, respectively.
  
-In the body of the message to Area Manager:+In the body of the message, one or more:
  
-[+]<areaname>         Connect an area +<areatag>             Connect a message area (echo) 
--<areaname>           Disconnect an area+-<areatag>            Disconnect an area
 %HELP                 Request this message %HELP                 Request this message
-%LIST                 Request a list of areas available to you+%LIST                 Request a list of areas (tags) available to you
 %QUERY                Request a list of areas to which you are connected %QUERY                Request a list of areas to which you are connected
 %UNLINKED             Request a list of areas to which you are not connected %UNLINKED             Request a list of areas to which you are not connected
-%COMPRESSION <type>   Change the compression type (e.g. ARC/ARJ/LZH/PAK/SQZ/ZIP/ZOO)+%COMPRESSION <type>   Change the compression type (e.g. ARC, ARJ, LZH, ZIP)
 %PASSWORD <password>  Change your Area Manager password %PASSWORD <password>  Change your Area Manager password
 %PKTPWD <password>    Set or change your Packet password %PKTPWD <password>    Set or change your Packet password
 %TICPWD <password>    Set or change your TIC File password %TICPWD <password>    Set or change your TIC File password
 %RESCAN               Request a rescan of all connected areas %RESCAN               Request a rescan of all connected areas
-%RESCAN <areaname>    Request a rescan of a single connected area+%RESCAN <areatag>     Request a rescan of a single connected area 
 +%ECHOSTATS <areatag>  Request statistics (import/export details) of an area
 %ACTIVE               Reconnect (resume) all temporarily disconnected areas %ACTIVE               Reconnect (resume) all temporarily disconnected areas
 %PASSIVE              Temporarily disconnect (pause) all connected areas %PASSIVE              Temporarily disconnect (pause) all connected areas
 +%NOTIFY <ON | OFF>    Turn periodic Notification Messages ON or OFF
 %FROM <address>       Remote/proxy Area Management, must be the first command %FROM <address>       Remote/proxy Area Management, must be the first command
 %+ALL                 Connect all available areas %+ALL                 Connect all available areas
Line 1059: Line 1121:
  
 ==== Changes in Version 3 ==== ==== Changes in Version 3 ====
- 
-For a detailed list of changes and code differences introduced in v3.0, see [[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/src/sbbs3/sbbsecho.c?revision=3.0&view=markup|This page in CVS]]. 
  
 The most major changes introduced in v3.0 are: The most major changes introduced in v3.0 are:

Trace: