Merge Samba3 and Samba4 together
[amitay/samba.git] / docs-xml / smbdotconf / filename / mapreadonly.xml
1 <samba:parameter name="map read only"
2                  context="S"
3                  type="enum"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>
7         This controls how the DOS read only attribute should be mapped from a UNIX filesystem.
8         </para>
9
10         <para>
11         This parameter can take three different values, which tell <citerefentry><refentrytitle>smbd</refentrytitle>
12         <manvolnum>8</manvolnum></citerefentry> how to display the read only attribute on files, where either
13         <smbconfoption name="store dos attributes"/> is set to <constant>No</constant>, or no extended attribute is
14         present. If <smbconfoption name="store dos attributes"/> is set to <constant>yes</constant> then this
15         parameter is <emphasis>ignored</emphasis>. This is a new parameter introduced in Samba version 3.0.21.
16         </para>
17
18     <para>The three settings are :</para>
19
20     <itemizedlist>
21                 <listitem><para>
22                 <constant>Yes</constant> - The read only DOS attribute is mapped to the inverse of the user
23                 or owner write bit in the unix permission mode set. If the owner write bit is not set, the
24                 read only attribute is reported as being set on the file.
25                 If the read only DOS attribute is set, Samba sets the owner, group and
26                 others write bits to zero. Write bits set in an ACL are ignored by Samba.
27                 If the read only DOS attribute is unset, Samba simply sets the write bit of the
28                 owner to one.
29                 </para></listitem>
30
31                 <listitem><para>
32                 <constant>Permissions</constant> - The read only DOS attribute is mapped to the effective permissions of
33                 the connecting user, as evaluated by <citerefentry><refentrytitle>smbd</refentrytitle>
34                 <manvolnum>8</manvolnum></citerefentry> by reading the unix permissions and POSIX ACL (if present).
35                 If the connecting user does not have permission to modify the file, the read only attribute
36                 is reported as being set on the file.
37                 </para></listitem>
38
39                 <listitem><para>
40                 <constant>No</constant> - The read only DOS attribute is unaffected by permissions, and can only be set by
41                 the <smbconfoption name="store dos attributes"/> method. This may be useful for exporting mounted CDs.
42                 </para></listitem>
43     </itemizedlist>
44
45 </description>
46 <value type="default">yes</value>
47 </samba:parameter>