docs: use popt.autohelp entity in smbd manpage.
[Samba.git] / docs-xml / manpages / vfs_acl_xattr.8.xml
blob2fac8195a029dd17e1fffede0f8d81bcda0b0c8f
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_xattr.8">
5 <refmeta>
6         <refentrytitle>vfs_acl_xattr</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.0</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>vfs_acl_xattr</refname>
16         <refpurpose>Save NTFS-ACLs in Extended Attributes (EAs)</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = acl_xattr</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_xattr</command> VFS module stores
33         NTFS Access Control Lists (ACLs) in Extended Attributes (EAs).
34         This enables the full mapping of Windows ACLs on Samba
35         servers.
36         </para>
38         <para>The ACLs are stored in the Extended Attribute
39         <parameter>security.NTACL</parameter> of a file or directory.
40         This Attribute is <emphasis>not</emphasis> listed by
41         <command>getfattr -d <filename>filename</filename></command>.
42         To show the current value, the name of the EA must be specified
43         (e.g. <command>getfattr -n security.NTACL <filename>filename</filename>
44         </command>).
45         </para>
47         <para>This module is stackable.</para>
48 </refsect1>
50 <refsect1>
51         <title>OPTIONS</title>
53         <variablelist>
54                 <!-- please keep in sync with the other acl vfs modules that provide the same options -->
55                 <varlistentry>
56                 <term>acl_xattr:ignore system acls = [yes|no]</term>
57                 <listitem>
58                 <para>
59                 When set to <emphasis>yes</emphasis>, a best effort mapping
60                 from/to the POSIX ACL layer will <emphasis>not</emphasis> be
61                 done by this module. The default is <emphasis>no</emphasis>,
62                 which means that Samba keeps setting and evaluating both the
63                 system ACLs and the NT ACLs. This is better if you need your
64                 system ACLs be set for local or NFS file access, too. If you only
65                 access the data via Samba you might set this to yes to achieve
66                 better NT ACL compatibility.
67                 </para>
68                 </listitem>
69                 </varlistentry>
70         </variablelist>
72 </refsect1>
74 <refsect1>
75         <title>AUTHOR</title>
77         <para>The original Samba software and related utilities
78         were created by Andrew Tridgell. Samba is now developed
79         by the Samba Team as an Open Source project similar
80         to the way the Linux kernel is developed.</para>
81 </refsect1>
83 </refentry>