Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
module:logonlist [2019/10/30 12:25] – created digital manmodule:logonlist [2022/03/09 09:10] (current) – [Configure] typo digital man
Line 3: Line 3:
 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.
Line 8: Line 9:
 The advantages of the new format include: The advantages of the new format include:
   - Standard file format   - Standard file format
-  - Easily parseable by scripts/programs (especially JS) +  - Easily parse-able by scripts/programs (especially JS) 
-  - Supports non-terminal protocol logons+  - Supports non-terminal protocol logons (e.g. HTTP/HTTPS)
   - No display-style (e.g. colors) embedded in the file   - No display-style (e.g. colors) embedded in the file
  
 +**Note:**\\
 +While the ''LastFewCallersFmt'' line in the ''[[dir:ctrl]]/[[custom:text.dat]]'' file is still used to generate the legacy ''logon.lst'' file, the ''modopts.ini'' file is used to customize the format/color used to display the new ''logon.jsonl'' file by ''logonlist.js''. See below for details.
 ===== Files ===== ===== Files =====
   * The current day's logons are stored in ''[[dir:data]]/logon.jsonl''   * The current day's logons are stored in ''[[dir:data]]/logon.jsonl''
Line 18: Line 21:
   * etc...   * etc...
  
-===== Install =====  +The logon list files are normally maintained/rotated daily via an invocation of "?logonlist -m" (e.g. in [[util:SCFG]]->External Programs->Fixed Events->Daily Event).
-To install the Logon List module, execute from a command-line: +
-  jsexec logonlist install+
  
 +===== Install ===== 
 +This module (''logonlist'') should be the default value of SCFG->System->Loadable Modules->List Logons.
 ===== Invoke ===== ===== Invoke =====
 The Logon List module supports the following command-line options: The Logon List module supports the following command-line options:
Line 28: Line 31:
 | ''-l'' | Display only the "last few" logons (callers), the default is to display the entire list | | ''-l'' | Display only the "last few" logons (callers), the default is to display the entire list |
 | ''-y'' | Display logons from yesterday rather than today | | ''-y'' | Display logons from yesterday rather than today |
-| ''-m'' | Maintain the Logon List files, must be executed daily, e.g. via "System Timed Event" |+| ''-m'' | Maintain the Logon List files, must be executed daily, e.g. via "System Daily Event" or Timed Event |
  
 ===== Configure ===== ===== Configure =====
Line 43: Line 46:
 | ''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 |
  
 ===== See Also ===== ===== See Also =====
module/logonlist.1572463559.txt · Last modified: 2019/10/30 12:25 by digital man
Back to top
CC Attribution 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0