'\" t
.\"     Title: btrfs
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 11/22/2014
.\"    Manual: Btrfs Manual
.\"    Source: Btrfs v3.17
.\"  Language: English
.\"
.TH "BTRFS" "8" "11/22/2014" "Btrfs v3\&.17" "Btrfs Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
btrfs \- control a btrfs filesystem
.SH "SYNOPSIS"
.sp
\fBbtrfs\fR \fI<command>\fR [\fI<args>\fR]
.SH "DESCRIPTION"
.sp
\fBbtrfs\fR is used to control the filesystem and the files and directories stored\&. It is the tool to create or destroy a snapshot or a subvolume for the filesystem, to defrag a file or a directory, flush the data to the disk, to resize the filesystem, to scan the device\&.
.sp
It is possible to abbreviate the commands unless the commands are ambiguous\&. For example: it is possible to run \fBbtrfs sub snaps\fR instead of \fBbtrfs subvolume snapshot\fR\&. But \fBbtrfs file s\fR is not allowed, because \fBfile s\fR may be interpreted both as \fBfilesystem show\fR and as \fBfilesystem sync\fR\&.
.sp
If a command is terminated by \fI\-\-help\fR, the detailed help is showed\&. If the passed command matches more commands, detailed help of all the matched commands is showed\&. For example \fBbtrfs dev \-\-help\fR shows the help of all \fBdevice\fR* commands\&.
.SH "COMMANDS"
.PP
\fBsubvolume\fR
.RS 4
Create/delete/list/manage btrfs subvolume\&.

See
\fBbtrfs\-subvolume\fR(8) for details\&.
.RE
.PP
\fBfilesystem\fR
.RS 4
Manage a btrfs filesystem, including label setting/sync and so on\&.

See
\fBbtrfs\-filesystem\fR(8) for details\&.
.RE
.PP
\fB[filesystem] balance\fR
.RS 4
Balance btrfs filesystem chunks across single or several devices\&.

See
\fBbtrfs\-balance\fR(8) for details\&.
.RE
.PP
\fBdevice\fR
.RS 4
Manage devices managed by btrfs, including add/delete/scan and so on\&.

See
\fBbtrfs\-device\fR(8) for details\&.
.RE
.PP
\fBscrub\fR
.RS 4
Scrub a btrfs filesystem\&.

See
\fBbtrfs\-scrub\fR(8) for details\&.
.RE
.PP
\fBcheck\fR
.RS 4
Do off\-line check on a btrfs filesystem\&.

See
\fBbtrfs\-check\fR(8) for details\&.
.RE
.PP
\fBrescue\fR
.RS 4
Try to rescue damaged btrfs filesystem\&.

See
\fBbtrfs\-rescue\fR(8) for details\&.
.RE
.PP
\fBrestore\fR
.RS 4
Manage a btrfs filesystem, including label setting/sync and so on\&.

See
\fBbtrfs\-restore\fR(8) for details\&.
.RE
.PP
\fBinspect\-internal\fR
.RS 4
Debug tools for developers/hackers\&.

See
\fBbtrfs\-inspect\-internal\fR(8) for details\&.
.RE
.PP
\fBsend\fR
.RS 4
Send subvolume data to stdout/file for backup and etc\&.

See
\fBbtrfs\-send\fR(8) for details\&.
.RE
.PP
\fBreceive\fR
.RS 4
Receive subvolume data from stdin/file for restore and etc\&.

See
\fBbtrfs\-receive\fR(8) for details\&.
.RE
.PP
\fBquota\fR
.RS 4
Manage quota on btrfs filesystem like enabling/rescan and etc\&.

See
\fBbtrfs\-quota\fR(8) and
\fBbtrfs\-qgroup\fR(8) for details\&.
.RE
.PP
\fBqgroup\fR
.RS 4
Manage quota group(qgroup) for btrfs filesystem\&.

See
\fBbtrfs\-qgroup\fR(8) for details\&.
.RE
.PP
\fBreplace\fR
.RS 4
Replace btrfs devices\&.

See
\fBbtrfs\-replace\fR(8) for details\&.
.RE
.SH "EXIT STATUS"
.sp
\fBbtrfs\fR returns a zero exit status if it succeeds\&. Non zero is returned in case of failure\&.
.SH "AVAILABILITY"
.sp
\fBbtrfs\fR is part of btrfs\-progs\&. Please refer to the btrfs wiki \m[blue]\fBhttp://btrfs\&.wiki\&.kernel\&.org\fR\m[] for further details\&.
.SH "SEE ALSO"
.sp
\fBmkfs\&.btrfs\fR(8), \fBionice\fR(1), \fBbtrfs\-subvolume\fR(8), \fBbtrfs\-filesystem\fR(8), \fBbtrfs\-balance\fR(8), \fBbtrfs\-device\fR(8), \fBbtrfs\-scrub\fR(8), \fBbtrfs\-check\fR(8), \fBbtrfs\-rescue\fR(8), \fBbtrfs\-restore\fR(8), \fBbtrfs\-inspect\-internal\fR(8), \fBbtrfs\-send\fR(8), \fBbtrfs\-receive\fR(8), \fBbtrfs\-quota\fR(8), \fBbtrfs\-qgroup\fR(8), \fBbtrfs\-replace\fR(8),