Software / code / prosody
Changeset
12224:2b348d65cd69
mod_admin_shell: Add help section about customizing table columns
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Jan 2022 20:39:13 +0100 |
| parents | 12223:a68f1617721b |
| children | 12225:e9f34a04067e |
| files | plugins/mod_admin_shell.lua |
| diffstat | 1 files changed, 17 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/plugins/mod_admin_shell.lua Fri Jan 28 14:19:05 2022 +0100 +++ b/plugins/mod_admin_shell.lua Fri Jan 28 20:39:13 2022 +0100 @@ -203,6 +203,8 @@ -- Console commands -- -- These are simple commands, not valid standalone in Lua +local available_columns; --forward declaration so it is reachable from the help + function commands.help(session, data) local print = session.print; local section = data:match("^help (%w+)"); @@ -224,6 +226,7 @@ print [[xmpp - Commands for sending XMPP stanzas]] print [[debug - Commands for debugging the server]] print [[config - Reloading the configuration, etc.]] + print [[columns - Information about customizing session listings]] print [[console - Help regarding the console itself]] elseif section == "c2s" then print [[c2s:show(jid, columns) - Show all client sessions with the specified JID (or all if no JID given)]] @@ -309,6 +312,19 @@ print [[For those well-versed in Prosody's internals, or taking instruction from those who are,]] print [[you can prefix a command with > to escape the console sandbox, and access everything in]] print [[the running server. Great fun, but be careful not to break anything :)]] + elseif section == "columns" then + print [[The columns shown by c2s:show() and s2s:show() can be customizied via the]] + print [['columns' argument as described here.]] + print [[]] + print [[Columns can be specified either as "id jid ipv" or as {"id", "jid", "ipv"}.]] + print [[Available columns are:]] + for column, spec in iterators.sorted_pairs(available_columns) do + print("- "..column..": "..(spec.title or capitalize(column))); + -- TODO descriptions + end + print [[]] + print [[Most fields on the internal session structures can also be used as columns]] + -- Also, you can pass a table column specification directly, with mapper callabck and all end end @@ -681,7 +697,7 @@ end end -local available_columns = { +available_columns = { jid = { title = "JID"; width = 32;
