* doc/guide.tex: Document how to get error message when ejabberd

crash dumps at start (EJAB-660)
* doc/guide.html: Likewise

SVN Revision: 1494

diff --git a/ChangeLog b/ChangeLog
index cc7853cd6158a3960d37388380be6b66f0111c74..d131e2781b442f0f4e920c14dfc14bd17b4db31b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2008-07-28  Badlop  <badlop@process-one.net>
 
+       * doc/guide.tex: Document how to get error message when ejabberd
+       crash dumps at start (EJAB-660)
+       * doc/guide.html: Likewise
+
        * src/mod_muc/mod_muc_room.erl: Add 'description' to the
        mod_muc_room config record; it will be used in ejabberd 2.1.x
        branch (EJAB-670)

diff --git a/doc/guide.html b/doc/guide.html
index 735efca6428fd14b75d914f6226471658e9e3242..41fba1cb26c710b6a46fd1db1a875c892ee9f4a6 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -290,7 +290,13 @@ go to the Windows service settings and set ejabberd to be automatically started.
 Note that the Windows service is a feature still in development, 
 and for example it doesn&#X2019;t read the file ejabberdctl.cfg.</P><P>On a *nix system, if you want ejabberd to be started as daemon at boot time, 
 copy <TT>ejabberd.init</TT> from the &#X2019;bin&#X2019; directory to something like <TT>/etc/init.d/ejabberd</TT>
-(depending on your distribution) and call <TT>/etc/inid.d/ejabberd start</TT> to start it.</P><P>The <TT>ejabberdctl</TT> administration script is included in the <TT>bin</TT> directory.
+(depending on your distribution) and call <TT>/etc/inid.d/ejabberd start</TT> to start it.</P><P>If <TT>ejabberd</TT> doesn&#X2019;t start correctly and a crash dump is generated,
+there was a severe problem.
+You can try starting <TT>ejabberd</TT> with
+the script <TT>bin/live.bat</TT> in Windows,
+or with the command <TT>bin/ejabberdctl live</TT> in other Operating Systems.
+This way you see the error message provided by Erlang
+and can identify what is exactly the problem.</P><P>The <TT>ejabberdctl</TT> administration script is included in the <TT>bin</TT> directory.
 Please refer to the section&#XA0;<A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>,
 and configurable options to fine tune the Erlang runtime system.</P><P> <A NAME="install.os"></A> </P><!--TOC section Installing <TT>ejabberd</TT> with Operating System specific packages-->
 <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6">2.2</A>&#XA0;&#XA0;<A HREF="#install.os">Installing <TT>ejabberd</TT> with Operating System specific packages</A></H2><!--SEC END --><P> <A NAME="install.os"></A> </P><P>Some Operating Systems provide a specific <TT>ejabberd</TT> package adapted to 
@@ -388,7 +394,12 @@ Node ejabberd@localhost is started. Status: started
 ejabberd is running
 
 ejabberdctl stop
-</PRE><P>Please refer to the section&#XA0;<A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>,
+</PRE><P>If <TT>ejabberd</TT> doesn&#X2019;t start correctly and a crash dump is generated,
+there was a severe problem.
+You can try starting <TT>ejabberd</TT> with
+the command <TT>ejabberdctl live</TT>
+to see the error message provided by Erlang
+and can identify what is exactly the problem.</P><P>Please refer to the section&#XA0;<A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>,
 and configurable options to fine tune the Erlang runtime system.</P><P> <A NAME="bsd"></A> </P><!--TOC subsection Specific Notes for BSD-->
 <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc14">2.4.6</A>&#XA0;&#XA0;<A HREF="#bsd">Specific Notes for BSD</A></H3><!--SEC END --><P> <A NAME="bsd"></A> 
 </P><P>The command to compile <TT>ejabberd</TT> in BSD systems is:

diff --git a/doc/guide.tex b/doc/guide.tex
index e1b00877a2b2897ad8a13e478a2744b719f11424..cee425020c90640ebfdc879d2e4c1ac6aae6f525 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -241,6 +241,14 @@ On a *nix system, if you want ejabberd to be started as daemon at boot time,
 copy \term{ejabberd.init} from the 'bin' directory to something like \term{/etc/init.d/ejabberd}
 (depending on your distribution) and call \term{/etc/inid.d/ejabberd start} to start it.
 
+If \term{ejabberd} doesn't start correctly and a crash dump is generated,
+there was a severe problem.
+You can try starting \term{ejabberd} with
+the script \term{bin/live.bat} in Windows,
+or with the command \term{bin/ejabberdctl live} in other Operating Systems.
+This way you see the error message provided by Erlang
+and can identify what is exactly the problem.
+
 The \term{ejabberdctl} administration script is included in the \term{bin} directory.
 Please refer to the section~\ref{ejabberdctl} for details about \term{ejabberdctl},
 and configurable options to fine tune the Erlang runtime system.
@@ -396,6 +404,13 @@ ejabberd is running
 ejabberdctl stop
 \end{verbatim}
 
+If \term{ejabberd} doesn't start correctly and a crash dump is generated,
+there was a severe problem.
+You can try starting \term{ejabberd} with
+the command \term{ejabberdctl live}
+to see the error message provided by Erlang
+and can identify what is exactly the problem.
+
 Please refer to the section~\ref{ejabberdctl} for details about \term{ejabberdctl},
 and configurable options to fine tune the Erlang runtime system.