doc: add vfs_btrfs man page

diff --git a/docs-xml/manpages/vfs_btrfs.8.xml b/docs-xml/manpages/vfs_btrfs.8.xml
new file mode 100644 (file)
index 0000000..8b37e58
--- /dev/null
+++ b/docs-xml/manpages/vfs_btrfs.8.xml
@@ -0,0 +1,118 @@
+<?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_btrfs.8">
+
+<refmeta>
+       <refentrytitle>vfs_btrfs</refentrytitle>
+       <manvolnum>8</manvolnum>
+       <refmiscinfo class="source">Samba</refmiscinfo>
+       <refmiscinfo class="manual">System Administration tools</refmiscinfo>
+       <refmiscinfo class="version">4.0</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+       <refname>vfs_btrfs</refname>
+       <refpurpose>Make use of btrfs specific features</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>vfs objects = btrfs</command>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>This VFS module is part of the
+       <citerefentry><refentrytitle>samba</refentrytitle>
+       <manvolnum>8</manvolnum></citerefentry> suite.</para>
+
+       <para>
+               The <command>vfs_btrfs</command> VFS module exposes a
+               number of btrfs specific features for use by Samba.
+               Currently these features include snapshots and file range
+               cloning.
+       </para>
+
+       <para>
+               Snapshots are manipulated by Samba from the FSRVP server, or
+               fss agent RPC service. Snapshot creation and deletion requests
+               are translated to corresponding btrfs IOCTLs.
+       </para>
+       <para>
+               Btrfs allows for multiple files to share the same on-disk data
+               through the use of range cloning. When an SMB client issues a
+               request to copy duplicate data (via FSCTL_SRV_COPYCHUNK), this
+               module maps the request to a btrfs clone range IOCTL, saving
+               storage capacity and greatly reducing processing overhead.
+       </para>
+
+       <para>
+               This module is stackable.
+               For more information on this module, please see:
+               <ulink url="http://www.samba.org/~ddiss/vfs_btrfs.odp">
+                       http://www.samba.org/~ddiss/vfs_btrfs.odp</ulink>.
+       </para>
+</refsect1>
+
+<refsect1>
+       <title>CONFIGURATION</title>
+
+       <para>
+               <command>vfs_btrfs</command> requires that the underlying share
+               path is a btrfs subvolume.
+       </para>
+
+       <para>
+               The fss agent RPC service must be running in order for Samba
+               to support MS-FSRVP snapshot manipulation requests.
+       </para>
+       <programlisting>
+               <smbconfsection name="[global]"/>
+               <smbconfoption name="rpc_daemon:fssd">fork</smbconfoption>
+       </programlisting>
+       <para>
+               The <command>vfs_shadow_copy</command> module can be used to
+               expose snapshots created by <command>vfs_btrfs</command> to
+               Windows Explorer as file / directory "previous versions".
+       </para>
+       <programlisting>
+               <smbconfsection name="[share]"/>
+               <smbconfoption name="vfs objects">btrfs shadow_copy</smbconfoption>
+       </programlisting>
+</refsect1>
+
+<refsect1>
+       <title>EXAMPLES</title>
+
+       <para>Add shadow copy support to user home directories:</para>
+       <programlisting>
+               <smbconfsection name="[global]"/>
+               <smbconfoption name="rpc_daemon:fssd">fork</smbconfoption>
+
+               <smbconfsection name="[btrfs_share]"/>
+               <smbconfoption name="vfs objects">btrfs shadow_copy</smbconfoption>
+               <smbconfoption name="path">/mnt/btrfs_subvolume/</smbconfoption>
+       </programlisting>
+
+</refsect1>
+
+<refsect1>
+       <title>VERSION</title>
+
+       <para>This man page is correct for version 3.6.7 of the Samba suite.</para>
+</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>

diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build
index 25e381e2dede58aa7c669cc79ff847e8e5ee99e6..0c06531103da5d172e64925b147c3714ba92d89a 100644 (file)
--- a/docs-xml/wscript_build
+++ b/docs-xml/wscript_build
@@ -48,6 +48,7 @@ manpages='''
          manpages/vfs_aio_linux.8
          manpages/vfs_aio_pthread.8
          manpages/vfs_audit.8
+        manpages/vfs_btrfs.8
          manpages/vfs_cacheprime.8
          manpages/vfs_cap.8
          manpages/vfs_catia.8