docs: Update doc to use absolute path for 'dedicated keytab file'
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_streams_xattr.8.xml
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_streams_xattr.8">
4
5 <refmeta>
6         <refentrytitle>vfs_streams_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.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_streams_xattr</refname>
16         <refpurpose>Store alternate data streams in posix xattrs</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = streams_xattr</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>vfs_streams_xattr</command> enables storing of NTFS
33         alternate data streams in the file system. As a normal posix file
34         system does not support the concept of multiple data streams per file,
35         the streams_xattr module stores the data in posix extended attributes
36         (xattrs). The name of these attributes by default is
37         user.DosStream."ADS-NAME". The prefix "user.DosStream." can be changed
38         with the module option <command>streams_xattr:prefix</command>, but be
39         aware that this will also expose those ADS over the SMB extended
40         attributes interface.</para>
41
42         <para>The file system that is shared with this module enabled must
43         support xattrs.</para>
44
45         <para>Please note that most file systems have severe limitations on
46         the size of xattrs. So this module might work for applications like IE
47         that stores small zone information in streams but will fail for
48         applications that store serious amounts of data in ADSs.</para>
49
50         <para>CAUTION: Make sure to set "kernel oplocks = no" in smb.conf if
51         if you use this module because this combination is currently broken.
52         See Bug 7537 for details.</para>
53 </refsect1>
54
55 <refsect1>
56         <title>OPTIONS</title>
57
58         <variablelist>
59
60           <varlistentry>
61             <term>streams_xattr:prefix = STRING</term>
62             <listitem>
63               <para>Name prefix used when storing an ADS in an xattr, defaults to
64               <command>user.DosStream.</command>. Changing this will also
65               expose ADS over the SMB extended attributes interface.</para>
66             </listitem>
67           </varlistentry>
68
69           <varlistentry>
70             <term>streams_xattr:store_stream_type = [yes|no]</term>
71             <listitem>
72               <para>Whether the xattr names for Alternate Data Streams of type
73               "$DATA" are suffixed by the stream type string ":$DATA".
74               The default is <command>yes</command>.</para>
75             </listitem>
76           </varlistentry>
77
78         </variablelist>
79
80 </refsect1>
81
82 <refsect1>
83         <title>EXAMPLES</title>
84
85 <programlisting>
86         <smbconfsection name="[share]"/>
87         <smbconfoption name="vfs objects">streams_xattr</smbconfoption>
88 </programlisting>
89
90 </refsect1>
91
92 <refsect1>
93         <title>AUTHOR</title>
94
95         <para>The original Samba software and related utilities
96         were created by Andrew Tridgell. Samba is now developed
97         by the Samba Team as an Open Source project similar
98         to the way the Linux kernel is developed.</para>
99
100 </refsect1>
101
102 </refentry>