'\" t
.\"     Title: btrfs-property
.\"    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\-PROPERTY" "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-property \- get/set/list properties for given btrfs object\&.
.SH "SYNOPSIS"
.sp
\fBbtrfs property\fR \fI<subcommand>\fR \fI<args>\fR
.SH "DESCRIPTION"
.sp
\fBbtrfs property\fR is used to get/set/list property, like lable or compression state, for given btrfs object\&.
.sp
\fBbtrfs property\fR provides an unified and user\-friendly method to tune different btrfs properties instead of using the traditional method like \fBchattr\fR(1) or \fBlsattr\fR(1)\&.
.SH "SUBCOMMAND"
.PP
\fBget\fR [\-t \fI<type>\fR] \fI<object>\fR [\fI<name>\fR]
.RS 4
Gets a property from a btrfs object\&.
.sp
If no name is specified, all properties for the given object are printed\&. A filesystem object can be a the filesystem itself, a subvolume, an inode or a device\&.
.sp
The
\fI\-t \*(Aq<type>\fR\*(Aq option 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\&.
.sp
Possible types are
\fIs[ubvol]\fR,
\fIf[ilesystem]\fR,
\fIi[node]\fR
and
\fId[evice]\fR\&.
.sp
The
\fI<object>\fR
can be path of btrfs device, btrfs mount point, or any directories/files inside btrfs\&.
.RE
.PP
\fBset\fR [\-t \fI<type>\fR] \fI<object>\fR \fI<name>\fR \fI<value>\fR
.RS 4
Sets a property on a btrfs object\&.
.sp
See description of
\fBget\fR
subcommand for a description of objects and object types\&.
.RE
.PP
\fBlist\fR [\-t \fI<type>\fR] \fI<object>\fR
.RS 4
Lists available properties with their descriptions for the given object\&.
.sp
Please see the help of
\fBbtrfs property get\fR
for a description of objects and object types\&.
.RE
.SH "EXIT STATUS"
.sp
\fBbtrfs property\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), \fBlsattr\fR(1), \fBchattr\fR(1)