Adding map read only docs.
authorJohn Terpstra <jht@samba.org>
Mon, 17 Oct 2005 23:34:05 +0000 (23:34 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:09 +0000 (08:47 -0500)
(This used to be commit 121dc1756071728385e7c3abf0603b7c09d0009e)

docs/smbdotconf/filename/mapreadonly.xml [new file with mode: 0644]

diff --git a/docs/smbdotconf/filename/mapreadonly.xml b/docs/smbdotconf/filename/mapreadonly.xml
new file mode 100644 (file)
index 0000000..b223da1
--- /dev/null
@@ -0,0 +1,40 @@
+<samba:parameter name="map read only"
+                 context="S"
+                                type="enum"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>
+       This controls how the DOS read only attribute should be
+       mapped.
+       </para>
+
+       <para>
+       This parameter can take three different values, which tell <citerefentry><refentrytitle>smbd</refentrytitle>
+       <manvolnum>8</manvolnum></citerefentry> how to display the read only attribute on files, where either
+       <smbconfoption name="store dos attributes"/> is set to <constant>No</constant>, or no extended attribute is
+       present.
+       </para>
+
+    <para>The three settings are :</para>
+
+    <itemizedlist>
+               <listitem><para>
+               <constant>Yes</constant> - The read only DOS attribute is mapped to the inverse of the user
+               write bit in the unix permission mode
+               </para></listitem>
+
+               <listitem><para>
+               <constant>Permissions</constant> - The read only DOS attribute is mapped to the effective permissions of
+               the connecting user, as evaluated by <citerefentry><refentrytitle>smbd</refentrytitle>
+               <manvolnum>8</manvolnum></citerefentry> by reading the unix permissions and POSIX ACL (if present).
+               </para></listitem>
+
+               <listitem><para>
+               <constant>No</constant> - The read only DOS attribute is unaffected by permissions, and can only be set by
+               the <smbconfoption name="store dos attributes"/> method.  This may be useful for exporting mounted CDs.
+               </para></listitem>
+    </itemizedlist>
+
+</description>
+<value type="default">yes</value>
+</samba:parameter>