git.sesse.net Git - bcachefs-tools-debian/blob - bcachefs.8

   1 .TH bcachefs 8
   2 .SH NAME
   3 bcachefs \- manage bcachefs filesystems/devices
   4
   5 .SH  SYNOPSIS
   6 .B bcachefs
   7 [\fIoptions\fR]
   8 .B COMMAND
   9 [\fIoptions\fR]
  10
  11 .SH COMMANDS
  12 .TP
  13 .BR format
  14 .RS
  15 Format one or a list of devices with bcachefs data structures. You need to do this before you create a volume.
  16 .RE
  17
  18 .BR register
  19 .RS
  20 Register a list of devices.
  21 .RE
  22
  23 .BR list-cachesets
  24 .RS
  25 List cachesets on this system. This just searches /sys/fs/bcachefs.
  26 .RE
  27
  28 .BR query-devs
  29 .RS
  30 Gives info about the superblock for a list of devices.
  31 .RE
  32
  33 .BR status
  34 .RS
  35 Finds the status of the most up to date superblock in each tier. Pass in a list of devices.
  36 .RE
  37
  38 .BR stats
  39 .RS
  40 List bcache specific statistics. Use --list to find out exactly what these are. To list stats for a cacheset, just give the cacheset uuid. To target a cache within the cacheset, use the -c option. To get time interval stats, use the hour, day, etc, options.
  41 .RE
  42
  43 .BR probe
  44 .RS
  45 Return UUID if device identified as bcache-formatted.
  46 .PP
  47 Only necessary until support for the bcache superblock is included
  48 in blkid; in the meantime, provides just enough functionality for a udev script
  49 to create the /dev/disk/by-uuid symlink.
  50 .RE
  51
  52 .BR help
  53 .RS
  54 List the bcache commands
  55 .RE
  56
  57 .SH OPTIONS
  58 .SH Options for bcache
  59 .TP
  60 .BR \--help
  61
  62
  63 .SH Options for format
  64 .SH Global options:
  65 .TP
  66 .BR \-w,\ --block=
  67 block size, in bytes (e.g. 4k)
  68 .TP
  69 .BR \-w,\ --btree_node_size=
  70 btree node size in bytes - default 256k
  71 .TP
  72 .BR \--metadata_checksum_type=TYPE
  73 .TP
  74 .BR \--data_checksum_type=TYPE
  75 where TYPE is one of none, crc32c (default), or crc64
  76 .TP
  77 .BR \--compression_type=TYPE
  78 where TYPE is one of none (default), lz4 or gzip
  79 .TP
  80 .BR \--encrypted
  81 Enable encryption; passphrase will be prompted for
  82 .TP
  83 .BR \--error_action=TYPE
  84 where TYPE is one of continue, readonly (default) or panic
  85 .TP
  86 .BR \-l\ --label=LABEL
  87 Create the filesystem with the specified label
  88 .TP
  89 .BR \--uuid=UUID
  90 Create the filesystem with the specified UUID
  91 .TP
  92 .BR \--force
  93 Force the filesystem to be created, even if the device already contains a
  94 filesystem
  95
  96 .SH Options that apply to subsequent devices:
  97 .TP
  98 .BR \--fs_size=SIZE
  99 Create the filesystem using SIZE bytes on the subsequent device
 100 .TP
 101 .BR \-b\ --bucket-size=SIZE
 102 Specifies the bucket size - must be greater than the btree node size
 103 .TP
 104 .BR \-t,\ --tier=INDEX
 105 Specifies the tier of subsequent devices, where INDEX is a small integer and a
 106 smaller index indicates a faster tier - tier 0 being the fastest. Currently only
 107 two tiers are supported.
 108 .TP
 109 .BR \--discard
 110 Enable discards on subsequent devices
 111
 112 .SH Options for register
 113
 114 .SH Options for list-cachesets
 115 .TP
 116 .BR \-d,\ --dir=
 117 Provide a directory other than /sys/fs/bcache
 118
 119 .SH Options for query-devs
 120 .TP
 121 .BR \-f,\ --force-csum
 122 Enables bcache to going even if the superblock crc is invalid
 123
 124 .SH Options for status
 125
 126 .SH Options for stats
 127 .TP
 128 .BR \-a,\ --all
 129 List all stats and their values for the given device.
 130 .TP
 131 .BR \-l,\ --list
 132 List the names of the different stats for the given device.
 133 .TP
 134 .BR \-u,\ --set=
 135 UUID for the cacheset
 136 .TP
 137 .BR \-d,\ --dev=
 138 UUID for a device within the cacheset. Must pass in the cacheset UUID in order to search for a dev.
 139 .TP
 140 .BR \-c,\ --cache=
 141 Cache number, starts from 0
 142 .TP
 143 .BR \--five-min-stats
 144 stats accumulated in the last 5 minutes
 145 .TP
 146 .BR \--hour-stats
 147 stats accumulated in the last hour
 148 .TP
 149 .BR \--day-stats
 150 stats accumulated in the last day
 151 .TP
 152 .BR \--total-stats
 153 stats accumulated in total