Synchronet v3.17b-Win32 (install) has been released (Jan-2019).

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 revision Previous revision
module:sbbslist [2019/01/24 17:12]
digital man [Command-line] Added the delete command and the -remote option
module:sbbslist [2019/01/29 02:08] (current)
digital man Added the max_inactivity option, 'active' command, active sort value, SBLMAINT event, etc.
Line 1: Line 1:
-====== ​sbbslist ​======+====== ​Synchronet BBS List ======
  
 The Synchronet BBS List v4 module (''​[[dir:​exec]]/​sbbslist.js''​) provides the following functionality:​ The Synchronet BBS List v4 module (''​[[dir:​exec]]/​sbbslist.js''​) provides the following functionality:​
Line 13: Line 13:
 ===== Dependencies =====  ===== Dependencies ===== 
  
-As of this writing, sbbslist v4 is known to be compatible with Synchronet v3.17, under development.+As of this writing, sbbslist v4 is known to be compatible with Synchronet v3.17.
  
 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. 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.
Line 65: Line 65:
 <​file>​ <​file>​
 [sbbslist] [sbbslist]
-sort         = name +        ​sort = name 
-reverse ​     = false +        reverse = false 
-format ​      ​= 0 +        format = 0 
-add_ars ​     = not guest +        add_ars = not guest 
-beep         ​= true +        beep = true 
-sub          = dove-syncdata +        sub = dove-syncdata 
-live_preview = true +        live_preview = true 
-backup_level = 5 +        backup_level = 5 
-export_freq ​ = 7+        export_freq = 7 
 +        max_inactivity = 180
 </​file>​ </​file>​
  
Line 86: Line 87:
 | backup_level | Over-ride the default number of backup files to maintain (default: ''​5''​) | | 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''​) | | export_freq ​ | Maximum export (to message-base) frequency, in days (default: ''​7''​) |
 +| max_inactivity | Maximum number of days of entry inactivity before auto-deletion via ''​maint''​ command (default: 180) |
 ==== 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 116: Line 118:
 | verified_on ​    | Date that this BBS entry was last verified | | verified_on ​    | Date that this BBS entry was last verified |
 | verify ​         | Special sort order based on auto-verification results | | verify ​         | Special sort order based on auto-verification results |
 +| active ​         | Special sort order based on last-activity (modification or verification) date |
  
 The default sort order is alphabetical for string fields and reversed (descending) for numeric fields. The default sort order is alphabetical for string fields and reversed (descending) for numeric fields.
Line 248: Line 251:
 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.
  
 +=== Maintenance ===
 +This timed event (''​SBLMAINT''​) is also helpful for auto-purging old/​inactive BBS list entries based on the configured ''​max_inactivity''​ duration (default: 180 days).
 +<​file>​
 +╔════════════════════════════════════════════════════════════════════╗
 +║                        SBLMAINT Timed Event                        ║
 +╠════════════════════════════════════════════════════════════════════╣
 +║ │Internal Code                   ​SBLMAINT ​                         ║
 +║ │Start-up Directory ​                                               ║
 +║ │Command Line                    ?sbbslist maint                   ║
 +║ │Enabled ​                        ​Yes ​                              ║
 +║ │Execution Node                  1                                 ║
 +║ │Execution Months ​               Any                               ║
 +║ │Execution Days of Month         ​Any ​                              ║
 +║ │Execution Days of Week          All                               ║
 +║ │Execution Time                  00:00                             ║
 +║ │Requires Exclusive Execution ​   No                                ║
 +║ │Force Users Off-line For Event  No                                ║
 +║ │Native Executable ​              ​No ​                               ║
 +║ │Use Shell to Execute ​           No                                ║
 +║ │Background Execution ​           No                                ║
 +║ │Always Run After Init/​Re-init ​  ​No ​                               ║
 +╚════════════════════════════════════════════════════════════════════╝
 +</​file>​
 ==== Command-line ==== ==== Command-line ====
  
Line 276: Line 302:
 | remove=<​name> ​ | Remove an entry 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 | | preview=<​name>​ | Capture the preview of the specified BBS entry |
-| dedupe ​        | Remove duplicate entries from the BBS List | +| active ​        | Display the last activity date of each entry in the BBS List | 
-| maint          | Delete old/out-date ​entries from the BBS List (not yet implemented) |+| dedupe ​        | Remove duplicate entries from the BBS List (''​-v''​) ​
 +| maint          | Delete old/inactive ​entries from the BBS List (''​-v''​) |
 | install ​       | Install the Synchronet BBS List in a Synchronet BBS | | install ​       | Install the Synchronet BBS List in a Synchronet BBS |
  
Line 285: Line 312:
 ^ Option ​  ^ Description ^ ^ Option ​  ^ Description ^
 | -v       | Increase console output verbosity (e.g. for trouble-shooting) | | -v       | Increase console output verbosity (e.g. for trouble-shooting) |
 +| -f=<​file>​| Specify an alternate JSON database path/​filename ​ (default is ''​[[dir:​data]]/​sbbslist.json''​) |
 | -quiet ​  | Minimize console output | | -quiet ​  | Minimize console output |
 | -exclude=<​value>​ | Exclude select entries from the BBS List | | -exclude=<​value>​ | Exclude select entries from the BBS List |
Line 297: Line 325:
 | -remote ​        | Remove/​delete an entry in remote/​networked databases too (use with the ''​delete''​ or ''​remove''​ command) | | -remote ​        | Remove/​delete an entry in remote/​networked databases too (use with the ''​delete''​ or ''​remove''​ command) |
 | -debug ​         | Enable debug console/log output | | -debug ​         | Enable debug console/log output |
 +| -test           | Perform non-destructive maintenance and de-duplication operations |
 | -#              | Limit the number of entries listed | | -#              | Limit the number of entries listed |
  
 ===== See Also ===== ===== See Also =====
-  * [[:module:|module index]]+  * [[:module:|Modules]] 
 +  * [[:bbs:|BBS Lists]]
  
-{{tag>}}+{{tag>sbbslist}}
  

In Other Languages