From 6924b4c3e855658413adb128f64778d3d851c783 Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 5 Jun 2008 12:04:43 +0000 Subject: [PATCH] * doc/guide.tex: Document ejabberdctl status code (EJAB-633) * doc/guide.html: Likewise SVN Revision: 1346 --- ChangeLog | 5 +++++ doc/guide.html | 12 +++++++++--- doc/guide.tex | 14 +++++++++++--- 3 files changed, 25 insertions(+), 6 deletions(-) diff --git a/ChangeLog b/ChangeLog index 89c122f5e..352526ece 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2008-06-05 Badlop + + * doc/guide.tex: Document ejabberdctl status code (EJAB-633) + * doc/guide.html: Likewise + 2008-06-04 Badlop * src/msgs/pl.msg: Bugfix in arguments of translated string that diff --git a/doc/guide.html b/doc/guide.html index a298e575a..caf9eb31a 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -2869,7 +2869,7 @@ the processing discipline for Software Version (jabber:iq:version) IQ q

4.1  ejabberdctl

4.1.1  Commands

-

The ejabberdctl command line script allows to start, stop and perform +

The ejabberdctl command line administration script allows to start, stop and perform many other administrative tasks in a local or remote ejabberd server.

When ejabberdctl is executed without any parameter, it displays the available options. If there isn’t an ejabberd server running, the available parameters are: @@ -2894,8 +2894,14 @@ exist tutorials to migrate in offline storage. This might be useful when the number of offline messages is very high.

The ejabberdctl script also allows the argument --node NODENAME. -This allows to administer a remote node.

The ejabberdctl administration script can be configured in the file ejabberdctl.cfg. -This file provides detailed information about each configurable option.

+This allows to administer a remote node.

The ejabberdctl script can be configured in the file ejabberdctl.cfg. +This file includes detailed information about each configurable option.

The ejabberdctl script returns a numerical status code. +Success is represented by 0, +error is represented by 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: echo $?

4.1.2  Erlang runtime system

ejabberd 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 c71acc5f3..27925a917 100644 --- 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}