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
42
43           label
44               label of the filesystem. For an unmounted filesystem, provide a
45               path to a block device as object. For a mounted filesystem,
46               specify a mount point.
47
48           compression
49               compression algorithm set for an inode, possible values: lzo,
50               zlib, zstd. To disable compression use "" (empty string), no or
51               none.
52
53       list [-t <type>] <object>
54           Lists available properties with their descriptions for the given
55           object.
56
57           See the description of get subcommand for the meaning of each
58           option.
59
60       set [-t <type>] <object> <name> <value>
61           Sets a property on a btrfs object.
62
63           See the description of get subcommand for the meaning of each
64           option.
65

EXIT STATUS

67       btrfs property returns a zero exit status if it succeeds. Non zero is
68       returned in case of failure.
69

AVAILABILITY

71       btrfs is part of btrfs-progs. Please refer to the btrfs wiki
72       http://btrfs.wiki.kernel.org for further details.
73

SEE ALSO

75       mkfs.btrfs(8), lsattr(1), chattr(1)
76
77
78
79Btrfs v5.10                       01/18/2021                 BTRFS-PROPERTY(8)
Impressum