Both sides previous revisionPrevious revisionNext revision | Previous revision |
module:logonlist [2020/04/04 19:08] – [Format] Added blurb about text.dat not used. digital man | module:logonlist [2024/07/17 13:25] (current) – [Configure] Add time_fmt digital man |
---|
The Logon List module (''[[dir: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. | The Logon List module (''[[dir: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. |
| |
| {{:module:logonlist.png?600|}} |
===== Format ===== | ===== Format ===== |
The new ''[[dir:data]]/logon.jsonl'' file replaces the functionality of the old (but still supported/maintained) ''[[dir:data]]/logon.lst'' file. | The new ''[[dir:data]]/logon.jsonl'' file replaces the functionality of the old (but still supported/maintained) ''[[dir:data]]/logon.lst'' file. |
| |
===== Install ===== | ===== Install ===== |
To install the Logon List module, execute from a command-line: | This module (''logonlist'') should be the default value of SCFG->System->Loadable Modules->List Logons. |
jsexec logonlist install | |
| |
| If a sysop needs to install this module, it can be installed with the command-line ''[[util:jsexec]] logonlist install''. |
===== Invoke ===== | ===== Invoke ===== |
| The default behavior of the Logon List module (when no command-line options are provided) is to display all user logons that have been logged so far today, in the order in which they were logged (normally, by the [[module:logon|Logon Module]]). |
| |
The Logon List module supports the following command-line options: | The Logon List module supports the following command-line options: |
| |
^ Option ^ Description ^ | ^ Option ^ Description ^ |
| ''-l'' | Display only the "last few" logons (callers), the default is to display the entire list | | | ''-l //[count]//'' | Display only the "last few" logons (callers), possibly over multiple days | |
| ''-y'' | Display logons from yesterday rather than today | | | ''-y'' | Display all logons that occurred yesterday | |
| | ''//days//'' | Display all logons from the specified number of days ago | |
| ''-m'' | Maintain the Logon List files, must be executed daily, e.g. via "System Daily Event" or Timed Event | | | ''-m'' | Maintain the Logon List files, must be executed daily, e.g. via "System Daily Event" or Timed Event | |
| |
| ''backup_level'' | 10 | Number of previous logon list files to retain | | | ''backup_level'' | 10 | Number of previous logon list files to retain | |
| ''today'' | "Today" | The word displayed to represent the current day | | | ''today'' | "Today" | The word displayed to represent the current day | |
| ''yesterday'' | "Yesterday | The word to displayed to represent the day before the current day | | | ''yesterday'' | "Yesterday | The word displayed to represent the day before the current day | |
| | ''time_fmt'' | "%H:%M" | The [[https://cplusplus.com/reference/ctime/strftime/|strftime]] format of the logon date/time to be displayed | |
===== See Also ===== | ===== See Also ===== |
* [[:module:|module index]] | * [[:module:|module index]] |