# BTRFS-PROPERTY - get/set/list properties for given filesystem object - man(8) - [phpMan]

[_BTRFS-PROPERTY_(8)](https://www.chedong.com/phpMan.php/man/BTRFS-PROPERTY/8/markdown)                               BTRFS                              [_BTRFS-PROPERTY_(8)](https://www.chedong.com/phpMan.php/man/BTRFS-PROPERTY/8/markdown)

## NAME
       btrfs-property - get/set/list properties for given filesystem object

## SYNOPSIS
       **btrfs property **<subcommand> <args>

## DESCRIPTION
       **btrfs  property **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.

       **btrfs property **provides an unified and user-friendly method to tune different  btrfs  proper‐
       ties instead of using the traditional method like [**chattr(1)](https://www.chedong.com/phpMan.php/man/chattr/1/markdown) **or [**lsattr(1)](https://www.chedong.com/phpMan.php/man/lsattr/1/markdown)**.

### Object types
       A  property  might  apply  to several object types so in some cases it's necessary to specify
       that explicitly, however it's not needed in the most common case of files and directories.

       The subcommands take parameter _-t_, use first letter as a shortcut (_f/s/d/i_) of the type:

       • filesystem

       • subvolume

       • device

       • inode (file or directory)

### Inode properties
### compression
              compression algorithm set for an inode (it's not possible to set the compression level
              this way), possible values:

              • _lzo_

              • _zlib_

              • _zstd_

              • _no_ or _none_ - disable compression (equivalent to **chattr +m**)

              • _""_ (empty string) - set the default value

                   **NOTE:**
                       This has changed in version 5.18 of btrfs-progs and requires kernel  5.14  or
                       newer to work.

### Subvolume properties
       **ro     **read-only flag of subvolume: true or false. Please also see section _SUBVOLUME_ _FLAGS_ in
              [_btrfs-subvolume(8)](https://www.chedong.com/phpMan.php/man/btrfs-subvolume/8/markdown)_ for possible implications regarding incremental send.

### Filesystem properties
       **label  **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.

## SUBCOMMAND
### get [-t <type>] <object> [<name>]
              Read  value of a property _name_ of btrfs _object_ of given _type_, empty _name_ will read all
              of them

### list [-t <type>] <object>
              List available properties with their descriptions for the given object.

### set [-f] [-t <type>] <object> <name> <value>
              Set _value_ of property _name_ on a given btrfs object.

              **Options**

              **-f     **Force the change. Changing some properties may involve safety checks  or  addi‐
                     tional changes that depend on the properties semantics.

## EXAMPLES
       Set compression on a file:

          $ touch file1
          $ btrfs prop get file1
          [ empty output ]
          $ btrfs prop set file1 compression zstd
          $ btrfs prop get file1
          compression=zstd

       Make a writeable subvolume read-only:

          $ btrfs subvol create subvol1
          [ fill subvol1 with data ]
          $ btrfs prop get subvol1
          ro=false
          $ btrfs prop set subvol1 ro true
          ro=true

## EXIT STATUS
       **btrfs  property  **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    documentation    at
       _<https://btrfs.readthedocs.io_>.

## SEE ALSO
       [_mkfs.btrfs(8)](https://www.chedong.com/phpMan.php/man/mkfs.btrfs/8/markdown)_, [**lsattr(1)](https://www.chedong.com/phpMan.php/man/lsattr/1/markdown)**, [**chattr(1)](https://www.chedong.com/phpMan.php/man/chattr/1/markdown)**


6.6.3                                       Mar 31, 2024                           [_BTRFS-PROPERTY_(8)](https://www.chedong.com/phpMan.php/man/BTRFS-PROPERTY/8/markdown)