docs-xml/manpages/vfs_btrfs.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_btrfs.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_btrfs</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.1</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_btrfs</refname>
  16         <refpurpose>
  17                 Utilize features provided by the Btrfs filesystem
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>vfs objects = btrfs</command>
  24         </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>DESCRIPTION</title>
  29
  30         <para>This VFS module is part of the
  31         <citerefentry><refentrytitle>samba</refentrytitle>
  32         <manvolnum>8</manvolnum></citerefentry> suite.</para>
  33
  34         <para>
  35                 The <command>vfs_btrfs</command> VFS module exposes Btrfs
  36                 specific features for use by Samba.
  37         </para>
  38
  39         <para>
  40                 Btrfs allows for multiple files to share the same on-disk data
  41                 through the use cloned ranges. When an SMB client issues a
  42                 request to copy duplicate data (via FSCTL_SRV_COPYCHUNK), this
  43                 module maps the request to a Btrfs clone range IOCTL, instead
  44                 of performing reads and writes required by a traditional copy.
  45                 Doing so saves storage capacity and greatly reduces disk IO.
  46         </para>
  47
  48         <para>
  49                 This module also exposes Btrfs per-file compression support to
  50                 SMB clients via the get/set compression fsctls.
  51         </para>
  52
  53         <para>
  54                 This module is stackable.
  55         </para>
  56 </refsect1>
  57
  58 <refsect1>
  59         <title>CONFIGURATION</title>
  60
  61         <para>
  62                 <command>vfs_btrfs</command> requires that the underlying share
  63                 path is a Btrfs filesystem.
  64         </para>
  65
  66         <programlisting>
  67                 <smbconfsection name="[share]"/>
  68                 <smbconfoption name="vfs objects">btrfs</smbconfoption>
  69         </programlisting>
  70 </refsect1>
  71
  72 <refsect1>
  73         <title>VERSION</title>
  74
  75         <para>
  76                 This man page is correct for version 4.1.0 of the Samba suite.
  77         </para>
  78 </refsect1>
  79
  80 <refsect1>
  81         <title>AUTHOR</title>
  82
  83         <para>The original Samba software and related utilities
  84         were created by Andrew Tridgell. Samba is now developed
  85         by the Samba Team as an Open Source project similar
  86         to the way the Linux kernel is developed.</para>
  87
  88 </refsect1>
  89
  90 </refentry>