Documentation/btrfs-property.asciidoc

   1 btrfs-property(8)
   2 =================
   3
   4 NAME
   5 ----
   6 btrfs-property - get/set/list properties for given filesystem object
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs property* <subcommand> <args>
  11
  12 DESCRIPTION
  13 -----------
  14 *btrfs property* is used to get/set/list property for given filesystem object.
  15 The object can be an inode (file or directory), subvolume or the whole
  16 filesystem.  See the description of *get* subcommand for more information about
  17 both btrfs object and property.
  18
  19 *btrfs property* provides an unified and user-friendly method to tune different
  20 btrfs properties instead of using the traditional method like `chattr`(1) or
  21 `lsattr`(1).
  22
  23 SUBCOMMAND
  24 ----------
  25 *get* [-t <type>] <object> [<name>]::
  26 get property from a btrfs <object> of given <type>
  27 +
  28 A btrfs object, which is set by <object>, can be a btrfs filesystem
  29 itself, a btrfs subvolume, an inode (file or directory) inside btrfs,
  30 or a device on which a btrfs exists.
  31 +
  32 The option '-t' can be used to explicitly
  33 specify what type of object you meant. This is only needed when a
  34 property could be set for more then one object type.
  35 +
  36 Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]', where
  37 the first lettes is a shortcut.
  38 +
  39 Set the name of property by 'name'. If no 'name' is specified,
  40 all properties for the given object are printed. 'name' is one of
  41 the following:
  42
  43 ro::::
  44 read-only flag of subvolume: true or false
  45 label::::
  46 label of device
  47 compression::::
  48 compression algorithm set for an inode, possible values: 'lzo', 'zlib', 'zstd'.
  49 To disable compression use "" (empty string), 'no' or 'none'.
  50
  51 *list* [-t <type>] <object>::
  52 Lists available properties with their descriptions for the given object.
  53 +
  54 See the description of *get* subcommand for the meaning of each option.
  55
  56 *set* [-t <type>] <object> <name> <value>::
  57 Sets a property on a btrfs object.
  58 +
  59 See the description of *get* subcommand for the meaning of each option.
  60
  61 EXIT STATUS
  62 -----------
  63 *btrfs property* returns a zero exit status if it succeeds. Non zero is
  64 returned in case of failure.
  65
  66 AVAILABILITY
  67 ------------
  68 *btrfs* is part of btrfs-progs.
  69 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  70 further details.
  71
  72 SEE ALSO
  73 --------
  74 `mkfs.btrfs`(8),
  75 `lsattr`(1),
  76 `chattr`(1)