aboutsummaryrefslogtreecommitdiffstats
path: root/plugins
diff options
context:
space:
mode:
authorKim Alvefur <zash@zash.se>2022-01-28 20:39:13 +0100
committerKim Alvefur <zash@zash.se>2022-01-28 20:39:13 +0100
commit09d7e131d07c75aac4b1d9f66ad3708aed3d3e21 (patch)
tree3666829e96462e91c1e1b45bcb8aacb7b85aebae /plugins
parentc4e87ac9fbda30e062fbb8cdfc4779297fe71746 (diff)
downloadprosody-09d7e131d07c75aac4b1d9f66ad3708aed3d3e21.tar.gz
prosody-09d7e131d07c75aac4b1d9f66ad3708aed3d3e21.zip
mod_admin_shell: Add help section about customizing table columns
Diffstat (limited to 'plugins')
-rw-r--r--plugins/mod_admin_shell.lua18
1 files changed, 17 insertions, 1 deletions
diff --git a/plugins/mod_admin_shell.lua b/plugins/mod_admin_shell.lua
index 088f0bfa..1d57539c 100644
--- a/plugins/mod_admin_shell.lua
+++ b/plugins/mod_admin_shell.lua
@@ -203,6 +203,8 @@ end);
-- 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 @@ function commands.help(session, data)
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 @@ function commands.help(session, data)
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 @@ local function get_s2s_hosts(session) --> local,remote
end
end
-local available_columns = {
+available_columns = {
jid = {
title = "JID";
width = 32;