sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2025-01-11 05:18:09 +03:00
Code

Document the streams modules

Browse Source 
(This used to be commit ff158a1126)
This commit is contained in:
Volker Lendecke 2008-07-18 11:18:04 +02:00
parent c1636e7383
commit f6b10006ef
2 changed files with 146 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
docs-xml/manpages-3/vfs_streams_depot.8.xml Normal file
View File

@ -0,0 +1,78 @@
<?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_depot.8">
<refmeta>
<refentrytitle>vfs_streams_depot</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
<refmiscinfo class="version">3.2</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vfs_streams_depot</refname>
<refpurpose>EXPERIMENTAL module to store alternate data streams in a
central directory.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>vfs objects = streams_depot</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This <emphasis>EXPERIMENTAL</emphasis> VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>vfs_streams_depot</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_depot module stores the data in files in a separate
directory.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>streams_depot:directory = PATH</term>
<listitem>
<para>Path of the directory where the alternate data streams
should be stored. Defaults to the sharepath/.streams.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<programlisting>
<smbconfsection name="[share]"/>
<smbconfoption name="vfs objects">streams_depot</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>

68
docs-xml/manpages-3/vfs_streams_xattr.8.xml Normal file
View File

@ -0,0 +1,68 @@
<?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">3.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 is
user.DosStream."ADS-NAME".</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>
</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>