samba-mirror/docs-xml/manpages/vfs_streams_depot.8.xml

<?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">4.3</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>

		<varlistentry>
		<term>streams_depot:delete_lost = [ yes | no ]</term>
		<listitem>
		<para>In the case of an already existing data streams directory
		for a newly created file the streams directory will be renamed
		to "lost-%lu", random(). With this option lost stream directories
		will be removed	instead of renamed.</para>
		<itemizedlist>
		<listitem><para>
		<command>no(default)</command> - rename lost streams to
		"lost-%lu", random().
		</para></listitem>
		<listitem><para>
		<command>yes</command> - remove lost streams.
		</para></listitem>
		</itemizedlist>
		</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>