This is an old revision of the document!
Logon List
The Logon List module (exec/logonlist.js) is responsible for displaying and maintaining the list of BBS logons. It uses the logonlist_lib.js library to store/retrieve logon information in JSON Lines (.jsonl) format.
Format
The new data/logon.jsonl file replaces the functionality of the old (but still supported/maintained) data/logon.lst file.
The advantages of the new format include:
- Standard file format
- Easily parseable by scripts/programs (especially JS)
- Supports non-terminal protocol logons (e.g. HTTP/HTTPS)
- No display-style (e.g. colors) embedded in the file
Files
- The current day's logons are stored in
data/logon.jsonl - Yesterday's logons are stored in
data/logon.0.jsonl - The logons from 2-days ago are stored in
data/logon.1.jsonl - etc...
The logon list files are normally maintained/rotated daily via an invocation of “?logonlist -m” (e.g. in SCFG->External Programs->Fixed Events->Daily Event).
Install
To install the Logon List module, execute from a command-line:
jsexec logonlist install
Invoke
The Logon List module supports the following command-line options:
| Option | Description |
|---|---|
-l | Display only the “last few” logons (callers), the default is to display the entire list |
-y | Display logons from yesterday rather than today |
-m | Maintain the Logon List files, must be executed daily, e.g. via “System Daily Event” or Timed Event |
Configure
The Logon List module supports the following options in the [logonlist] section of the ctrl/modopts.ini file:
| Option | Default | Description |
|---|---|---|
last_few_callers | 4 | Number of logons to display when only displaying the “last few” (not the entire list) |
last_few_callers_msg | (see source) | The string to announce the “Last few callers” list |
last_few_callers_fmt | (see source) | The printf-style format string for each displayed Logon List entry/line |
first_caller_msg | (see source) | The string to announce that the current logon is the first of the day |
logons_header_fmt | (see source) | The printf-style format string announcing the logon list |
nobody_logged_on_fmt | (see source) | The printf-style format string stating that nobody has logged-on that day |
backup_level | 10 | Number of previous logon list files to retain |
today | “Today” | The word displayed to represent the current day |
yesterday | “Yesterday | The word to displayed to represent the day before the current day |
