summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/security/directorymask.xml
blob: 0844733edec860586d81ee73091013fc0ea4632b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<samba:parameter xmlns:samba="http://samba.org/common">
		<term><anchor id="DIRECTORYMASK"/>directory mask (S)</term>
		<listitem><para>This parameter is the octal modes which are 
		used when converting DOS modes to UNIX modes when creating UNIX 
		directories.</para>

		<para>When a directory is created, the necessary permissions are 
		calculated according to the mapping from DOS modes to UNIX permissions, 
		and the resulting UNIX mode is then bit-wise 'AND'ed with this 
		parameter. This parameter may be thought of as a bit-wise MASK for 
		the UNIX modes of a directory. Any bit <emphasis>not</emphasis> set 
		here will be removed from the modes set on a directory when it is 
		created.</para>

		<para>The default value of this parameter removes the 'group' 
		and 'other' write bits from the UNIX mode, allowing only the 
		user who owns the directory to modify it.</para>
		
		<para>Following this Samba will bit-wise 'OR' the UNIX mode 
		created from this parameter with the value of the <link linkend="FORCEDIRECTORYMODE"><parameter moreinfo="none">force directory mode
		</parameter></link> parameter. This parameter is set to 000 by 
		default (i.e. no extra mode bits are added).</para>

		<para>Note that this parameter does not apply to permissions
		set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
		a mask on access control lists also, they need to set the <link linkend="DIRECTORYSECURITYMASK"><parameter moreinfo="none">directory security mask</parameter></link>.</para>

		<para>See the <link linkend="FORCEDIRECTORYMODE"><parameter moreinfo="none">force 
		directory mode</parameter></link> parameter to cause particular mode 
		bits to always be set on created directories.</para>

		<para>See also the <link linkend="CREATEMODE"><parameter moreinfo="none">create mode
		</parameter></link> parameter for masking mode bits on created files, 
		and the <link linkend="DIRECTORYSECURITYMASK"><parameter moreinfo="none">directory 
		security mask</parameter></link> parameter.</para>

		<para>Also refer to the <link linkend="INHERITPERMISSIONS"><parameter moreinfo="none">
		inherit permissions</parameter></link> parameter.</para>

		<para>Default: <command moreinfo="none">directory mask = 0755</command></para>
		<para>Example: <command moreinfo="none">directory mask = 0775</command></para>
		</listitem>
		</samba:parameter>