prosody
a8cb1d7a98db
plugins/mod_admin_shell.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Comparison

plugins/mod_admin_shell.lua @ 12536:a8cb1d7a98db

mod_admin_shell: Document the 'watch' section in the built-in help
author Kim Alvefur <zash@zash.se>
date Mon, 30 May 2022 14:54:10 +0200
parent 12529:7dae6d29b71d
child 12537:74418f8096b0
comparison
equal deleted inserted replaced
12535:7ef7abb72cdd 12536:a8cb1d7a98db
238 print(row { "server"; "Uptime, version, shutting down, etc." }) 238 print(row { "server"; "Uptime, version, shutting down, etc." })
239 print(row { "port"; "Commands to manage ports the server is listening on" }) 239 print(row { "port"; "Commands to manage ports the server is listening on" })
240 print(row { "dns"; "Commands to manage and inspect the internal DNS resolver" }) 240 print(row { "dns"; "Commands to manage and inspect the internal DNS resolver" })
241 print(row { "xmpp"; "Commands for sending XMPP stanzas" }) 241 print(row { "xmpp"; "Commands for sending XMPP stanzas" })
242 print(row { "debug"; "Commands for debugging the server" }) 242 print(row { "debug"; "Commands for debugging the server" })
243 print(row { "watch"; "Commands for watching live logs from the server" })
243 print(row { "config"; "Reloading the configuration, etc." }) 244 print(row { "config"; "Reloading the configuration, etc." })
244 print(row { "columns"; "Information about customizing session listings" }) 245 print(row { "columns"; "Information about customizing session listings" })
245 print(row { "console"; "Help regarding the console itself" }) 246 print(row { "console"; "Help regarding the console itself" })
246 elseif section == "c2s" then 247 elseif section == "c2s" then
247 print [[c2s:show(jid, columns) - Show all client sessions with the specified JID (or all if no JID given)]] 248 print [[c2s:show(jid, columns) - Show all client sessions with the specified JID (or all if no JID given)]]
314 print [[stats:show():histogram() - Show a histogram of selected metric]] 315 print [[stats:show():histogram() - Show a histogram of selected metric]]
315 elseif section == "debug" then 316 elseif section == "debug" then
316 print [[debug:logevents(host) - Enable logging of fired events on host]] 317 print [[debug:logevents(host) - Enable logging of fired events on host]]
317 print [[debug:events(host, event) - Show registered event handlers]] 318 print [[debug:events(host, event) - Show registered event handlers]]
318 print [[debug:timers() - Show information about scheduled timers]] 319 print [[debug:timers() - Show information about scheduled timers]]
320 elseif section == "watch" then
321 print [[watch:log() - Follow debug logs]]
322 print [[watch:stanzas(target, filter) - Watch live stanzas matching the specified target and filter]]
319 elseif section == "console" then 323 elseif section == "console" then
320 print [[Hey! Welcome to Prosody's admin console.]] 324 print [[Hey! Welcome to Prosody's admin console.]]
321 print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]] 325 print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]
322 print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]] 326 print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]]
323 print [[so you may have trouble using the arrow keys, etc. depending on your system.]] 327 print [[so you may have trouble using the arrow keys, etc. depending on your system.]]