From 9a660829986e1c78c6efb20f394bd2828a23d4c4 Mon Sep 17 00:00:00 2001
From: Badlop
Date: Sun, 12 Oct 2008 13:32:36 +0000
Subject: [PATCH] * doc/guide.tex: Explain the new ejabberdctl command 'help' *
doc/guide.html: Likewise
SVN Revision: 1641
---
ChangeLog | 3 +++
doc/guide.html | 7 ++++---
doc/guide.tex | 5 +++--
3 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index f2574e668..5cd2ada86 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
2008-10-12 Badlop
+ * doc/guide.tex: Explain the new ejabberdctl command 'help'
+ * doc/guide.html: Likewise
+
* src/mod_configure.erl: Update calls from ctl to
commands (EJAB-694)
* src/web/ejabberd_web_admin.erl: Likewise
diff --git a/doc/guide.html b/doc/guide.html
index 320d0db62..c28115c21 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -413,8 +413,8 @@ you can execute ejabberdctl with either that system account or root.
ejabberdctl start
ejabberdctl status
-Node ejabberd@localhost is started. Status: started
-ejabberd is running
+The node ejabberd@localhost is started with status: started
+ejabberd is running in that node
ejabberdctl stop
If ejabberd doesn’t start correctly and a crash dump is generated,
@@ -2894,7 +2894,8 @@ the available parameters are:
ejabberdctl shows all the available commands in that server.
The more interesting ones are:
-
-status
- Check the status of the ejabberd server.
+help
- Get help about ejabberdctl or any available command. Try ejabberdctl help help.
+
- status
- Check the status of the ejabberd server.
- stop
- Stop the ejabberd server which is running in the machine.
- reopen-log
- If you use a tool to rotate logs, you have to configure it
so that this command is executed after each rotation.
diff --git a/doc/guide.tex b/doc/guide.tex
index 6c62769ae..14cc4c627 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -425,8 +425,8 @@ Usage example:
ejabberdctl start
ejabberdctl status
-Node ejabberd@localhost is started. Status: started
-ejabberd is running
+The node ejabberd@localhost is started with status: started
+ejabberd is running in that node
ejabberdctl stop
\end{verbatim}
@@ -3712,6 +3712,7 @@ If there is an \ejabberd{} server running in the system,
\term{ejabberdctl} shows all the available commands in that server.
The more interesting ones are:
\begin{description}
+\titem{help} Get help about ejabberdctl or any available command. Try \term{ejabberdctl help help}.
\titem{status} Check the status of the \ejabberd{} server.
\titem{stop} Stop the \ejabberd{} server which is running in the machine.
\titem{reopen-log} If you use a tool to rotate logs, you have to configure it