path: root/Documentation/btrfs-property.asciidoc
diff options
Diffstat (limited to 'Documentation/btrfs-property.asciidoc')
1 files changed, 73 insertions, 0 deletions
diff --git a/Documentation/btrfs-property.asciidoc b/Documentation/btrfs-property.asciidoc
new file mode 100644
index 00000000..8b9b7f03
--- /dev/null
+++ b/Documentation/btrfs-property.asciidoc
@@ -0,0 +1,73 @@
+btrfs-property - get/set/list properties for given btrfs object.
+*btrfs property* <subcommand> <args>
+*btrfs property* is used to get/set/list property for given btrfs object.
+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
+btrfs properties instead of using the traditional method like `chattr`(1) or
+*get* [-t <type>] <object> [<name>]::
+Gets a property from a btrfs object.
+A btrfs object, which is set by <object>, can be a btrfs filesystem
+itself, a btrfs subvolume, an inode(file or directory) inside btrfs,
+or a device on which a btrfs exists.
+The '-t <type>' option 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]'.
+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.
+read-only flag of subvolume: true or false
+label of device
+compression setting for an inode: lzo, zlib, or "" (empty string)
+*list* [-t <type>] <object>::
+Lists available properties with their descriptions for the given object.
+See the description of *get* subcommand for the meaning of each option.
+*set* [-t <type>] <object> <name> <value>::
+Sets a property on a btrfs object.
+See the description of *get* subcommand for the meaning of each option.
+*btrfs property* returns a zero exit status if it succeeds. Non zero is
+returned in case of failure.
+*btrfs* is part of btrfs-progs.
+Please refer to the btrfs wiki for
+further details.