diff options
author | Qu Wenruo <quwenruo@cn.fujitsu.com> | 2014-04-15 15:04:50 +0800 |
---|---|---|
committer | David Sterba <dsterba@suse.cz> | 2014-04-22 14:15:25 +0200 |
commit | 97822b5eeaf101ac22c5d62b5e2ea4931ff95433 (patch) | |
tree | 305e30ff8ca338e1256a4dc7ae3f373fe56f172a /Documentation/btrfs-property.txt | |
parent | 01c42d908a46929e86a9354f6705f34ea12f1958 (diff) |
btrfs-progs: Convert man page for btrfs-property.
Convert the man page for the newly added btrfs-property subcommand.
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation/btrfs-property.txt')
-rw-r--r-- | Documentation/btrfs-property.txt | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/Documentation/btrfs-property.txt b/Documentation/btrfs-property.txt new file mode 100644 index 00000000..82466f9e --- /dev/null +++ b/Documentation/btrfs-property.txt @@ -0,0 +1,69 @@ +btrfs-property(8) +================= + +NAME +---- +btrfs-property - get/set/list properties for given btrfs object. + +SYNOPSIS +-------- +'btrfs property' <subcommand> <args> + +DESCRIPTION +----------- +'btrfs property' is used to get/set/list property, like lable or compression +state, for given btrfs object. + +'btrfs property' provides an unified and user-friendly method to tune different +btrfs properties instead of using the traditional method like `chattr`(1) or +`lsattr`(1). + +SUBCOMMAND +---------- +'get' [-t <type>] <object> [<name>]:: +Gets a property from a btrfs object. ++ +If no name is specified, all properties for the given object are +printed. +A filesystem object can be a the filesystem itself, a subvolume, +an inode or a device. ++ +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]'. ++ +The <object> can be path of btrfs device, btrfs mount point, or any +directories/files inside btrfs. + +'set' [-t <type>] <object> <name> <value>:: +Sets a property on a btrfs object. ++ +See description of 'get' subcommand for a description of objects and object +types. + +'list' [-t <type>] <object>:: +Lists available properties with their descriptions for the given object. ++ +Please see the help of 'btrfs property get' for a description of +objects and object types. + +EXIT STATUS +----------- +'btrfs property' returns a zero exist status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +development, +and not suitable for any uses other than benchmarking and review. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. + +SEE ALSO +-------- +`mkfs.btrfs`(8), +`lsattr`(1), +`setattr`(8) |