Changeset

7034:27f4d63f136a

man prosodyctl: Add information about the 'about' and 'check' commands
author Kim Alvefur <zash@zash.se>
date Wed, 23 Dec 2015 14:21:20 +0100
parents 7033:719f02848c99
children 7035:085a286e2873
files man/prosodyctl.man man/prosodyctl.markdown
diffstat 2 files changed, 33 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/man/prosodyctl.man	Wed Dec 23 14:20:57 2015 +0100
+++ b/man/prosodyctl.man	Wed Dec 23 14:21:20 2015 +0100
@@ -86,6 +86,24 @@
 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
--- a/man/prosodyctl.markdown	Wed Dec 23 14:20:57 2015 +0100
+++ b/man/prosodyctl.markdown	Wed Dec 23 14:21:20 2015 +0100
@@ -80,6 +80,21 @@
 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
 ----------------------