1BTRFS-PROPERTY(8)                Btrfs Manual                BTRFS-PROPERTY(8)
2
3
4

NAME

6       btrfs-property - get/set/list properties for given filesystem object
7

SYNOPSIS

9       btrfs property <subcommand> <args>
10

DESCRIPTION

12       btrfs property is used to get/set/list property for given filesystem
13       object. The object can be an inode (file or directory), subvolume or
14       the whole filesystem. See the description of get subcommand for more
15       information about both btrfs object and property.
16
17       btrfs property provides an unified and user-friendly method to tune
18       different btrfs properties instead of using the traditional method like
19       chattr(1) or lsattr(1).
20

SUBCOMMAND

22       get [-t <type>] <object> [<name>]
23           get property from a btrfs <object> of given <type>
24
25           A btrfs object, which is set by <object>, can be a btrfs filesystem
26           itself, a btrfs subvolume, an inode (file or directory) inside
27           btrfs, or a device on which a btrfs exists.
28
29           The option -t can be used to explicitly specify what type of object
30           you meant. This is only needed when a property could be set for
31           more then one object type.
32
33           Possible types are s[ubvol], f[ilesystem], i[node] and d[evice],
34           where the first lettes is a shortcut.
35
36           Set the name of property by name. If no name is specified, all
37           properties for the given object are printed.  name is one of the
38           following:
39
40           ro
41               read-only flag of subvolume: true or false. Please also see
42               section SUBVOLUME FLAGS in btrfs-subvolume(8) for possible
43               implications regarding incremental send.
44
45           label
46               label of the filesystem. For an unmounted filesystem, provide a
47               path to a block device as object. For a mounted filesystem,
48               specify a mount point.
49
50           compression
51               compression algorithm set for an inode, possible values: lzo,
52               zlib, zstd. To disable compression use "" (empty string), no or
53               none.
54
55       list [-t <type>] <object>
56           Lists available properties with their descriptions for the given
57           object.
58
59           See the description of get subcommand for the meaning of each
60           option.
61
62       set [-f] [-t <type>] <object> <name> <value>
63           Sets a property on a btrfs object.
64
65           See the description of get subcommand for the meaning of each
66           option.
67
68           Options
69
70           -f
71               Force the change. Changing some properties may involve safety
72               checks or additional changes that depend on the properties
73               semantics.
74

EXIT STATUS

76       btrfs property returns a zero exit status if it succeeds. Non zero is
77       returned in case of failure.
78

AVAILABILITY

80       btrfs is part of btrfs-progs. Please refer to the btrfs wiki
81       http://btrfs.wiki.kernel.org for further details.
82

SEE ALSO

84       mkfs.btrfs(8), lsattr(1), chattr(1)
85
86
87
88Btrfs v5.15.1                     11/22/2021                 BTRFS-PROPERTY(8)
Impressum