Manpage/btrfs

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Update from git, v4.5.3)
(Update from git, v4.5.3)
Line 1: Line 1:
=btrfs(8)=
+
=btrfs(8) manual page=
 
{{GeneratedManpage
 
{{GeneratedManpage
 
|name=btrfs}}
 
|name=btrfs}}
Line 8: Line 8:
 
==SYNOPSIS==
 
==SYNOPSIS==
  
<p><b>btrfs</b> <emphasis>&lt;command&gt;</emphasis> [<emphasis>&lt;args&gt;</emphasis>]</p>
+
<p><b>btrfs</b> <em>&lt;command&gt;</em> [<em>&lt;args&gt;</em>]</p>
 
==DESCRIPTION==
 
==DESCRIPTION==
  
Line 18: Line 18:
 
<p>Any command name can be shortened as far as it stays unambiguous,
 
<p>Any command name can be shortened as far as it stays unambiguous,
 
however it is recommended to use full command names in scripts.
 
however it is recommended to use full command names in scripts.
All command groups have their manual page named <b>btrfs-<emphasis>&lt;group&gt;</emphasis></b>.</p>
+
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
 
<p>For example: it is possible to run <b>btrfs sub snaps</b> instead of
 
<b>btrfs subvolume snapshot</b>.
 
<b>btrfs subvolume snapshot</b>.
Line 34: Line 34:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Balance btrfs filesystem chunks across single or several devices.<text:line-break/>
+
         Balance btrfs filesystem chunks across single or several devices.<br/>
 
         See [[Manpage/btrfs-balance|btrfs-balance(8)]] for details.
 
         See [[Manpage/btrfs-balance|btrfs-balance(8)]] for details.
 
</p>
 
</p>
Line 42: Line 42:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Do off-line check on a btrfs filesystem.<text:line-break/>
+
         Do off-line check on a btrfs filesystem.<br/>
 
         See [[Manpage/btrfs-check|btrfs-check(8)]] for details.
 
         See [[Manpage/btrfs-check|btrfs-check(8)]] for details.
 
</p>
 
</p>
Line 51: Line 51:
 
<p>
 
<p>
 
         Manage devices managed by btrfs, including add/delete/scan and so
 
         Manage devices managed by btrfs, including add/delete/scan and so
         on.<text:line-break/>
+
         on.<br/>
 
         See [[Manpage/btrfs-device|btrfs-device(8)]] for details.
 
         See [[Manpage/btrfs-device|btrfs-device(8)]] for details.
 
</p>
 
</p>
Line 59: Line 59:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Manage a btrfs filesystem, including label setting/sync and so on.<text:line-break/>
+
         Manage a btrfs filesystem, including label setting/sync and so on.<br/>
 
         See [[Manpage/btrfs-filesystem|btrfs-filesystem(8)]] for details.
 
         See [[Manpage/btrfs-filesystem|btrfs-filesystem(8)]] for details.
 
</p>
 
</p>
Line 67: Line 67:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Debug tools for developers/hackers.<text:line-break/>
+
         Debug tools for developers/hackers.<br/>
 
         See [[Manpage/btrfs-inspect-internal|btrfs-inspect-internal(8)]] for details.
 
         See [[Manpage/btrfs-inspect-internal|btrfs-inspect-internal(8)]] for details.
 
</p>
 
</p>
Line 75: Line 75:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Get/set a property from/to a btrfs object.<text:line-break/>
+
         Get/set a property from/to a btrfs object.<br/>
 
         See [[Manpage/btrfs-property|btrfs-property(8)]] for details.
 
         See [[Manpage/btrfs-property|btrfs-property(8)]] for details.
 
</p>
 
</p>
Line 83: Line 83:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Manage quota group(qgroup) for btrfs filesystem.<text:line-break/>
+
         Manage quota group(qgroup) for btrfs filesystem.<br/>
 
         See [[Manpage/btrfs-qgroup|btrfs-qgroup(8)]] for details.
 
         See [[Manpage/btrfs-qgroup|btrfs-qgroup(8)]] for details.
 
</p>
 
</p>
Line 91: Line 91:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Manage quota on btrfs filesystem like enabling/rescan and etc.<text:line-break/>
+
         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.
 
         See [[Manpage/btrfs-quota|btrfs-quota(8)]] and [[Manpage/btrfs-qgroup|btrfs-qgroup(8)]] for details.
 
</p>
 
</p>
Line 99: Line 99:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Receive subvolume data from stdin/file for restore and etc.<text:line-break/>
+
         Receive subvolume data from stdin/file for restore and etc.<br/>
 
         See [[Manpage/btrfs-receive|btrfs-receive(8)]] for details.
 
         See [[Manpage/btrfs-receive|btrfs-receive(8)]] for details.
 
</p>
 
</p>
Line 107: Line 107:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Replace btrfs devices.<text:line-break/>
+
         Replace btrfs devices.<br/>
 
         See [[Manpage/btrfs-replace|btrfs-replace(8)]] for details.
 
         See [[Manpage/btrfs-replace|btrfs-replace(8)]] for details.
 
</p>
 
</p>
Line 115: Line 115:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Try to rescue damaged btrfs filesystem.<text:line-break/>
+
         Try to rescue damaged btrfs filesystem.<br/>
 
         See [[Manpage/btrfs-rescue|btrfs-rescue(8)]] for details.
 
         See [[Manpage/btrfs-rescue|btrfs-rescue(8)]] for details.
 
</p>
 
</p>
Line 123: Line 123:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Try to restore files from a damaged btrfs filesystem.<text:line-break/>
+
         Try to restore files from a damaged btrfs filesystem.<br/>
 
         See [[Manpage/btrfs-restore|btrfs-restore(8)]] for details.
 
         See [[Manpage/btrfs-restore|btrfs-restore(8)]] for details.
 
</p>
 
</p>
Line 131: Line 131:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Scrub a btrfs filesystem.<text:line-break/>
+
         Scrub a btrfs filesystem.<br/>
 
         See [[Manpage/btrfs-scrub|btrfs-scrub(8)]] for details.
 
         See [[Manpage/btrfs-scrub|btrfs-scrub(8)]] for details.
 
</p>
 
</p>
Line 139: Line 139:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Send subvolume data to stdout/file for backup and etc.<text:line-break/>
+
         Send subvolume data to stdout/file for backup and etc.<br/>
 
         See [[Manpage/btrfs-send|btrfs-send(8)]] for details.
 
         See [[Manpage/btrfs-send|btrfs-send(8)]] for details.
 
</p>
 
</p>
Line 147: Line 147:
 
<dd>
 
<dd>
 
<p>
 
<p>
         Create/delete/list/manage btrfs subvolume.<text:line-break/>
+
         Create/delete/list/manage btrfs subvolume.<br/>
 
         See [[Manpage/btrfs-subvolume|btrfs-subvolume(8)]] for details.
 
         See [[Manpage/btrfs-subvolume|btrfs-subvolume(8)]] for details.
 
</p>
 
</p>

Revision as of 10:34, 20 May 2016

Contents

btrfs(8) manual page

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



NAME

btrfs - control a btrfs filesystem

SYNOPSIS

btrfs <command> [<args>]

DESCRIPTION

The btrfs 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 COMMANDS.

COMMAND SYNTAX

Any command name can be shortened as far as it stays unambiguous, however it is recommended to use full command names in scripts. All command groups have their manual page named btrfs-<group>.

For example: it is possible to run btrfs sub snaps instead of btrfs subvolume snapshot. But btrfs file s is not allowed, because file s may be interpreted both as filesystem show and as filesystem sync.

If the command name is ambiguous, the list of conflicting options is printed.

For an overview of a given command use btrfs command --help or btrfs [command…] --help --full to print all available options.

COMMANDS

balance

Balance btrfs filesystem chunks across single or several devices.
See btrfs-balance(8) for details.

check

Do off-line check on a btrfs filesystem.
See btrfs-check(8) for details.

device

Manage devices managed by btrfs, including add/delete/scan and so on.
See btrfs-device(8) for details.

filesystem

Manage a btrfs filesystem, including label setting/sync and so on.
See btrfs-filesystem(8) for details.

inspect-internal

Debug tools for developers/hackers.
See btrfs-inspect-internal(8) for details.

property

Get/set a property from/to a btrfs object.
See btrfs-property(8) for details.

qgroup

Manage quota group(qgroup) for btrfs filesystem.
See btrfs-qgroup(8) for details.

quota

Manage quota on btrfs filesystem like enabling/rescan and etc.
See btrfs-quota(8) and btrfs-qgroup(8) for details.

receive

Receive subvolume data from stdin/file for restore and etc.
See btrfs-receive(8) for details.

replace

Replace btrfs devices.
See btrfs-replace(8) for details.

rescue

Try to rescue damaged btrfs filesystem.
See btrfs-rescue(8) for details.

restore

Try to restore files from a damaged btrfs filesystem.
See btrfs-restore(8) for details.

scrub

Scrub a btrfs filesystem.
See btrfs-scrub(8) for details.

send

Send subvolume data to stdout/file for backup and etc.
See btrfs-send(8) for details.

subvolume

Create/delete/list/manage btrfs subvolume.
See btrfs-subvolume(8) for details.

EXIT STATUS

btrfs 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), ionice(1), btrfs-balance(8), btrfs-check(8), btrfs-device(8), btrfs-filesystem(8), btrfs-inspect-internal(8), btrfs-property(8), btrfs-qgroup(8), btrfs-quota(8), btrfs-receive(8), btrfs-replace(8), btrfs-rescue(8), btrfs-restore(8), btrfs-scrub(8), btrfs-send(8), btrfs-subvolume(8),

Personal tools