* doc/guide.tex: Document the option max_s2s_connections

SVN Revision: 1307

diff --git a/ChangeLog b/ChangeLog
index 08f8a60d67c3a69579e74e3b6b3c3fc3973331f3..0f2d54e18bf329703ea1fa39b033d061d67b0ef3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2008-04-28  Badlop  <badlop@process-one.net>
+
+       * doc/guide.tex: Document the option max_s2s_connections
+
 2008-04-28  Christophe Romain <christophe.romain@process-one.net>
 
        * src/mod_pubsub/mod_pubsub.erl: remove unused served_hosts option

diff --git a/doc/guide.tex b/doc/guide.tex
index 2fcffc610f74ab5901ea097e997945c8923c9be7..21922e335691ae0f5a537f9d06cde5f933e3e670 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -1255,6 +1255,30 @@ Examples:
 \end{verbatim}
 \end{itemize}
 
+\subsubsection{Several connections to a remote Jabber server with ACL}
+\label{configmaxs2sconns}
+\ind{options!max\_s2s\_connections}
+
+The special access \term{max\_s2s\_connections} specifies how many
+simultaneus S2S connections can be stablished to a specific remote Jabber server.
+The default value is \term{1}.
+There's also available the access \term{max\_s2s\_connections\_per\_node}.
+
+The syntax is:
+\begin{verbatim}
+  {access, max_s2s_connections, [{<maxnumber>, <aclname>},
+                                 ...
+                                ]}.
+\end{verbatim}
+
+Examples:
+\begin{itemize}
+\item Allow up to 3 connections with each remote server:
+\begin{verbatim}
+  {access, max_s2s_connections, [{3, all}]}.
+\end{verbatim}
+\end{itemize}
+
 \subsection{Shapers}
 \label{shapers}
 \ind{options!shaper}\ind{options!maxrate}\ind{shapers}\ind{maxrate}\ind{traffic speed}