aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKim Alvefur <zash@zash.se>2015-12-23 14:21:20 +0100
committerKim Alvefur <zash@zash.se>2015-12-23 14:21:20 +0100
commit158857c85e16a316681b9b963e5b13729f891139 (patch)
tree4bbe71c6b9956884ed718d5e151abd59f42f8867
parentf61356b220980f27c3cf95a995cb11e52c4b78fc (diff)
downloadprosody-158857c85e16a316681b9b963e5b13729f891139.tar.gz
prosody-158857c85e16a316681b9b963e5b13729f891139.zip
man prosodyctl: Add information about the 'about' and 'check' commands
-rw-r--r--man/prosodyctl.man18
-rw-r--r--man/prosodyctl.markdown15
2 files changed, 33 insertions, 0 deletions
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
----------------------