Update "*securitymask* docs to match the code.
[Samba/gbeck.git] / docs / smbdotconf / security / directorysecuritymask.xml
blob352e892f1ca27f2109acfe38cb18872e353120da
1 <samba:parameter name="directory security mask"
2                  context="S"
3                                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>This parameter controls what UNIX permission bits 
7     can be set when a Windows NT client is manipulating the UNIX 
8     permission on a directory using the native NT security dialog 
9     box.</para>
11     <para>
12         This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus preventing any bits not
13         in this mask from being set.  Make sure not to mix up this parameter with <smbconfoption name="force
14         directory security mode"/>, which works similar like this one but uses logical OR instead of AND.
15         Essentially, zero bits in this mask are a set of bits that will always be set to zero.
16         </para>
18     <para>If not set explicitly this parameter is set to 0777
19     meaning a user is allowed to set all the user/group/world
20     permissions on a directory.</para>
22     <para><emphasis>Note</emphasis> that users who can access the 
23     Samba server through other means can easily bypass this restriction, 
24     so it is primarily useful for standalone &quot;appliance&quot; systems.  
25     Administrators of most normal systems will probably want to leave
26         it as the default of <constant>0777</constant>.</para>
27 </description>
29 <related>force directory security mode</related>
30 <related>security mask</related>
31 <related>force security mode</related>
32 <value type="default">0777</value>
33 <value type="example">0700</value>
34 </samba:parameter>