* doc/guide.tex: Explain the new ejabberdctl command 'help'

* doc/guide.html: Likewise

SVN Revision: 1641

diff --git a/ChangeLog b/ChangeLog
index f2574e668e6ebeb82a32ce4a3989a809b496c858..5cd2ada86a927238af2094004a57fd0eb9bb01f7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2008-10-12  Badlop  <badlop@process-one.net>
 
+       * 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 320d0db6278a5f3a4daf3c4bcaf8cf4d82663af9..c28115c21cf117bfe6b6f9d1fb99c9479972ca8a 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -413,8 +413,8 @@ you can execute <TT>ejabberdctl</TT> with either that system account or root.</P
 </P><PRE CLASS="verbatim">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
 </PRE><P>If <TT>ejabberd</TT> doesn&#X2019;t start correctly and a crash dump is generated,
@@ -2894,7 +2894,8 @@ the available parameters are:
 <TT>ejabberdctl</TT> shows all the available commands in that server.
 The more interesting ones are:
 </P><DL CLASS="description"><DT CLASS="dt-description">
-<B><TT>status</TT></B></DT><DD CLASS="dd-description"> Check the status of the <TT>ejabberd</TT> server.
+<B><TT>help</TT></B></DT><DD CLASS="dd-description"> Get help about ejabberdctl or any available command. Try <TT>ejabberdctl help help</TT>.
+</DD><DT CLASS="dt-description"><B><TT>status</TT></B></DT><DD CLASS="dd-description"> Check the status of the <TT>ejabberd</TT> server.
 </DD><DT CLASS="dt-description"><B><TT>stop</TT></B></DT><DD CLASS="dd-description"> Stop the <TT>ejabberd</TT> server which is running in the machine.
 </DD><DT CLASS="dt-description"><B><TT>reopen-log</TT></B></DT><DD CLASS="dd-description"> 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 6c62769ae8ab5e0b6d1742cfc6f335aefde64f29..14cc4c6271cf42ec11422389693298068e8969e8 100644 (file)
--- 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