man prosodyctl: Add information about the 'about' and 'check' commands
authorKim Alvefur <zash@zash.se>
Wed, 23 Dec 2015 13:21:20 +0000 (14:21 +0100)
committerKim Alvefur <zash@zash.se>
Wed, 23 Dec 2015 13:21:20 +0000 (14:21 +0100)
man/prosodyctl.man
man/prosodyctl.markdown

index 8dd9e1f8616b23bd7fe1ca5a57d2026321f228c4..b91502a846ae746c5eeb6a2cf0ce254cb5804759 100644 (file)
@@ -86,6 +86,24 @@ files.
 Prints the current execution status of the prosody server daemon.
 .RS
 .RE
+.SS Debugging
+.PP
+prosodyctl can also show some information about the environment,
+dependencies and such to aid in debugging.
+.TP
+.B about
+Shows environment, various paths used by Prosody and installed
+dependencies.
+.RS
+.RE
+.TP
+.B check [what]
+Performs various sanity checks on the configuration, DNS setup and
+configured TLS certificates.
+\f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and
+\f[C]certs\f[] to run only that check.
+.RS
+.RE
 .SS Ejabberd Compatibility
 .PP
 ejabberd is another XMPP server which provides a comparable control
index 5360503bc35ecb6964935385079d2d1ab8db4110..217dfd3d21242d38879ec2e48e7c4466f370a1c9 100644 (file)
@@ -80,6 +80,21 @@ reload
 status
 :   Prints the current execution status of the prosody server daemon.
 
+Debugging
+---------
+
+prosodyctl can also show some information about the environment,
+dependencies and such to aid in debugging.
+
+about
+:   Shows environment, various paths used by Prosody and
+    installed dependencies.
+
+check \[what\]
+:   Performs various sanity checks on the configuration, DNS setup and
+    configured TLS certificates. `what` can be one of `config`, `dns`
+    and `certs` to run only that check.
+
 Ejabberd Compatibility
 ----------------------