* doc/guide.tex: Described @HOST@ feature (thanks to Badlop)

SVN Revision: 890

2 files changed, 18 insertions, 1 deletions

diff --git a/ChangeLog b/ChangeLog
index df883d303..343b4ce6f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2007-08-28  Alexey Shchepin  <alexey@process-one.net>
+
+	* doc/guide.tex: Described @HOST@ feature (thanks to Badlop)
+
 2007-08-26  Alexey Shchepin  <alexey@process-one.net>
 
 	* doc/guide.tex: Removed mentions of unexistent 'hosts' modules
diff --git a/doc/guide.tex b/doc/guide.tex
index a1cd38437..387b57554 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -92,7 +92,8 @@ the processing discipline for #1 IQ queries (see section~\ref{modiqdiscoption}).
 \newcommand{\hostitem}[1]{
   \titem{host} \ind{options!host} This option defines the Jabber ID of the
   service. If the \texttt{host} option is not specified, the Jabber ID will be the
-  hostname of the virtual host with the prefix `\jid{#1.}'.
+  hostname of the virtual host with the prefix `\jid{#1.}'. The keyword "@HOST@"
+  is replaced at start time with the real virtual host name.
 }
 
 %% Title page
@@ -1701,6 +1702,7 @@ Example:
 \ind{options!host}
 
 This option defines the Jabber ID of a service provided by an ejabberd module.
+The keyword "@HOST@" is replaced at start time with the real virtual host string.
 
 This example configures
 the \ind{modules!\modecho{}}echo module to provide its echoing service 
@@ -1714,6 +1716,17 @@ in the Jabber ID \jid{mirror.example.org}:
    ]}.
 \end{verbatim}
 
+However, if there are several virtual hosts and this module is enabled in all of them,
+the "@HOST@" keyword must be used:
+    \begin{verbatim}
+  {modules,
+   [
+    ...
+    {mod_echo, [{host, "mirror.@HOST@"}]},
+    ...
+   ]}.
+\end{verbatim}
+
 \subsection{\modannounce{}}
 \label{modannounce}
 \ind{modules!\modannounce{}}\ind{MOTD}\ind{message of the day}\ind{announcements}