summaryrefslogtreecommitdiffstats
path: root/docs-xml/manpages/vfs_streams_xattr.8.xml
blob: db912d7ebada4bb254ea74c4069ad204fad88504 (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="vfs_streams_xattr.8">

<refmeta>
	<refentrytitle>vfs_streams_xattr</refentrytitle>
	<manvolnum>8</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
	<refmiscinfo class="version">4.2</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>vfs_streams_xattr</refname>
	<refpurpose>Store alternate data streams in posix xattrs</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>vfs objects = streams_xattr</command>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This VFS module is part of the
	<citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The <command>vfs_streams_xattr</command> enables storing of NTFS
	alternate data streams in the file system. As a normal posix file
	system does not support the concept of multiple data streams per file,
	the streams_xattr module stores the data in posix extended attributes
	(xattrs). The name of these attributes by default is
	user.DosStream."ADS-NAME". The prefix "user.DosStream." can be changed
	with the module option <command>streams_xattr:prefix</command>, but be
	aware that this will also expose those ADS over the SMB extended
	attributes interface.</para>

	<para>The file system that is shared with this module enabled must
	support xattrs.</para>

	<para>Please note that most file systems have severe limitations on
	the size of xattrs. So this module might work for applications like IE
	that stores small zone information in streams but will fail for
	applications that store serious amounts of data in ADSs.</para>

	<para>CAUTION: Make sure to set "kernel oplocks = no" in smb.conf if
	if you use this module because this combination is currently broken.
	See Bug 7537 for details.</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>

	  <varlistentry>
	    <term>streams_xattr:prefix = STRING</term>
	    <listitem>
	      <para>Name prefix used when storing an ADS in an xattr, defaults to
	      <command>user.DosStream.</command>. Changing this will also
	      expose ADS over the SMB extended attributes interface.</para>
	    </listitem>
	  </varlistentry>

	  <varlistentry>
	    <term>streams_xattr:store_stream_type = [yes|no]</term>
	    <listitem>
	      <para>Whether the xattr names for Alternate Data Streams of type
	      "$DATA" are suffixed by the stream type string ":$DATA".
	      The default is <command>yes</command>.</para>
	    </listitem>
	  </varlistentry>

	</variablelist>

</refsect1>

<refsect1>
	<title>EXAMPLES</title>

<programlisting>
        <smbconfsection name="[share]"/>
	<smbconfoption name="vfs objects">streams_xattr</smbconfoption>
</programlisting>

</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>The original Samba software and related utilities
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar
	to the way the Linux kernel is developed.</para>

</refsect1>

</refentry>