summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorStephen Gallagher <sgallagh@redhat.com>2012-08-10 10:40:32 -0400
committerJakub Hrozek <jhrozek@redhat.com>2012-08-10 19:12:56 +0200
commit5ef295d1cf410ceaa92c03a7843df8a36409f465 (patch)
treeb6fe4f542d491da8c8b381b6b435762d0e8f6e57 /src
parentfb5abb2a7abf63974d8db444c66f50a2dd74901f (diff)
downloadsssd_unused-5ef295d1cf410ceaa92c03a7843df8a36409f465.zip
sssd_unused-5ef295d1cf410ceaa92c03a7843df8a36409f465.tar.gz
sssd_unused-5ef295d1cf410ceaa92c03a7843df8a36409f465.tar.xz
MAN: Improve description of ldap_*_search_base options
It was ambiguous that these options supported the new multiple search base format, as well as the search filters.
Diffstat (limited to 'src')
-rw-r--r--src/man/include/ldap_search_bases.xml26
-rw-r--r--src/man/include/ldap_search_bases_experimental.xml29
-rw-r--r--src/man/po/po4a.cfg2
-rw-r--r--src/man/sssd-ldap.5.xml102
4 files changed, 63 insertions, 96 deletions
diff --git a/src/man/include/ldap_search_bases.xml b/src/man/include/ldap_search_bases.xml
new file mode 100644
index 0000000..32f8dd4
--- /dev/null
+++ b/src/man/include/ldap_search_bases.xml
@@ -0,0 +1,26 @@
+<listitem>
+ <para>
+ An optional base DN, search scope and LDAP filter
+ to restrict LDAP searches for this attribute type.
+ </para>
+ <para>
+ syntax:
+<programlisting>
+search_base[?scope?[filter][?search_base?scope?[filter]]*]
+</programlisting>
+ </para>
+ <para>
+ The scope can be one of "base", "onelevel" or
+ "subtree". The filter must be a valid LDAP search
+ filter as specified by
+ http://www.ietf.org/rfc/rfc2254.txt
+ </para>
+ <para>
+ For examples of this syntax, please refer to the
+ <quote>ldap_search_base</quote> examples section.
+ </para>
+ <para>
+ Default: the value of
+ <emphasis>ldap_search_base</emphasis>
+ </para>
+</listitem> \ No newline at end of file
diff --git a/src/man/include/ldap_search_bases_experimental.xml b/src/man/include/ldap_search_bases_experimental.xml
new file mode 100644
index 0000000..6ba351c
--- /dev/null
+++ b/src/man/include/ldap_search_bases_experimental.xml
@@ -0,0 +1,29 @@
+<listitem>
+ <para>
+ An optional base DN, search scope and LDAP filter
+ to restrict LDAP searches for this attribute type.
+ </para>
+ <para>
+ syntax:
+<programlisting>
+search_base[?scope?[filter][?search_base?scope?[filter]]*]
+</programlisting>
+ </para>
+ <para>
+ The scope can be one of "base", "onelevel" or
+ "subtree". The filter must be a valid LDAP search
+ filter as specified by
+ http://www.ietf.org/rfc/rfc2254.txt
+ </para>
+ <para>
+ For examples of this syntax, please refer to the
+ <quote>ldap_search_base</quote> examples section.
+ </para>
+ <para>
+ Default: the value of
+ <emphasis>ldap_search_base</emphasis>
+ </para>
+ <para>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="experimental.xml" />
+ </para>
+</listitem> \ No newline at end of file
diff --git a/src/man/po/po4a.cfg b/src/man/po/po4a.cfg
index e20b713..0aa9f61 100644
--- a/src/man/po/po4a.cfg
+++ b/src/man/po/po4a.cfg
@@ -32,3 +32,5 @@
[type:docbook] include/experimental.xml $lang:$(builddir)/$lang/include/experimental.xml opt:"-k 0"
[type:docbook] include/local.xml $lang:$(builddir)/$lang/include/local.xml opt:"-k 0"
[type:docbook] include/seealso.xml $lang:$(builddir)/$lang/include/seealso.xml opt:"-k 0"
+[type:docbook] include/ldap_search_bases.xml $lang:$(builddir)/$lang/include/ldap_search_bases.xml opt:"-k 0"
+[type:docbook] include/ldap_search_bases_experimental.xml $lang:$(builddir)/$lang/include/ldap_search_bases_experimental.xml opt:"-k 0"
diff --git a/src/man/sssd-ldap.5.xml b/src/man/sssd-ldap.5.xml
index 175da34..02ec134 100644
--- a/src/man/sssd-ldap.5.xml
+++ b/src/man/sssd-ldap.5.xml
@@ -1041,21 +1041,7 @@
<varlistentry>
<term>ldap_service_search_base (string)</term>
- <listitem>
- <para>
- An optional base DN to restrict service searches
- to a specific subtree.
- </para>
- <para>
- See <quote>ldap_search_base</quote> for
- information about configuring multiple search
- bases.
- </para>
- <para>
- Default: the value of
- <emphasis>ldap_search_base</emphasis>
- </para>
- </listitem>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_search_bases.xml" />
</varlistentry>
<varlistentry>
@@ -2156,59 +2142,17 @@ ldap_access_filter = memberOf=cn=allowedusers,ou=Groups,dc=example,dc=com
<variablelist>
<varlistentry>
<term>ldap_netgroup_search_base (string)</term>
- <listitem>
- <para>
- An optional base DN to restrict netgroup searches
- to a specific subtree.
- </para>
- <para>
- See <quote>ldap_search_base</quote> for
- information about configuring multiple search
- bases.
- </para>
- <para>
- Default: the value of
- <emphasis>ldap_search_base</emphasis>
- </para>
- </listitem>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_search_bases.xml" />
</varlistentry>
<varlistentry>
<term>ldap_user_search_base (string)</term>
- <listitem>
- <para>
- An optional base DN to restrict user searches
- to a specific subtree.
- </para>
- <para>
- See <quote>ldap_search_base</quote> for
- information about configuring multiple search
- bases.
- </para>
- <para>
- Default: the value of
- <emphasis>ldap_search_base</emphasis>
- </para>
- </listitem>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_search_bases.xml" />
</varlistentry>
<varlistentry>
<term>ldap_group_search_base (string)</term>
- <listitem>
- <para>
- An optional base DN to restrict group searches
- to a specific subtree.
- </para>
- <para>
- See <quote>ldap_search_base</quote> for
- information about configuring multiple search
- bases.
- </para>
- <para>
- Default: the value of
- <emphasis>ldap_search_base</emphasis>
- </para>
- </listitem>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_search_bases.xml" />
</varlistentry>
<varlistentry>
@@ -2257,46 +2201,12 @@ ldap_access_filter = memberOf=cn=allowedusers,ou=Groups,dc=example,dc=com
<varlistentry condition="with_sudo">
<term>ldap_sudo_search_base (string)</term>
- <listitem>
- <para>
- An optional base DN to restrict sudo rules searches
- to a specific subtree.
- </para>
- <para>
- See <quote>ldap_search_base</quote> for
- information about configuring multiple search
- bases.
- </para>
- <para>
- Default: the value of
- <emphasis>ldap_search_base</emphasis>
- </para>
- <para>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/experimental.xml" />
- </para>
- </listitem>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_search_bases_experimental.xml" />
</varlistentry>
<varlistentry condition="with_autofs">
<term>ldap_autofs_search_base (string)</term>
- <listitem>
- <para>
- An optional base DN to restrict automounter searches
- to a specific subtree.
- </para>
- <para>
- See <quote>ldap_search_base</quote> for
- information about configuring multiple search
- bases.
- </para>
- <para>
- Default: the value of
- <emphasis>ldap_search_base</emphasis>
- </para>
- <para>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/experimental.xml" />
- </para>
- </listitem>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_search_bases_experimental.xml" />
</varlistentry>
</variablelist>