Minor fixes in listeners options list

diff --git a/doc/guide.html b/doc/guide.html
index 467b2cfcd8cb4f360d0b4bd1a5cbe43d07f936d4..95976f7076fb2d7265c96573055974875a4b5986 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -677,12 +677,12 @@ Handles c2s connections.<BR>
 <TT>zlib</TT>
 </DD><DT CLASS="dt-description"><B><TT>ejabberd_s2s_in</TT></B></DT><DD CLASS="dd-description">
 Handles incoming s2s connections.<BR>
- Options: <TT>max_stanza_size</TT>
+ Options: <TT>max_stanza_size</TT>, <TT>shaper</TT>
 </DD><DT CLASS="dt-description"><B><TT>ejabberd_service</TT></B></DT><DD CLASS="dd-description">
 Interacts with an <A HREF="http://www.ejabberd.im/tutorials-transports">external component</A>
 (as defined in the Jabber Component Protocol (<A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A>).<BR>
  Options: <TT>access</TT>, <TT>hosts</TT>, <TT>max_fsm_queue</TT>,
-<TT>shaper</TT>, <TT>service_check_from</TT>
+<TT>service_check_from</TT>, <TT>shaper</TT>
 </DD><DT CLASS="dt-description"><B><TT>ejabberd_stun</TT></B></DT><DD CLASS="dd-description">
 Handles STUN Binding requests as defined in
 <A HREF="http://tools.ietf.org/html/rfc5389">RFC 5389</A>.<BR>
@@ -702,13 +702,10 @@ grow to. This should be increased if the server is going to handle
 lots of new incoming connections as they may be dropped if there is
 no space in the queue (and ejabberd was not able to accept them
 immediately). Default value is 5.
+</DD><DT CLASS="dt-description"><B><TT>captcha</TT></B></DT><DD CLASS="dd-description"> 
+Simple web page that allows a user to fill a CAPTCHA challenge (see section <A HREF="#captcha">3.1.8</A>).
 </DD><DT CLASS="dt-description"><B><TT>{certfile, Path}</TT></B></DT><DD CLASS="dd-description"> Full path to a file containing the default SSL certificate.
 To define a certificate file specific for a given domain, use the global option <TT>domain_certfile</TT>.
-</DD><DT CLASS="dt-description"><B><TT>{service_check_from, true|false}</TT></B></DT><DD CLASS="dd-description"> 
-This option can be used with <TT>ejabberd_service</TT> only. It is
-used to disable control on the from field on packets send by an
-external components. The option can be either <TT>true</TT> or
-<TT>false</TT>. The default value is <TT>true</TT> which conforms to <A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A>.
 </DD><DT CLASS="dt-description"><B><TT>{hosts, [Hostname, ...], [HostOption, ...]}</TT></B></DT><DD CLASS="dd-description"> 
 The external Jabber component that connects to this <TT>ejabberd_service</TT>
 can serve one or more hostnames.
@@ -718,8 +715,6 @@ when attempt to connect to ejabberd: <TT>{password, Secret}</TT>.
 Note that you cannot define in a single <TT>ejabberd_service</TT> components of
 different services: add an <TT>ejabberd_service</TT> for each service,
 as seen in an example below.
-</DD><DT CLASS="dt-description"><B><TT>captcha</TT></B></DT><DD CLASS="dd-description"> 
-Simple web page that allows a user to fill a CAPTCHA challenge (see section <A HREF="#captcha">3.1.8</A>).
 </DD><DT CLASS="dt-description"><B><TT>http_bind</TT></B></DT><DD CLASS="dd-description"> 
 This option enables HTTP Binding (<A HREF="http://xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">XEP-0206</A>) support. HTTP Bind
 enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which
@@ -764,7 +759,7 @@ Default value: &#X2019;undefined&#X2019;.
 </DD><DT CLASS="dt-description"><B><TT>{max_stanza_size, Size}</TT></B></DT><DD CLASS="dd-description">
 This option specifies an
 approximate maximum size in bytes of XML stanzas. Approximate,
-because it is calculated with the precision of one block of readed
+because it is calculated with the precision of one block of read
 data. For example <CODE>{max_stanza_size, 65536}</CODE>. The default
 value is <TT>infinity</TT>. Recommended values are 65536 for c2s
 connections and 131072 for s2s connections. s2s max stanza size
@@ -776,10 +771,13 @@ For example, if you want <TT>mod_foo</TT> to serve the URIs that start with <TT>
 and you also want <TT>mod_http_bind</TT> to serve the URIs <TT>/http-bind/</TT>,
 use this option: <TT>{request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]}</TT>
 </DD><DT CLASS="dt-description"><B><TT>{service_check_from, true|false}</TT></B></DT><DD CLASS="dd-description">
-By enabling this option, <TT>ejabberd</TT> allows the component to send packets with any arbitrary domain in the &#X2019;from&#X2019; attribute.
-Note that <A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A> requires that the domain must match the hostname of the component.
-Only enable this option if you are completely sure you need to enable it.
-Default value: false.
+
+This option can be used with <TT>ejabberd_service</TT> only.
+<A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A> requires that the domain must match the hostname of the component.
+If this option is set to <TT>false</TT>, <TT>ejabberd</TT> will allow the component
+to send stanzas with any arbitrary domain in the &#X2019;from&#X2019; attribute.
+Only use this option if you are completely sure about it.
+The default value is <TT>true</TT>, to be compliant with <A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A>.
 </DD><DT CLASS="dt-description"><B><TT>{shaper, none|ShaperName}</TT></B></DT><DD CLASS="dd-description"> This option defines a
 shaper for the port (see section&#XA0;<A HREF="#shapers">3.1.6</A>). The default value
 is <TT>none</TT>.

diff --git a/doc/guide.tex b/doc/guide.tex
index 47d93968d86ac7b9a74a7c27ea0f61e9db6f6b91..fea9d55e639239e1d1f6b04bafcf3b9ce95d615c 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -804,12 +804,12 @@ The available modules, their purpose and the options allowed by each one are:
     \texttt{zlib}
   \titem{\texttt{ejabberd\_s2s\_in}}
     Handles incoming s2s connections.\\
-    Options: \texttt{max\_stanza\_size}
+    Options: \texttt{max\_stanza\_size}, \texttt{shaper}
   \titem{\texttt{ejabberd\_service}}
     Interacts with an \footahref{http://www.ejabberd.im/tutorials-transports}{external component}
     (as defined in the Jabber Component Protocol (\xepref{0114}).\\
     Options: \texttt{access}, \texttt{hosts}, \texttt{max\_fsm\_queue},
-    \texttt{shaper}, \texttt{service\_check\_from}
+    \texttt{service\_check\_from}, \texttt{shaper}
   \titem{\texttt{ejabberd\_stun}}
     Handles STUN Binding requests as defined in
     \footahref{http://tools.ietf.org/html/rfc5389}{RFC 5389}.\\
@@ -833,13 +833,10 @@ This is a detailed description of each option allowed by the listening modules:
     lots of new incoming connections as they may be dropped if there is
     no space in the queue (and ejabberd was not able to accept them
     immediately). Default value is 5.
+  \titem{captcha} \ind{options!http-captcha}
+    Simple web page that allows a user to fill a CAPTCHA challenge (see section \ref{captcha}).
   \titem{\{certfile, Path\}} Full path to a file containing the default SSL certificate.
     To define a certificate file specific for a given domain, use the global option \term{domain\_certfile}.
-  \titem{\{service\_check\_from, true|false\}} \ind{options!service\_check\_from}
-    This option can be used with \term{ejabberd\_service} only. It is
-    used to disable control on the from field on packets send by an
-    external components. The option can be either \term{true} or
-    \term{false}. The default value is \term{true} which conforms to \xepref{0114}.
   \titem{\{hosts, [Hostname, ...], [HostOption, ...]\}} \ind{options!hosts}
     The external Jabber component that connects to this \term{ejabberd\_service}
     can serve one or more hostnames.
@@ -849,8 +846,6 @@ This is a detailed description of each option allowed by the listening modules:
     Note that you cannot define in a single \term{ejabberd\_service} components of
     different services: add an \term{ejabberd\_service} for each service,
     as seen in an example below.
-  \titem{captcha} \ind{options!http-captcha}
-    Simple web page that allows a user to fill a CAPTCHA challenge (see section \ref{captcha}).
   \titem{http\_bind} \ind{options!http\_bind}\ind{protocols!XEP-0206: HTTP Binding}\ind{JWChat}\ind{web-based XMPP client}
     This option enables HTTP Binding (\xepref{0124} and \xepref{0206}) support. HTTP Bind
     enables access via HTTP requests to \ejabberd{} from behind firewalls which
@@ -903,7 +898,7 @@ This is a detailed description of each option allowed by the listening modules:
   \titem{\{max\_stanza\_size, Size\}}
     \ind{options!max\_stanza\_size}This option specifies an
     approximate maximum size in bytes of XML stanzas.  Approximate,
-    because it is calculated with the precision of one block of readed
+    because it is calculated with the precision of one block of read
     data. For example \verb|{max_stanza_size, 65536}|.  The default
     value is \term{infinity}. Recommended values are 65536 for c2s
     connections and 131072 for s2s connections. s2s max stanza size
@@ -915,10 +910,13 @@ This is a detailed description of each option allowed by the listening modules:
     and you also want \term{mod\_http\_bind} to serve the URIs \term{/http-bind/},
     use this option: \term{\{request\_handlers, [\{["a", "b"], mod\_foo\}, \{["http-bind"], mod\_http\_bind\}]\}}
   \titem{\{service\_check\_from, true|false\}}
-    By enabling this option, \ejabberd{} allows the component to send packets with any arbitrary domain in the 'from' attribute.
-    Note that \xepref{0114} requires that the domain must match the hostname of the component.
-    Only enable this option if you are completely sure you need to enable it.
-    Default value: false.
+    \ind{options!service\_check\_from}
+    This option can be used with \term{ejabberd\_service} only.
+    \xepref{0114} requires that the domain must match the hostname of the component.
+    If this option is set to \term{false}, \ejabberd{} will allow the component
+    to send stanzas with any arbitrary domain in the 'from' attribute.
+    Only use this option if you are completely sure about it.
+    The default value is \term{true}, to be compliant with \xepref{0114}.
   \titem{\{shaper, none|ShaperName\}} \ind{options!shaper}This option defines a
     shaper for the port (see section~\ref{shapers}). The default value
     is \term{none}.