From: Kim Alvefur <zash@zash.se>
Date: Wed, 23 Dec 2015 13:21:20 +0000 (+0100)
Subject: man prosodyctl: Add information about the 'about' and 'check' commands
X-Git-Url: https://git.enpas.org/?a=commitdiff_plain;h=e4ce2b5f654470caaffffbe1451b22bacfc71eb5;p=prosody.git

man prosodyctl: Add information about the 'about' and 'check' commands
---

diff --git a/man/prosodyctl.man b/man/prosodyctl.man
index 8dd9e1f8..b91502a8 100644
--- a/man/prosodyctl.man
+++ b/man/prosodyctl.man
@@ -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
diff --git a/man/prosodyctl.markdown b/man/prosodyctl.markdown
index 5360503b..217dfd3d 100644
--- a/man/prosodyctl.markdown
+++ b/man/prosodyctl.markdown
@@ -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
 ----------------------