Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

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
Next revisionBoth sides next revision
module:sbbslist [2017/12/10 00:40] – [Configuration] digital manmodule:sbbslist [2019/01/24 17:12] – [Command-line] Added the delete command and the -remote option digital man
Line 10: Line 10:
   * Auto-synchronizes statistics (e.g. totals) in the local system's entry in the database   * Auto-synchronizes statistics (e.g. totals) in the local system's entry in the database
   * Auto-verifies TCP/IP services of listed BBSes and tracks the results   * Auto-verifies TCP/IP services of listed BBSes and tracks the results
 +
 +===== Dependencies ===== 
 +
 +As of this writing, sbbslist v4 is known to be compatible with Synchronet v3.17, under development.
 +
 +A JavaScript ''printf()'' bug in Synchronet v3.16 causes sbbslist v4 to crash in Synchronet for Linux, but appears to work fine in the Windows build.
 +
 +Files known to be required by sbbslist v4:
 +  * ''exec/sbbslist.js''
 +  * ''exec/load/sbbslist_lib.js''
 +  * ''exec/load/sbbslist_html.js''
 +  * ''exec/load/sbbsdefs.js''
 +  * ''exec/load/sockdefs.js''
 +  * ''exec/load/portdefs.js''
 +  * ''exec/load/modopts.js''
 +  * ''exec/load/graphic.js''
 +  * ''exec/load/termcapture_lib.js''
 +  * ''exec/load/synchronet-json.js''
  
 ===== History =====  ===== History ===== 
Line 32: Line 50:
   * ''[[dir:exec]]'' for the main 'executable', ''sbbslist.js''   * ''[[dir:exec]]'' for the main 'executable', ''sbbslist.js''
   * ''[[dir:exec]]/[[dir:exec#load]]'' for loadable library files, e.g. ''sbbslist_lib.js''   * ''[[dir:exec]]/[[dir:exec#load]]'' for loadable library files, e.g. ''sbbslist_lib.js''
 +
 +===== Installation  ===== 
 +
 +From command-line, run ''jsexec sbbslist install''
 +
 +If all the prerequisites were met, this step will perform all the necessary configuration changes mentioned later in this document and you should be ready to go with the new Synchronet BBS List.
 +
 +:!: **Note**:
 +If you previously had the ''SBL'' door in an external program section other than the //first// external program section, you may want to move the new ''SBBSLIST'' configuration to that location (in [[util:SCFG]]->External Programs->Online Programs).
  
 ===== Configuration =====  ===== Configuration ===== 
Line 39: Line 66:
 [sbbslist] [sbbslist]
 sort         = name sort         = name
 +reverse      = false
 format       = 0 format       = 0
-sub          = syncdata 
 add_ars      = not guest add_ars      = not guest
 beep         = true beep         = true
 +sub          = dove-syncdata
 live_preview = true live_preview = true
 +backup_level = 5
 +export_freq  = 7
 </file> </file>
  
 ^ Option       ^ Description ^ ^ Option       ^ Description ^
-| sort         | The default list sort field (default: none) | +| sort         | The default list sort field (default: //none//) | 
-| format       | The default browse list format (0-9, default: 0) | +| reverse      | Reverse the default sort order (default: ''false'') | 
-| add_ars      | The access requirements to //add// a BBS entry (default: none) | +| format       | The default browse list format (''0''-''9'', default: ''0'') | 
-| beep         | Set to false to disable beeps sent to the remote terminal (default: true) | +| add_ars      | The access requirements of a user able to //add// a BBS entry (default: none) | 
-| sub          | Sub-board internal code for import and export command (default: none) | +| beep         | Set to false to disable beeps sent to the remote terminal (default: ''true'') | 
-| live_preview | Set to true to enable live previews (outbound connections) while in browse mode (default: false) | +| sub          | Sub-board internal code for import and export command (default: //auto-detected//) | 
 +| live_preview | Set to true to enable live previews (outbound connections) while in browse mode (default: ''false'') | 
 +| backup_level | Over-ride the default number of backup files to maintain (default: ''5'') | 
 +| export_freq  | Maximum export (to message-base) frequency, in days (default: ''7'') |
 ==== Sorting ==== ==== Sorting ====
 The configured/default sort field can also be specified on the ''sbbslist'' command-line (e.g. using the ''-sort'' option). The available sort fields are: The configured/default sort field can also be specified on the ''sbbslist'' command-line (e.g. using the ''-sort'' option). The available sort fields are:
Line 169: Line 201:
 ║ │Internal Code                   SMB2SBL                           ║ ║ │Internal Code                   SMB2SBL                           ║
 ║ │Start-up Directory                                                ║ ║ │Start-up Directory                                                ║
-║ │Command Line                    ?sbbslist import=syncdata         ║+║ │Command Line                    ?sbbslist import                  ║
 ║ │Enabled                         Yes                               ║ ║ │Enabled                         Yes                               ║
 ║ │Execution Node                  1                                 ║ ║ │Execution Node                  1                                 ║
Line 184: Line 216:
 ╚════════════════════════════════════════════════════════════════════╝ ╚════════════════════════════════════════════════════════════════════╝
 </file> </file>
- 
-**Note:** 
-Take care to match the //internal code// (''syncdata'' above) with the correct code shown for the corresponding message area in [[util:SCFG]]->Message Areas. 
  
 **Note:** **Note:**
Line 200: Line 229:
 ║ │Internal Code                   SBL2SMB                           ║ ║ │Internal Code                   SBL2SMB                           ║
 ║ │Start-up Directory                                                ║ ║ │Start-up Directory                                                ║
-║ │Command Line                    ?sbbslist export=syncdata         ║+║ │Command Line                    ?sbbslist export                  ║
 ║ │Enabled                         Yes                               ║ ║ │Enabled                         Yes                               ║
 ║ │Execution Node                  1                                 ║ ║ │Execution Node                  1                                 ║
Line 215: Line 244:
 ╚════════════════════════════════════════════════════════════════════╝ ╚════════════════════════════════════════════════════════════════════╝
 </file> </file>
- 
-**Note:** 
-Take care to match the //internal code// (''syncdata'' above) with the correct code shown for the corresponding message area in [[util:SCFG]]->Message Areas. 
  
 **Note:** **Note:**
 If you have the old ''SBL2SMB'' timed event, you should remove it now. If you have the old ''SBL2SMB'' timed event, you should remove it now.
  
 +==== Command-line ====
 +
 +=== Commands ===
 +Commands are just words passed on the command-line to ''sbbslist.js''. Many commands are only there for trouble-shooting or experimental purposes.
 +
 +^ Command   ^ Description ^
 +| browse    | Perform the interactive BBS-user //door// function for listing and adding systems to the list |
 +| list       | Display all or part of the BBS list |
 +| dump       | Perform a JSON-dump of the BBS list |
 +| count      | Count the number of entries in the BBS list|
 +| upgrade    | Upgrade from the old SBL (''sbl.dab'') list format |
 +| backup     | Backup the BBS list database file (''sbslist.json'') |
 +| import     | Import BBS entries from a networked message base |
 +| export     | Export BBS entries to a networked message base |
 +| syncterm   | Export the BBS List to a SyncTERM compatible list file (''syncterm.lst'') |
 +| html       | Export the BBS List to an HTML file (''sbbslist.html'') |
 +| imsglist   | Export the BBS List to an instant-message system list file (''sbbsimsg.lst'') | 
 +| sort=field | Sort the BBS List by the specified field |
 +| randomize  | Randomize the BBS List |
 +| find=value | Find a string in the BBS List |
 +| verify     | Verify the BBS List |
 +| save       | Save the BBS List back to the database file |
 +| show       | Show, in a basic plain format, the BBS List |
 +| add        | Add the local system to the BBS List |
 +| update         | Update the local system in the BBS List |
 +| delete         | Remove the local system from the BBS List (see also ''-remote'') |
 +| remove=<name>  | Remove an entry from the BBS List (see also ''-remote'') |
 +| preview=<name> | Capture the preview of the specified BBS entry |
 +| dedupe         | Remove duplicate entries from the BBS List |
 +| maint          | Delete old/out-date entries from the BBS List (not yet implemented) |
 +| install        | Install the Synchronet BBS List in a Synchronet BBS |
 +
 +=== Options === 
 +Command-line options begin with a ''-'' and modify the default behavior of ''sbbslist.js''.
 +
 +^ Option   ^ Description ^
 +| -v       | Increase console output verbosity (e.g. for trouble-shooting) |
 +| -quiet   | Minimize console output |
 +| -exclude=<value> | Exclude select entries from the BBS List |
 +| -format=<value> | Specify the default list format (''-format='' for a list of formats) |
 +| -filter=<value> | Filter BBS List based on specified value |
 +| -all            | Import/export all entries (even those locally created) - not normally recommended |
 +| -ptr=<value>    | Over-ride the stored import/export message base pointer value |
 +| -addr=<value>   | Specify the address to capture a BBS preview from |
 +| -preview        | Include a preview with a BBS List ''update'' |
 +| -sort=<value>   | Sort the BBS List based on specified field |
 +| -reverse        | Reverse the natural/default sort order |
 +| -remote         | Remove/delete an entry in remote/networked databases too (use with the ''delete'' or ''remove'' command) |
 +| -debug          | Enable debug console/log output |
 +| -#              | Limit the number of entries listed |
  
 ===== See Also ===== ===== See Also =====

Trace: • Command Lines • New Filebase (introduced in v3.19) • Terminal Server