* doc/guide.tex: Document the Debug Console (EJAB-395)

SVN Revision: 1030

diff --git a/ChangeLog b/ChangeLog
index 78414194a4f653e9770d722d45b377e81ba67732..fb60c8222904102668d821416324d81f21500add 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2007-12-06  Badlop  <badlop@process-one.net>
 
+       * doc/guide.tex: Document the Debug Console (EJAB-395)
+
        * src/ejabberdctl.template: The parameter 'kernel inetrc' is used
        even with -sname to guarantee the same behaviour that when using
        -name (EJAB-317)

diff --git a/doc/guide.tex b/doc/guide.tex
index abc6d26399ef44932a66a2421f9141d91861a2e2..8890d70693e4ba04fb528198b9283371a25b12e4 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3687,7 +3687,7 @@ The syntax is the following:
 \label{debugging}
 \ind{debugging}
 
-\section{Watchdog alerts}
+\section{Watchdog Alerts}
 \label{watchdog}
 \ind{debugging!watchdog}
 
@@ -3702,7 +3702,7 @@ Example configuration:
 \end{verbatim}
 
 
-\section{Log files}
+\section{Log Files}
 \label{logfiles}
 
 ejabberd writes messages in two log files:
@@ -3726,6 +3726,21 @@ For example, the default configuration is:
 {loglevel, 4}.
 \end{verbatim}
 
+
+\section{Debug Console}
+\label{debugconsole}
+
+The Debug Console is an Erlang shell attached to an already running ejabberd server.
+With this Erlang shell, an experienced administrator can perform complex tasks.
+
+This shell gives complete control over the ejabberd server,
+so it is important to use it with extremely care.
+There are some simple and safe examples in the article 
+\footahref{http://www.ejabberd.im/interconnect-erl-nodes}{Interconnecting Erlang Nodes}
+
+To exit the shell, close the window or press the keys: control+c control+c.
+
+
 \appendix{}
 \chapter{Internationalization and Localization}
 \label{i18nl10n}