docs: Document idmap_nss "range" option
authorSamuel Cabrero <scabrero@suse.de>
Mon, 27 Nov 2023 09:20:05 +0000 (10:20 +0100)
committerSamuel Cabrero <scabrero@samba.org>
Wed, 13 Dec 2023 15:07:38 +0000 (15:07 +0000)
Signed-off-by: Samuel Cabrero <scabrero@samba.org>
Reviewed-by: Alexander Bokovoy <ab@samba.org>
docs-xml/manpages/idmap_nss.8.xml

index fc03445df2c0a0e3686a17548a447f99af8fc650..254f38a5f5bc2e0071844dce045ecf77d331ac0f 100644 (file)
        </para>
 </refsynopsisdiv>
 
+<refsect1>
+       <title>IDMAP OPTIONS</title>
+
+       <variablelist>
+               <varlistentry>
+               <term>range = low - high</term>
+               <listitem><para>
+                       Defines the available matching UID and GID range for which the
+                       backend is authoritative. Note that the range acts as a filter.
+                       Returned UIDs or GIDs by NSS modules that fall outside the range
+                       are ignored and the corresponding maps discarded. It is intended
+                       as a way to avoid accidental UID/GID overlaps between local and
+                       remotely defined IDs.
+               </para></listitem>
+               </varlistentry>
+       </variablelist>
+</refsect1>
+
+
 <refsect1>
        <title>EXAMPLES</title>
 
@@ -57,4 +76,4 @@
        </para>
 </refsect1>
 
-</refentry>
+</refentry>
\ No newline at end of file