| Both sides previous revisionPrevious revision | |
| util:sbbsecho [2024/11/08 23:33] – [Area Manager Commands] update help to reflect SBBSecho v3.21 AreaMgr request format digital man | util:sbbsecho [2025/04/09 14:20] (current) – Document areas.ini digital man |
|---|
| </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 EchoMail messages using this scheme. | 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> |
| ╔═══════════════════════════════════════╗ | ╔═══════════════════════════════════════╗ |
| ║ │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> |
| |
| ==== 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> |
| |
| 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 ===== |
| |
| == 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 == |
| |
