summaryrefslogtreecommitdiff
path: root/docs-xml/manpages/vfs_btrfs.8.xml
blob: 01f788c8733f875a1a07d55cc01a91578a908d85 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?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.1</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>vfs_btrfs</refname>
	<refpurpose>
		Utilize features provided by the Btrfs filesystem
	</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 Btrfs
		specific features for use by Samba.
	</para>

	<para>
		Btrfs allows for multiple files to share the same on-disk data
		through the use cloned ranges. 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, instead
		of performing reads and writes required by a traditional copy.
		Doing so saves storage capacity and greatly reduces disk IO.
	</para>

	<para>
		This module is stackable.
	</para>
</refsect1>

<refsect1>
	<title>CONFIGURATION</title>

	<para>
		<command>vfs_btrfs</command> requires that the underlying share
		path is a Btrfs filesystem.
	</para>

	<programlisting>
		<smbconfsection name="[share]"/>
		<smbconfoption name="vfs objects">btrfs</smbconfoption>
	</programlisting>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>
		This man page is correct for version 4.1.0 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>