Changeset

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 (2022-05-30)
parents 12535:7ef7abb72cdd
children 12537:74418f8096b0
files plugins/mod_admin_shell.lua
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/plugins/mod_admin_shell.lua	Mon May 30 17:37:25 2022 +0200
+++ b/plugins/mod_admin_shell.lua	Mon May 30 14:54:10 2022 +0200
@@ -240,6 +240,7 @@
 		print(row { "dns"; "Commands to manage and inspect the internal DNS resolver" })
 		print(row { "xmpp"; "Commands for sending XMPP stanzas" })
 		print(row { "debug"; "Commands for debugging the server" })
+		print(row { "watch"; "Commands for watching live logs from the server" })
 		print(row { "config"; "Reloading the configuration, etc." })
 		print(row { "columns"; "Information about customizing session listings" })
 		print(row { "console"; "Help regarding the console itself" })
@@ -316,6 +317,9 @@
 		print [[debug:logevents(host) - Enable logging of fired events on host]]
 		print [[debug:events(host, event) - Show registered event handlers]]
 		print [[debug:timers() - Show information about scheduled timers]]
+	elseif section == "watch" then
+		print [[watch:log() - Follow debug logs]]
+		print [[watch:stanzas(target, filter) - Watch live stanzas matching the specified target and filter]]
 	elseif section == "console" then
 		print [[Hey! Welcome to Prosody's admin console.]]
 		print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]