Chapril/xmpp.chapril.org-ejabberd
24
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-06-30 23:02:00 +02:00
Code Releases Activity

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

Browse Source 
* doc/guide.html: Likewise

SVN Revision: 1346
This commit is contained in:
Badlop 2008-06-05 12:04:43 +00:00
parent 59201f1def
commit 95462d3f25
3 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -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> 2008-06-04 Badlop <badlop@process-one.net>
* src/msgs/pl.msg: Bugfix in arguments of translated string that * src/msgs/pl.msg: Bugfix in arguments of translated string that

12
doc/guide.html
View File

@ -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> <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--> <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> <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, 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, it displays the available options. If there isn&#X2019;t an <TT>ejabberd</TT> server running,
the available parameters are: 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 in offline storage. This might be useful when the number of offline messages
is very high. is very high.
</DD></DL><P>The <TT>ejabberdctl</TT> script also allows the argument <TT>--node NODENAME</TT>. </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 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 provides detailed information about each configurable option.</P><!--TOC subsection Erlang runtime system--> 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> <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. <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. This system is configured using environment variables and command line parameters.

14
doc/guide.tex
View File

@ -3603,7 +3603,7 @@ Options:
\subsection{Commands} \subsection{Commands}
\label{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. many other administrative tasks in a local or remote \ejabberd{} server.
When \term{ejabberdctl} is executed without any parameter, When \term{ejabberdctl} is executed without any parameter,
@ -3638,8 +3638,16 @@ The more interesting ones are:
The \term{ejabberdctl} script also allows the argument \term{--node NODENAME}. The \term{ejabberdctl} script also allows the argument \term{--node NODENAME}.
This allows to administer a remote node. This allows to administer a remote node.
The \term{ejabberdctl} administration script can be configured in the file ejabberdctl.cfg. The \term{ejabberdctl} script can be configured in the file \term{ejabberdctl.cfg}.
This file provides detailed information about each configurable option. 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} \subsection{Erlang runtime system}