s3:param: add a utility function lp_idmap_range() to get the configured range for...
[Samba/gebeck_regimport.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">
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.0</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>vfs_streams_xattr</refname>
16         <refpurpose>Store alternate data streams in posix xattrs</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = streams_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_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 is
37         user.DosStream."ADS-NAME".</para>
39         <para>The file system that is shared with this module enabled must
40         support xattrs.</para>
42         <para>Please note that most file systems have severe limitations on
43         the size of xattrs. So this module might work for applications like IE
44         that stores small zone information in streams but will fail for
45         applications that store serious amounts of data in ADSs.</para>
46 </refsect1>
48 <refsect1>
49         <title>EXAMPLES</title>
51 <programlisting>
52         <smbconfsection name="[share]"/>
53         <smbconfoption name="vfs objects">streams_xattr</smbconfoption>
54 </programlisting>
56 </refsect1>
58 <refsect1>
59         <title>AUTHOR</title>
61         <para>The original Samba software and related utilities
62         were created by Andrew Tridgell. Samba is now developed
63         by the Samba Team as an Open Source project similar
64         to the way the Linux kernel is developed.</para>
66 </refsect1>
68 </refentry>