Documentation/btrfs-property.txt

   1 btrfs-property(8)
   2 =================
   3
   4 NAME
   5 ----
   6 btrfs-property - get/set/list properties for given btrfs object.
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs property* <subcommand> <args>
  11
  12 DESCRIPTION
  13 -----------
  14 *btrfs property* is used to get/set/list property, like lable or compression
  15 state, for given btrfs object.
  16
  17 *btrfs property* provides an unified and user-friendly method to tune different
  18 btrfs properties instead of using the traditional method like `chattr`(1) or
  19 `lsattr`(1).
  20
  21 SUBCOMMAND
  22 ----------
  23 *get* [-t <type>] <object> [<name>]::
  24 Gets a property from a btrfs object.
  25 +
  26 If no name is specified, all properties for the given object are
  27 printed.
  28 A filesystem object can be a the filesystem itself, a subvolume,
  29 an inode or a device.
  30 +
  31 The '-t <type>' option can be used to explicitly
  32 specify what type of object you meant. This is only needed when a
  33 property could be set for more then one object type.
  34 +
  35 Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]'.
  36 +
  37 The <object> can be path of btrfs device, btrfs mount point, or any
  38 directories/files inside btrfs.
  39
  40 *set* [-t <type>] <object> <name> <value>::
  41 Sets a property on a btrfs object.
  42 +
  43 See description of *get* subcommand for a description of objects and object
  44 types.
  45
  46 *list* [-t <type>] <object>::
  47 Lists available properties with their descriptions for the given object.
  48 +
  49 Please see the help of *btrfs property get* for a description of
  50 objects and object types.
  51
  52 EXIT STATUS
  53 -----------
  54 *btrfs property* returns a zero exist status if it succeeds. Non zero is
  55 returned in case of failure.
  56
  57 AVAILABILITY
  58 ------------
  59 *btrfs* is part of btrfs-progs.
  60 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  61 further details.
  62
  63 SEE ALSO
  64 --------
  65 `mkfs.btrfs`(8),
  66 `lsattr`(1),
  67 `setattr`(8)