Comparison

plugins/mod_admin_shell.lua @ 11365:5eb817cdd5cd

mod_admin_shell: Add help section with (top level) MUC commands These were previously only documented on the site.
author Kim Alvefur <zash@zash.se>
date Fri, 05 Feb 2021 15:52:46 +0100
parent 11364:bb6b744f7f1a
child 11478:c0c4431ab27b
comparison
equal deleted inserted replaced
11364:bb6b744f7f1a 11365:5eb817cdd5cd
187 print [[s2s - Commands to manage sessions between this server and others]] 187 print [[s2s - Commands to manage sessions between this server and others]]
188 print [[http - Commands to inspect HTTP services]] -- XXX plural but there is only one so far 188 print [[http - Commands to inspect HTTP services]] -- XXX plural but there is only one so far
189 print [[module - Commands to load/reload/unload modules/plugins]] 189 print [[module - Commands to load/reload/unload modules/plugins]]
190 print [[host - Commands to activate, deactivate and list virtual hosts]] 190 print [[host - Commands to activate, deactivate and list virtual hosts]]
191 print [[user - Commands to create and delete users, and change their passwords]] 191 print [[user - Commands to create and delete users, and change their passwords]]
192 print [[muc - Commands to create, list and manage chat rooms]]
192 print [[server - Uptime, version, shutting down, etc.]] 193 print [[server - Uptime, version, shutting down, etc.]]
193 print [[port - Commands to manage ports the server is listening on]] 194 print [[port - Commands to manage ports the server is listening on]]
194 print [[dns - Commands to manage and inspect the internal DNS resolver]] 195 print [[dns - Commands to manage and inspect the internal DNS resolver]]
195 print [[xmpp - Commands for sending XMPP stanzas]] 196 print [[xmpp - Commands for sending XMPP stanzas]]
196 print [[debug - Commands for debugging the server]] 197 print [[debug - Commands for debugging the server]]
223 elseif section == "user" then 224 elseif section == "user" then
224 print [[user:create(jid, password) - Create the specified user account]] 225 print [[user:create(jid, password) - Create the specified user account]]
225 print [[user:password(jid, password) - Set the password for the specified user account]] 226 print [[user:password(jid, password) - Set the password for the specified user account]]
226 print [[user:delete(jid) - Permanently remove the specified user account]] 227 print [[user:delete(jid) - Permanently remove the specified user account]]
227 print [[user:list(hostname, pattern) - List users on the specified host, optionally filtering with a pattern]] 228 print [[user:list(hostname, pattern) - List users on the specified host, optionally filtering with a pattern]]
229 elseif section == "muc" then
230 -- TODO `muc:room():foo()` commands
231 print [[muc:create(roomjid, { config }) - Create the specified MUC room with the given config]]
232 print [[muc:list(host) - List rooms on the specified MUC component]]
233 print [[muc:room(roomjid) - Create the specified MUC room with the given config]]
228 elseif section == "server" then 234 elseif section == "server" then
229 print [[server:version() - Show the server's version number]] 235 print [[server:version() - Show the server's version number]]
230 print [[server:uptime() - Show how long the server has been running]] 236 print [[server:uptime() - Show how long the server has been running]]
231 print [[server:memory() - Show details about the server's memory usage]] 237 print [[server:memory() - Show details about the server's memory usage]]
232 print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]] 238 print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]