docs-xml/manpages-3/vfs_streams_depot.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_depot.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_streams_depot</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">3.2</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_streams_depot</refname>
  16         <refpurpose>EXPERIMENTAL module to store alternate data streams in a
  17         central directory.
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>vfs objects = streams_depot</command>
  24         </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>DESCRIPTION</title>
  29
  30         <para>This <emphasis>EXPERIMENTAL</emphasis> VFS module is part of the
  31         <citerefentry><refentrytitle>samba</refentrytitle>
  32         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  33
  34         <para>The <command>vfs_streams_depot</command> enables storing of NTFS
  35         alternate data streams in the file system. As a normal posix file
  36         system does not support the concept of multiple data streams per file,
  37         the streams_depot module stores the data in files in a separate
  38         directory.</para>
  39
  40 </refsect1>
  41
  42 <refsect1>
  43         <title>OPTIONS</title>
  44
  45         <variablelist>
  46
  47                 <varlistentry>
  48                 <term>streams_depot:directory = PATH</term>
  49                 <listitem>
  50                 <para>Path of the directory where the alternate data streams
  51                 should be stored. Defaults to the sharepath/.streams.</para>
  52                 </listitem>
  53                 </varlistentry>
  54
  55         </variablelist>
  56 </refsect1>
  57
  58 <refsect1>
  59         <title>EXAMPLES</title>
  60
  61 <programlisting>
  62         <smbconfsection name="[share]"/>
  63         <smbconfoption name="vfs objects">streams_depot</smbconfoption>
  64 </programlisting>
  65
  66 </refsect1>
  67
  68 <refsect1>
  69         <title>AUTHOR</title>
  70
  71         <para>The original Samba software and related utilities
  72         were created by Andrew Tridgell. Samba is now developed
  73         by the Samba Team as an Open Source project similar
  74         to the way the Linux kernel is developed.</para>
  75
  76 </refsect1>
  77
  78 </refentry>