* doc/guide.tex: Describe option Matches in mod_vcard_ldap (thanks

to Evgeniy Khramtsov)(EJAB-530).  Fix typo in the description of
ldap_server option.
* doc/guide.html: Likewise

SVN Revision: 1229

diff --git a/ChangeLog b/ChangeLog
index 7df9dfa5f5f6c9990e2ec8a96c5ecacedc0777d2..49d3091ee0f8f682892b61632f462167f4dc76cf 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2008-03-13  Badlop  <badlop@process-one.net>
 
+       * doc/guide.tex: Describe option Matches in mod_vcard_ldap (thanks
+       to Evgeniy Khramtsov)(EJAB-530).  Fix typo in the description of
+       ldap_server option.
+       * doc/guide.html: Likewise
+
        * src/mod_echo.erl: Small change to avoid a compilation warning of
        unused function
 

diff --git a/doc/guide.html b/doc/guide.html
index 687e18b5f02fe39256771f399571ce9ff9aa254c..5c6dda11c6c1c9a98de0e892c66a9d8d199c3f58 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -557,7 +557,7 @@ you can define the global <TT>modules</TT> option with the common modules,
 and later add specific modules to certain virtual hosts.
 To accomplish that, instead of defining each option in <TT>host_config</TT> with the syntax
 </P><PRE CLASS="verbatim">  {&lt;option-name&gt;, &lt;option-value&gt;}
-</PRE><P>you must use this syntax:
+</PRE><P>use this syntax:
 </P><PRE CLASS="verbatim">  {{add, &lt;option-name&gt;}, &lt;option-value&gt;}
 </PRE><P>In this example three virtual hosts have some similar modules, but there are also
 other different modules for some specific virtual hosts:
@@ -1318,8 +1318,8 @@ yet.</P><!--TOC subsubsection Connection-->
 <H4 CLASS="subsubsection"><!--SEC ANCHOR -->Connection</H4><!--SEC END --><P>
 <A NAME="ldapconnection"></A></P><P>Parameters:
 </P><DL CLASS="description"><DT CLASS="dt-description">
-<B><TT>ldap_server</TT></B></DT><DD CLASS="dd-description"> IP address or dns name of your
-LDAP server. This option is required.
+<B><TT>ldap_servers</TT></B></DT><DD CLASS="dd-description"> List of IP addresses or DNS names of your
+LDAP servers. This option is required.
 </DD><DT CLASS="dt-description"><B><TT>ldap_port</TT></B></DT><DD CLASS="dd-description"> Port to connect to your LDAP server.
 The initial default value is&#XA0;389, so it is used when nothing is set into the 
 configuration file. 
@@ -1621,13 +1621,14 @@ the "@HOST@" keyword must be used:
 <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc36">3.3.3</A>&#XA0;&#XA0;<TT>mod_announce</TT></H3><!--SEC END --><P>
 <A NAME="modannounce"></A>
 </P><P>This module enables configured users to broadcast announcements and to set
-the message of the day (MOTD). </P><P>Configured users can perform these actions with a
+the message of the day (MOTD). 
+Configured users can perform these actions with a
 Jabber client either using Ad-hoc commands
 or sending messages to specific JIDs.</P><P>The Ad-hoc commands are listed in the Server Discovery.
-For this feature to work, <TT>mod_adhoc</TT>must be enabled.</P><P>The specific JIDs where messages can be sent are listed listed now.
+For this feature to work, <TT>mod_adhoc</TT> must be enabled.</P><P>The specific JIDs where messages can be sent are listed bellow.
 The first JID in each entry will apply only to the specified virtual host
 <TT>example.org</TT>, while the JID between brackets will apply to all virtual
-hosts in ejabberd:
+hosts in ejabberd.
 </P><DL CLASS="description"><DT CLASS="dt-description">
 <B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B></DT><DD CLASS="dd-description"> The
 message is sent to all registered users. If the user is online and connected
@@ -2488,6 +2489,7 @@ users who added some information to their vCard. The default value is
 </DD><DT CLASS="dt-description"><B><TT>search_all_hosts</TT></B></DT><DD CLASS="dd-description">If this option is set
 to <TT>true</TT>, search operations will apply to all virtual hosts. Otherwise
 only the current host will be searched. The default value is <TT>true</TT>.
+This option is available in <TT>mod_vcard</TT>, but not available in <TT>mod_vcard_odbc</TT>.
 </DD></DL><P>Examples:
 </P><UL CLASS="itemize"><LI CLASS="li-itemize">
 In this first situation, search results are limited to twenty items,
@@ -2517,14 +2519,14 @@ and that all virtual hosts will be searched instead of only the current one:
 <A NAME="modvcardldap"></A>
 </P><P><TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is
 implemented in the <TT>mod_vcard_ldap</TT> module. This module does not depend on the
-authentication method (see&#XA0;<A HREF="#ldapauth">3.2.5</A>). The <TT>mod_vcard_ldap</TT> module has
+authentication method (see&#XA0;<A HREF="#ldapauth">3.2.5</A>).</P><P>The <TT>mod_vcard_ldap</TT> module has
 its own optional parameters. The first group of parameters has the same
 meaning as the top-level LDAP parameters to set the authentication method:
 <TT>ldap_servers</TT>, <TT>ldap_port</TT>, <TT>ldap_rootdn</TT>,
 <TT>ldap_password</TT>, <TT>ldap_base</TT>, <TT>ldap_uids</TT>, and
 <TT>ldap_filter</TT>. See section&#XA0;<A HREF="#ldapauth">3.2.5</A> for detailed information
 about these options. If one of these options is not set, <TT>ejabberd</TT> will look
-for the top-level option with the same name. The second group of parameters
+for the top-level option with the same name.</P><P>The second group of parameters
 consists of the following <TT>mod_vcard_ldap</TT>-specific options:</P><DL CLASS="description"><DT CLASS="dt-description">
 
 <B><TT>host</TT></B></DT><DD CLASS="dd-description">  This option defines the Jabber ID of the
@@ -2539,6 +2541,9 @@ functionality is enabled (value: <TT>true</TT>) or disabled (value:
 <TT>false</TT>). If disabled, the option <TT>host</TT> will be ignored and the
 Jabber User Directory service will not appear in the Service Discovery item
 list. The default value is <TT>true</TT>.
+</DD><DT CLASS="dt-description"><B><TT>matches</TT></B></DT><DD CLASS="dd-description">With this option, the number of reported
+search results can be limited. If the option&#X2019;s value is set to <TT>infinity</TT>,
+all search results are reported. The default value is <TT>30</TT>.
 </DD><DT CLASS="dt-description"><B><TT>ldap_vcard_map</TT></B></DT><DD CLASS="dd-description">With this option you can
 set the table that maps LDAP attributes to vCard fields. The format is:
 <TT>[</TT><TT>Name_of_vCard_field, Pattern, List_of_LDAP_attributes</TT><TT>, ...]</TT>.

diff --git a/doc/guide.tex b/doc/guide.tex
index 56a2521e0caf6d2ead746664583e32b0183af563..79422d9ba72f339fbc0f269340a50bc3cfd2f457 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -1657,8 +1657,8 @@ yet.
 
 Parameters:
 \begin{description}
-\titem{ldap\_server} \ind{options!ldap\_server}IP address or dns name of your
-LDAP server. This option is required.
+\titem{ldap\_servers} \ind{options!ldap\_server}List of IP addresses or DNS names of your
+LDAP servers. This option is required.
 \titem{ldap\_port} \ind{options!ldap\_port}Port to connect to your LDAP server.
   The initial default value is~389, so it is used when nothing is set into the 
 configuration file. 
@@ -3111,6 +3111,7 @@ Options:
 \titem{search\_all\_hosts}\ind{options!search\_all\_hosts}If this option is set
   to \term{true}, search operations will apply to all virtual hosts. Otherwise
   only the current host will be searched. The default value is \term{true}.
+  This option is available in \modvcard, but not available in \modvcardodbc.
 \end{description}
 
 Examples:
@@ -3151,14 +3152,18 @@ Examples:
 
 \ejabberd{} can map LDAP attributes to vCard fields. This behaviour is
 implemented in the \modvcardldap{} module. This module does not depend on the
-authentication method (see~\ref{ldapauth}). The \modvcardldap{} module has
+authentication method (see~\ref{ldapauth}).
+
+The \modvcardldap{} module has
 its own optional parameters. The first group of parameters has the same
 meaning as the top-level LDAP parameters to set the authentication method:
 \option{ldap\_servers}, \option{ldap\_port}, \option{ldap\_rootdn},
 \option{ldap\_password}, \option{ldap\_base}, \option{ldap\_uids}, and
 \option{ldap\_filter}. See section~\ref{ldapauth} for detailed information
 about these options. If one of these options is not set, \ejabberd{} will look
-for the top-level option with the same name. The second group of parameters
+for the top-level option with the same name.
+
+The second group of parameters
 consists of the following \modvcardldap{}-specific options:
 
 \begin{description}
@@ -3169,6 +3174,9 @@ consists of the following \modvcardldap{}-specific options:
   \term{false}). If disabled, the option \term{host} will be ignored and the
   \Jabber{} User Directory service will not appear in the Service Discovery item
   list. The default value is \term{true}.
+\titem{matches}\ind{options!matches}With this option, the number of reported
+  search results can be limited. If the option's value is set to \term{infinity},
+  all search results are reported. The default value is \term{30}.
 \titem{ldap\_vcard\_map}\ind{options!ldap\_vcard\_map}With this option you can
   set the table that maps LDAP attributes to vCard fields. The format is:
   \term{[{Name\_of\_vCard\_field, Pattern, List\_of\_LDAP\_attributes}, ...]}.\ind{protocols!RFC 2426: vCard MIME Directory Profile}