* doc/guide.tex: Document ejabberdctl status code (EJAB-633)

* doc/guide.html: Likewise

SVN Revision: 1346

diff --git a/ChangeLog b/ChangeLog
index 89c122f5e40e47f7acd2cc896519e6e12207d7c9..352526ececcc2b1ca2aaf643fca0fbd1f8c26475 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-06-05  Badlop  <badlop@process-one.net>
+
+       * doc/guide.tex: Document ejabberdctl status code (EJAB-633)
+       * doc/guide.html: Likewise
+
 2008-06-04  Badlop  <badlop@process-one.net>
 
        * src/msgs/pl.msg: Bugfix in arguments of translated string that

diff --git a/doc/guide.html b/doc/guide.html
index a298e575ab7e6feea326820fa8a1786d1ed6a0d1..caf9eb31a939223b758c70986077f60b41a69e5d 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -2869,7 +2869,7 @@ the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ q
 <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc60">4.1</A>&#XA0;&#XA0;<TT>ejabberdctl</TT></H2><!--SEC END --><P>
 <A NAME="ejabberdctl"></A></P><!--TOC subsection Commands-->
 <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc61">4.1.1</A>&#XA0;&#XA0;Commands</H3><!--SEC END --><P>
-<A NAME="commands"></A></P><P>The <TT>ejabberdctl</TT> command line script allows to start, stop and perform 
+<A NAME="commands"></A></P><P>The <TT>ejabberdctl</TT> command line administration script allows to start, stop and perform 
 many other administrative tasks in a local or remote <TT>ejabberd</TT> server.</P><P>When <TT>ejabberdctl</TT> is executed without any parameter,
 it displays the available options. If there isn&#X2019;t an <TT>ejabberd</TT> server running, 
 the available parameters are:
@@ -2894,8 +2894,14 @@ exist tutorials to <A HREF="http://www.ejabberd.im/migrate-to-ejabberd">migrate
 in offline storage. This might be useful when the number of offline messages
 is very high.
 </DD></DL><P>The <TT>ejabberdctl</TT> script also allows the argument <TT>--node NODENAME</TT>.
-This allows to administer a remote node.</P><P>The <TT>ejabberdctl</TT> administration script can be configured in the file ejabberdctl.cfg.
-This file provides detailed information about each configurable option.</P><!--TOC subsection Erlang runtime system-->
+This allows to administer a remote node.</P><P>The <TT>ejabberdctl</TT> script can be configured in the file <TT>ejabberdctl.cfg</TT>.
+This file includes detailed information about each configurable option.</P><P>The <TT>ejabberdctl</TT> script returns a numerical status code.
+Success is represented by <TT>0</TT>,
+error is represented by <TT>1</TT>,
+and other codes may be used for specifical results.
+This can be used by other scripts to determine automatically
+if a command succedded or failed,
+for example using: <TT>echo $?</TT></P><!--TOC subsection Erlang runtime system-->
 <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc62">4.1.2</A>&#XA0;&#XA0;Erlang runtime system</H3><!--SEC END --><P>
 <A NAME="erlangconfiguration"></A></P><P><TT>ejabberd</TT> is an Erlang/OTP application that runs inside an Erlang runtime system.
 This system is configured using environment variables and command line parameters.

diff --git a/doc/guide.tex b/doc/guide.tex
index c71acc5f36b1c33c6de4a44ac6c437e9ba4d0736..27925a917f6fb748eb39900fe4a64a7ab59ca688 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3450,7 +3450,7 @@ Options:
 \subsection{Commands}
 \label{commands}
 
-The \term{ejabberdctl} command line script allows to start, stop and perform 
+The \term{ejabberdctl} command line administration script allows to start, stop and perform 
 many other administrative tasks in a local or remote \ejabberd{} server.
 
 When \term{ejabberdctl} is executed without any parameter,
@@ -3485,8 +3485,16 @@ The more interesting ones are:
 The \term{ejabberdctl} script also allows the argument \term{--node NODENAME}.
 This allows to administer a remote node.
 
-The \term{ejabberdctl} administration script can be configured in the file ejabberdctl.cfg.
-This file provides detailed information about each configurable option.
+The \term{ejabberdctl} script can be configured in the file \term{ejabberdctl.cfg}.
+This file includes detailed information about each configurable option.
+
+The \term{ejabberdctl} script returns a numerical status code.
+Success is represented by \term{0},
+error is represented by \term{1},
+and other codes may be used for specifical results.
+This can be used by other scripts to determine automatically
+if a command succedded or failed,
+for example using: \term{echo \$?}
 
 
 \subsection{Erlang runtime system}