s3:docs: add documentation for new "idmap read only" parameter
authorMichael Adam <obnox@samba.org>
Fri, 30 Jul 2010 13:15:47 +0000 (15:15 +0200)
committerMichael Adam <obnox@samba.org>
Sat, 14 Aug 2010 00:10:40 +0000 (02:10 +0200)
docs-xml/smbdotconf/winbind/idmapreadonly.xml [new file with mode: 0644]

diff --git a/docs-xml/smbdotconf/winbind/idmapreadonly.xml b/docs-xml/smbdotconf/winbind/idmapreadonly.xml
new file mode 100644 (file)
index 0000000..9767ff0
--- /dev/null
@@ -0,0 +1,21 @@
+<samba:parameter name="idmap read only"
+       context="G"
+       type="string"
+                advanced="1" developer="0"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+
+       <para>
+       Setting this parameter to <value type="example">yes</value> allows
+       the default idmap back-end to be switched to a read only mode, which
+       means that it can not allocate new user or group IDs to create new
+       mappings. Normally, the default idmap back-end is a so called allocating
+       back-end that creates user and group ids and new mappings as needed.
+
+       Whether a back-end honors the read only setting is left to the
+       implementation of the back-end.
+       </para>
+       
+</description>
+<value type="default">no</value>
+</samba:parameter>