path: root/Documentation
diff options
authorDavid Sterba <>2017-10-17 20:27:12 +0200
committerDavid Sterba <>2017-11-14 15:59:00 +0100
commitf25091e65464b28e6444e697c2d2e8f62945dd21 (patch)
tree560de8b7fa8739f16699b0650c8ec5f7c0d49739 /Documentation
parentc0f7e291274df28e83554fe2c38cb5e5cebddd7c (diff)
btrfs-progs: docs: update btrfs-properties
Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation')
1 files changed, 11 insertions, 9 deletions
diff --git a/Documentation/btrfs-property.asciidoc b/Documentation/btrfs-property.asciidoc
index 9f31d481..b562717b 100644
--- a/Documentation/btrfs-property.asciidoc
+++ b/Documentation/btrfs-property.asciidoc
@@ -3,7 +3,7 @@ btrfs-property(8)
-btrfs-property - get/set/list properties for given btrfs object.
+btrfs-property - get/set/list properties for given filesystem object
@@ -11,8 +11,9 @@ SYNOPSIS
-*btrfs property* is used to get/set/list property for given btrfs object.
-See the description of *get* subcommand for more information about
+*btrfs property* is used to get/set/list property for given filesystem object.
+The object can be an inode (file or directory), subvolume or the whole
+filesystem. See the description of *get* subcommand for more information about
both btrfs object and property.
*btrfs property* provides an unified and user-friendly method to tune different
@@ -22,29 +23,30 @@ btrfs properties instead of using the traditional method like `chattr`(1) or
*get* [-t <type>] <object> [<name>]::
-Gets a property from a btrfs object.
+get property from a btrfs <object> of given <type>
A btrfs object, which is set by <object>, can be a btrfs filesystem
-itself, a btrfs subvolume, an inode(file or directory) inside btrfs,
+itself, a btrfs subvolume, an inode (file or directory) inside btrfs,
or a device on which a btrfs exists.
The option '-t' can be used to explicitly
specify what type of object you meant. This is only needed when a
property could be set for more then one object type.
-Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]'.
+Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]', where
+the first lettes is a shortcut.
Set the name of property by 'name'. If no 'name' is specified,
all properties for the given object are printed. 'name' is one of
-the followings.
+the following:
read-only flag of subvolume: true or false
label of device
-compression algorithm for an inode, possible values: 'lzo', 'zlib', 'zstd'. To
-disable compression use "" (empty string), 'no' or 'none'.
+compression algorithm set for an inode, possible values: 'lzo', 'zlib', 'zstd'.
+To disable compression use "" (empty string), 'no' or 'none'.
*list* [-t <type>] <object>::
Lists available properties with their descriptions for the given object.