Manpage/btrfs

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(git 5.4)
(remove content)
 
Line 1: Line 1:
=btrfs(8) manual page=
 
 
{{GeneratedManpage
 
{{GeneratedManpage
 
|name=btrfs}}
 
|name=btrfs}}
 
==NAME==
 
btrfs - a toolbox to manage btrfs filesystems
 
 
==SYNOPSIS==
 
 
<p><b>btrfs</b> <em>&lt;command&gt;</em> [<em>&lt;args&gt;</em>]</p>
 
==DESCRIPTION==
 
 
<p>The <b>btrfs</b> utility is a toolbox for managing btrfs filesystems.  There are
 
command groups to work with subvolumes, devices, for whole filesystem or other
 
specific actions. See section <b>COMMANDS</b>.</p>
 
<p>There are also standalone tools for some tasks like <b>btrfs-convert</b> or
 
<b>btrfstune</b> that were separate historically and/or haven&#8217;t been merged to the
 
main utility. See section <em>STANDALONE TOOLS</em> for more details.</p>
 
<p>For other topics (mount options, etc) please refer to the separate manual
 
page [[Manpage/btrfs|btrfs(5)]].</p>
 
==COMMAND SYNTAX==
 
 
<p>Any command name can be shortened so long as the shortened form is unambiguous,
 
however, it is recommended to use full command names in scripts.  All command
 
groups have their manual page named <b>btrfs-<em>&lt;group&gt;</em></b>.</p>
 
<p>For example: it is possible to run <b>btrfs sub snaps</b> instead of
 
<b>btrfs subvolume snapshot</b>.
 
But <b>btrfs file s</b> is not allowed, because <b>file s</b> may be interpreted
 
both as <b>filesystem show</b> and as <b>filesystem sync</b>.</p>
 
<p>If the command name is ambiguous, the list of conflicting options is
 
printed.</p>
 
<p>For an overview of a given command use <em>btrfs command --help</em>
 
or <em>btrfs [command&#8230;] --help --full</em> to print all available options.</p>
 
==COMMANDS==
 
 
<dl>
 
<dt>
 
<b>balance</b>
 
<dd>
 
<p>
 
        Balance btrfs filesystem chunks across single or several devices.<br/>
 
        See [[Manpage/btrfs-balance|btrfs-balance(8)]] for details.
 
</p>
 
 
<dt>
 
<b>check</b>
 
<dd>
 
<p>
 
        Do off-line check on a btrfs filesystem.<br/>
 
        See [[Manpage/btrfs-check|btrfs-check(8)]] for details.
 
</p>
 
 
<dt>
 
<b>device</b>
 
<dd>
 
<p>
 
        Manage devices managed by btrfs, including add/delete/scan and so
 
        on.<br/>
 
        See [[Manpage/btrfs-device|btrfs-device(8)]] for details.
 
</p>
 
 
<dt>
 
<b>filesystem</b>
 
<dd>
 
<p>
 
        Manage a btrfs filesystem, including label setting/sync and so on.<br/>
 
        See [[Manpage/btrfs-filesystem|btrfs-filesystem(8)]] for details.
 
</p>
 
 
<dt>
 
<b>inspect-internal</b>
 
<dd>
 
<p>
 
        Debug tools for developers/hackers.<br/>
 
        See [[Manpage/btrfs-inspect-internal|btrfs-inspect-internal(8)]] for details.
 
</p>
 
 
<dt>
 
<b>property</b>
 
<dd>
 
<p>
 
        Get/set a property from/to a btrfs object.<br/>
 
        See [[Manpage/btrfs-property|btrfs-property(8)]] for details.
 
</p>
 
 
<dt>
 
<b>qgroup</b>
 
<dd>
 
<p>
 
        Manage quota group(qgroup) for btrfs filesystem.<br/>
 
        See [[Manpage/btrfs-qgroup|btrfs-qgroup(8)]] for details.
 
</p>
 
 
<dt>
 
<b>quota</b>
 
<dd>
 
<p>
 
        Manage quota on btrfs filesystem like enabling/rescan and etc.<br/>
 
        See [[Manpage/btrfs-quota|btrfs-quota(8)]] and [[Manpage/btrfs-qgroup|btrfs-qgroup(8)]] for details.
 
</p>
 
 
<dt>
 
<b>receive</b>
 
<dd>
 
<p>
 
        Receive subvolume data from stdin/file for restore and etc.<br/>
 
        See [[Manpage/btrfs-receive|btrfs-receive(8)]] for details.
 
</p>
 
 
<dt>
 
<b>replace</b>
 
<dd>
 
<p>
 
        Replace btrfs devices.<br/>
 
        See [[Manpage/btrfs-replace|btrfs-replace(8)]] for details.
 
</p>
 
 
<dt>
 
<b>rescue</b>
 
<dd>
 
<p>
 
        Try to rescue damaged btrfs filesystem.<br/>
 
        See [[Manpage/btrfs-rescue|btrfs-rescue(8)]] for details.
 
</p>
 
 
<dt>
 
<b>restore</b>
 
<dd>
 
<p>
 
        Try to restore files from a damaged btrfs filesystem.<br/>
 
        See [[Manpage/btrfs-restore|btrfs-restore(8)]] for details.
 
</p>
 
 
<dt>
 
<b>scrub</b>
 
<dd>
 
<p>
 
        Scrub a btrfs filesystem.<br/>
 
        See [[Manpage/btrfs-scrub|btrfs-scrub(8)]] for details.
 
</p>
 
 
<dt>
 
<b>send</b>
 
<dd>
 
<p>
 
        Send subvolume data to stdout/file for backup and etc.<br/>
 
        See [[Manpage/btrfs-send|btrfs-send(8)]] for details.
 
</p>
 
 
<dt>
 
<b>subvolume</b>
 
<dd>
 
<p>
 
        Create/delete/list/manage btrfs subvolume.<br/>
 
        See [[Manpage/btrfs-subvolume|btrfs-subvolume(8)]] for details.
 
</p>
 
 
</dl>
 
==STANDALONE TOOLS==
 
 
<p>New functionality could be provided using a standalone tool. If the functionality
 
proves to be useful, then the standalone tool is declared obsolete and its
 
functionality is copied to the main tool. Obsolete tools are removed after a
 
long (years) depreciation period.</p>
 
<p>Tools that are still in active use without an equivalent in <b>btrfs</b>:</p>
 
<dl>
 
<dt>
 
<b>btrfs-convert</b>
 
<dd>
 
<p>
 
in-place conversion from ext2/3/4 filesystems to btrfs
 
</p>
 
 
<dt>
 
<b>btrfstune</b>
 
<dd>
 
<p>
 
tweak some filesystem properties on a unmounted filesystem
 
</p>
 
 
<dt>
 
<b>btrfs-select-super</b>
 
<dd>
 
<p>
 
rescue tool to overwrite primary superblock from a spare copy
 
</p>
 
 
<dt>
 
<b>btrfs-find-root</b>
 
<dd>
 
<p>
 
rescue helper to find tree roots in a filesystem
 
</p>
 
 
</dl>
 
<p>Deprecated and obsolete tools:</p>
 
<dl>
 
<dt>
 
<b>btrfs-debug-tree</b>
 
<dd>
 
<p>
 
moved to <b>btrfs inspect-internal dump-tree</b>. Removed from
 
source distribution.
 
</p>
 
 
<dt>
 
<b>btrfs-show-super</b>
 
<dd>
 
<p>
 
moved to <b>btrfs inspect-internal dump-super</b>, standalone
 
removed.
 
</p>
 
 
<dt>
 
<b>btrfs-zero-log</b>
 
<dd>
 
<p>
 
moved to <b>btrfs rescue zero-log</b>, standalone removed.
 
</p>
 
 
</dl>
 
<p>For space-constrained environments, it&#8217;s possible to build a single binary with
 
functionality of several standalone tools. This is following the concept of
 
busybox where the file name selects the functionality. This works for symlinks
 
or hardlinks. The full list can be obtained by <b>btrfs help --box</b>.</p>
 
==EXIT STATUS==
 
 
<p><b>btrfs</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/btrfs|btrfs(5)]],
 
[[Manpage/btrfs-balance|btrfs-balance(8)]],
 
[[Manpage/btrfs-check|btrfs-check(8)]],
 
[[Manpage/btrfs-convert|btrfs-convert(8)]],
 
[[Manpage/btrfs-device|btrfs-device(8)]],
 
[[Manpage/btrfs-filesystem|btrfs-filesystem(8)]],
 
[[Manpage/btrfs-inspect-internal|btrfs-inspect-internal(8)]],
 
[[Manpage/btrfs-property|btrfs-property(8)]],
 
[[Manpage/btrfs-qgroup|btrfs-qgroup(8)]],
 
[[Manpage/btrfs-quota|btrfs-quota(8)]],
 
[[Manpage/btrfs-receive|btrfs-receive(8)]],
 
[[Manpage/btrfs-replace|btrfs-replace(8)]],
 
[[Manpage/btrfs-rescue|btrfs-rescue(8)]],
 
[[Manpage/btrfs-restore|btrfs-restore(8)]],
 
[[Manpage/btrfs-scrub|btrfs-scrub(8)]],
 
[[Manpage/btrfs-send|btrfs-send(8)]],
 
[[Manpage/btrfs-subvolume|btrfs-subvolume(8)]],
 
[[Manpage/btrfstune|btrfstune(8)]],
 
[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]]</p>
 
[[Category:Manpage]]
 

Latest revision as of 12:27, 12 January 2022

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


Personal tools