man vfs_streams_xattr: new options "prefix" and "store_stream_type"
authorRalph Boehme <rb@sernet.de>
Mon, 26 May 2014 14:12:17 +0000 (16:12 +0200)
committerMichael Adam <obnox@samba.org>
Fri, 13 Jun 2014 13:51:43 +0000 (15:51 +0200)
Add documentation for the two new options "streams_xattr:prefix" and
"streams_xattr:store_stream_type".

Signed-off-by: Ralph Boehme <rb@sernet.de>
Reviewed-by: Christof Schmitt <cs@samba.org>
Reviewed-by: Michael Adam <obnox@samba.org>
Autobuild-User(master): Michael Adam <obnox@samba.org>
Autobuild-Date(master): Fri Jun 13 15:51:43 CEST 2014 on sn-devel-104

docs-xml/manpages/vfs_streams_xattr.8.xml

index 5aa5aa8a66017ef8c17c0fa3f488e38afa0860a0..2deb802bcc158c91b186aa6a631372cfbde2328f 100644 (file)
        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 is
-       user.DosStream."ADS-NAME".</para>
+       (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>
        applications that store serious amounts of data in ADSs.</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>