projects
/
platform
/
upstream
/
btrfs-progs.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
btrfs-progs: fix build of btrfs-show-super
[platform/upstream/btrfs-progs.git]
/
Documentation
/
btrfs-property.asciidoc
diff --git
a/Documentation/btrfs-property.asciidoc
b/Documentation/btrfs-property.asciidoc
index
8b9b7f0
..
b562717
100644
(file)
--- a/
Documentation/btrfs-property.asciidoc
+++ b/
Documentation/btrfs-property.asciidoc
@@
-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.
-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
both btrfs object and property.
*btrfs property* provides an unified and user-friendly method to tune different
@@
-22,28
+23,30
@@
btrfs properties instead of using the traditional method like `chattr`(1) or
SUBCOMMAND
----------
*get* [-t <type>] <object> [<name>]::
SUBCOMMAND
----------
*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
'-t <type>' option
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
property could be set for more then one object type.
+
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 following
s.
+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 following
:
ro::::
read-only flag of subvolume: true or false
label::::
label of device
compression::::
ro::::
read-only flag of subvolume: true or false
label::::
label of device
compression::::
-compression setting for an inode: lzo, zlib, or "" (empty string)
+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.
*list* [-t <type>] <object>::
Lists available properties with their descriptions for the given object.