Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_btrfs.8

raw
1 '\" t
2 .\" Title: vfs_btrfs
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_BTRFS" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_btrfs \- Utilize features provided by the Btrfs filesystem
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = btrfs
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(8)
39 suite\&.
40 .PP
41 The
42 vfs_btrfs
43 VFS module exposes Btrfs specific features for use by Samba\&.
44 .PP
45 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\&.
46 .PP
47 This module also exposes Btrfs per\-file compression support to SMB clients via the get/set compression fsctls\&.
48 .PP
49 Btrfs snapshots can be manipulated by Samba\*(Aqs FSRVP server\&. Snapshot manipulation using this module is currently considered experimental, and is therefore disabled by default\&. The
50 vfs_snapper
51 module is instead recommended for this purpose\&.
52 .PP
53 This module is stackable\&.
54 .SH "OPTIONS"
55 .PP
56 btrfs: manipulate snapshots = [yes|no]
57 .RS 4
58 When set to
59 \fIyes\fR, experimental support for the creation and deletion of snapshots via corresponding Btrfs IOCTLs will be enabled\&. The default is
60 \fIno\fR, which means that such requests are passed through to any underlying VFS module\&.
61 .RE
62 .SH "CONFIGURATION"
63 .PP
64 vfs_btrfs
65 requires that the underlying share path is a Btrfs subvolume\&.
66 .sp
67 .if n \{\
68 .RS 4
69 .\}
70 .nf
71 \fI[share]\fR
72 \m[blue]\fBvfs objects = btrfs\fR\m[]
73 \m[blue]\fBbtrfs: manipulate snapshots = no\fR\m[]
74 .fi
75 .if n \{\
76 .RE
77 .\}
78 .PP
79 To use the experimental snapshot manipulation functionality provided by this module, it must be explicitly enabled, and Samba\*(Aqs FSRVP server must be running\&.
80 .PP
81 The
82 vfs_shadow_copy
83 module can be used to expose snapshots created by
84 vfs_btrfs
85 to Windows Explorer as file / directory "previous versions"\&.
86 .sp
87 .if n \{\
88 .RS 4
89 .\}
90 .nf
91 \fI[global]\fR
92 \m[blue]\fBregistry shares = yes\fR\m[]
93 \m[blue]\fBinclude = registry\fR\m[]
94
95 \fI[share]\fR
96 \m[blue]\fBvfs objects = btrfs shadow_copy\fR\m[]
97 \m[blue]\fBbtrfs: manipulate snapshots = yes\fR\m[]
98 .fi
99 .if n \{\
100 .RE
101 .\}
102 .SH "VERSION"
103 .PP
104 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
105 .SH "AUTHOR"
106 .PP
107 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\&.