docs: document vfs_acl_xattr|tdb enforced settings
[Samba.git] / docs-xml / manpages / vfs_acl_tdb.8.xml
blob80b60b4f47a21c824720518982e0d9653584d5bd
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_acl_tdb.8">
5 <refmeta>
6         <refentrytitle>vfs_acl_tdb</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.4</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>vfs_acl_tdb</refname>
16         <refpurpose>Save NTFS-ACLs in a tdb file</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = acl_tdb</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
25 <refsect1>
26         <title>DESCRIPTION</title>
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
32         <para>The <command>vfs_acl_tdb</command> VFS module stores
33         NTFS Access Control Lists (ACLs) in a tdb file.
34         This enables the full mapping of Windows ACLs on Samba
35         servers.
36         </para>
38         <para>
39         The ACL settings are stored in
40         <filename>$LOCKDIR/file_ntacls.tdb</filename>.
41         </para>
43         <para>
44         This module forces the following parameters:
45         <itemizedlist>
46         <listitem><para>inherit acls = true</para></listitem>
47         <listitem><para>dos filemode = true</para></listitem>
48         <listitem><para>force unknown acl user = true</para></listitem>
49         </itemizedlist>
50         </para>
52         <para>This module is stackable.</para>
53 </refsect1>
55 <refsect1>
56         <title>OPTIONS</title>
58         <variablelist>
59                 <!-- please keep in sync with the other acl vfs modules that provide the same options -->
60                 <varlistentry>
61                 <term>acl_tdb:ignore system acls = [yes|no]</term>
62                 <listitem>
63                 <para>
64                 When set to <emphasis>yes</emphasis>, a best effort mapping
65                 from/to the POSIX ACL layer will <emphasis>not</emphasis> be
66                 done by this module. The default is <emphasis>no</emphasis>,
67                 which means that Samba keeps setting and evaluating both the
68                 system ACLs and the NT ACLs. This is better if you need your
69                 system ACLs be set for local or NFS file access, too. If you only
70                 access the data via Samba you might set this to yes to achieve
71                 better NT ACL compatibility.
72                 </para>
73                 </listitem>
74                 </varlistentry>
76                 <varlistentry>
77                 <term>acl_tdb:default acl style = [posix|windows]</term>
78                 <listitem>
79                 <para>
80                 This parameter determines the type of ACL that is synthesized in
81                 case a file or directory lacks an
82                 <emphasis>security.NTACL</emphasis> xattr.
83                 </para>
84                 <para>
85                 When set to <emphasis>posix</emphasis>, an ACL will be
86                 synthesized based on the POSIX mode permissions for user, group
87                 and others, with an additional ACE for <emphasis>NT
88                 Authority\SYSTEM</emphasis> will full rights.
89                 </para>
90                 <para>
91                 When set to <emphasis>windows</emphasis>, an ACL is synthesized
92                 the same way Windows does it, only including permissions for the
93                 owner and <emphasis>NT Authority\SYSTEM</emphasis>.
94                 </para>
95                 <para>
96                 The default for this option is <emphasis>posix</emphasis>.
97                 </para>
98                 </listitem>
99                 </varlistentry>
100         </variablelist>
102 </refsect1>
104 <refsect1>
105         <title>AUTHOR</title>
107         <para>The original Samba software and related utilities
108         were created by Andrew Tridgell. Samba is now developed
109         by the Samba Team as an Open Source project similar
110         to the way the Linux kernel is developed.</para>
111 </refsect1>
113 </refentry>