Manpage/btrfs-property

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Update from git, v5.14.2)
(remove content)
 
Line 1: Line 1:
=btrfs-property(8) manual page=
 
 
{{GeneratedManpage
 
{{GeneratedManpage
 
|name=btrfs-property}}
 
|name=btrfs-property}}
 
==NAME==
 
btrfs-property - get/set/list properties for given filesystem object
 
 
==SYNOPSIS==
 
 
<p><b>btrfs property</b> <em>&lt;subcommand&gt;</em> <em>&lt;args&gt;</em></p>
 
==DESCRIPTION==
 
 
<p><b>btrfs property</b> 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 <b>get</b> subcommand for more information about
 
both btrfs object and property.</p>
 
<p><b>btrfs property</b> provides an unified and user-friendly method to tune different
 
btrfs properties instead of using the traditional method like [http://man7.org/linux/man-pages/man1/chattr.1.html chattr(1)] or
 
[http://man7.org/linux/man-pages/man1/lsattr.1.html lsattr(1)].</p>
 
==SUBCOMMAND==
 
 
<dl>
 
<dt>
 
<b>get</b> [-t <em>&lt;type&gt;</em>] <em>&lt;object&gt;</em> [<em>&lt;name&gt;</em>]
 
<dd>
 
<p>
 
get property from a btrfs <em>&lt;object&gt;</em> of given <em>&lt;type&gt;</em>
 
</p>
 
<p>A btrfs object, which is set by <em>&lt;object&gt;</em>, can be a btrfs filesystem
 
itself, a btrfs subvolume, an inode (file or directory) inside btrfs,
 
or a device on which a btrfs exists.</p>
 
<p>The option <em>-t</em> 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.</p>
 
<p>Possible types are <em>s[ubvol]</em>, <em>f[ilesystem]</em>, <em>i[node]</em> and <em>d[evice]</em>, where
 
the first lettes is a shortcut.</p>
 
<p>Set the name of property by <em>name</em>. If no <em>name</em> is specified,
 
all properties for the given object are printed. <em>name</em> is one of
 
the following:</p>
 
<dl>
 
<dt>
 
ro
 
<dd>
 
<p>
 
read-only flag of subvolume: true or false. Please also see section <em>SUBVOLUME FLAGS</em>
 
in [[Manpage/btrfs-subvolume|btrfs-subvolume(8)]] for possible implications regarding incremental send.
 
</p>
 
 
<dt>
 
label
 
<dd>
 
<p>
 
label of the filesystem. For an unmounted filesystem, provide a path to a block
 
device as object. For a mounted filesystem, specify a mount point.
 
</p>
 
 
<dt>
 
compression
 
<dd>
 
<p>
 
compression algorithm set for an inode, possible values: <em>lzo</em>, <em>zlib</em>, <em>zstd</em>.
 
To disable compression use "" (empty string), <em>no</em> or <em>none</em>.
 
</p>
 
 
</dl>
 
 
<dt>
 
<b>list</b> [-t <em>&lt;type&gt;</em>] <em>&lt;object&gt;</em>
 
<dd>
 
<p>
 
Lists available properties with their descriptions for the given object.
 
</p>
 
<p>See the description of <b>get</b> subcommand for the meaning of each option.</p>
 
 
<dt>
 
<b>set</b> [-f] [-t <em>&lt;type&gt;</em>] <em>&lt;object&gt;</em> <em>&lt;name&gt;</em> <em>&lt;value&gt;</em>
 
<dd>
 
<p>
 
Sets a property on a btrfs object.
 
</p>
 
<p>See the description of <b>get</b> subcommand for the meaning of each option.</p>
 
<p><tt>Options</tt></p>
 
<dl>
 
<dt>
 
-f
 
<dd>
 
<p>
 
Force the change. Changing some properties may involve safety checks or
 
additional changes that depend on the properties semantics.
 
</p>
 
 
</dl>
 
 
</dl>
 
==EXIT STATUS==
 
 
<p><b>btrfs property</b> returns a zero exit status if it succeeds. Non zero is
 
returned in case of failure.</p>
 
==AVAILABILITY==
 
 
<p><b>btrfs</b> is part of btrfs-progs.
 
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 
further details.</p>
 
==SEE ALSO==
 
 
<p>[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]],
 
[http://man7.org/linux/man-pages/man1/lsattr.1.html lsattr(1)],
 
[http://man7.org/linux/man-pages/man1/chattr.1.html chattr(1)]</p>
 
[[Category:Manpage]]
 

Latest revision as of 12:31, 12 January 2022

Note: manual pages are located at read-the-docs site, please update your links.


Personal tools