RepoMirrors
/
btrfs-progs
mirror of https://github.com/kdave/btrfs-progs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

btrfs-progs: docs: update btrfs-properties 

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2017-10-17 20:27:12 +02:00
parent c0f7e29127
commit f25091e654
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/btrfs-property.asciidoc
View File

@ -3,7 +3,7 @@ btrfs-property(8)
NAME NAME
---- ----
btrfs-property - get/set/list properties for given btrfs object. btrfs-property - get/set/list properties for given filesystem object
SYNOPSIS SYNOPSIS
-------- --------
@ -11,8 +11,9 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
*btrfs property* is used to get/set/list property for given btrfs object. *btrfs property* is used to get/set/list property for given filesystem object.
See the description of *get* subcommand for more information about 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. both btrfs object and property.
*btrfs property* provides an unified and user-friendly method to tune different *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
SUBCOMMAND SUBCOMMAND
---------- ----------
*get* [-t <type>] <object> [<name>]:: *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 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. or a device on which a btrfs exists.
+ +
The option '-t' can be used to explicitly The option '-t' can be used to explicitly
specify what type of object you meant. This is only needed when a specify what type of object you meant. This is only needed when a
property could be set for more then one object type. 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, Set the name of property by 'name'. If no 'name' is specified,
all properties for the given object are printed. 'name' is one of all properties for the given object are printed. 'name' is one of
the followings. the following:
ro:::: ro::::
read-only flag of subvolume: true or false read-only flag of subvolume: true or false
label:::: label::::
label of device label of device
compression:::: compression::::
compression algorithm for an inode, possible values: 'lzo', 'zlib', 'zstd'. To compression algorithm set for an inode, possible values: 'lzo', 'zlib', 'zstd'.
disable compression use "" (empty string), 'no' or 'none'. To disable compression use "" (empty string), 'no' or 'none'.
*list* [-t <type>] <object>:: *list* [-t <type>] <object>::
Lists available properties with their descriptions for the given object. Lists available properties with their descriptions for the given object.