Next update of VFS modules development guide
[ira/wip.git] / docs / smbdotconf / security / directorymask.xml
1 <samba:parameter name="directory mask"
2         context="S"
3         type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <synonym>directory mode</synonym>
6 <description>
7     <para>This parameter is the octal modes which are 
8     used when converting DOS modes to UNIX modes when creating UNIX 
9     directories.</para>
10
11     <para>When a directory is created, the necessary permissions are 
12     calculated according to the mapping from DOS modes to UNIX permissions, 
13     and the resulting UNIX mode is then bit-wise 'AND'ed with this 
14     parameter. This parameter may be thought of as a bit-wise MASK for 
15     the UNIX modes of a directory. Any bit <emphasis>not</emphasis> set 
16     here will be removed from the modes set on a directory when it is 
17     created.</para>
18
19     <para>The default value of this parameter removes the 'group' 
20     and 'other' write bits from the UNIX mode, allowing only the 
21     user who owns the directory to modify it.</para>
22                 
23     <para>Following this Samba will bit-wise 'OR' the UNIX mode 
24     created from this parameter with the value of the <smbconfoption name="force directory mode"/> parameter. 
25     This parameter is set to 000 by default (i.e. no extra mode bits are added).</para>
26
27     <para>Note that this parameter does not apply to permissions
28     set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
29     a mask on access control lists also, they need to set the <smbconfoption name="directory security mask"/>.</para>
30 </description>
31
32 <related>force directory mode</related>
33 <related>create mask</related>
34 <related>directory security mask</related>
35 <related>inherit permissions</related>
36 <value type="default">0755</value>
37 <value type="example">0775</value>
38 </samba:parameter>