diff options
author | David Sterba <dsterba@suse.cz> | 2015-04-14 17:37:23 +0200 |
---|---|---|
committer | David Sterba <dsterba@suse.cz> | 2015-04-14 17:41:27 +0200 |
commit | 7ffccaf0c3b4d4979d7d74bab3d79d9541a6e665 (patch) | |
tree | 1d64b306503787588d0d79ab467b95f8c6a83c99 /Documentation/btrfs-property.asciidoc | |
parent | 32ca2fa502c0a00a7dc40adbdae2e7b7765e6d63 (diff) |
btrfs-progs: Documentaion: rename to .asciidoc
A few minor benefits:
* editors set highliting according to the extensions
* web access to the git repository (github) renders the .asciidoc
files:
* we can link to them from the wiki
* the files are editable via browser and such editations can be
submitted for merge easily
Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation/btrfs-property.asciidoc')
-rw-r--r-- | Documentation/btrfs-property.asciidoc | 73 |
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(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 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 +`lsattr`(1). + +SUBCOMMAND +---------- +*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. + +ro:::: +read-only flag of subvolume: true or false +label:::: +label of device +compression:::: +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. + +EXIT STATUS +----------- +*btrfs property* returns a zero exit status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +*btrfs* is part of btrfs-progs. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. + +SEE ALSO +-------- +`mkfs.btrfs`(8), +`lsattr`(1), +`chattr`(1) |