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

   1 .TH bcacheadm 8
   2 .SH NAME
   3 bcacheadm \- manage bcache devices
   4
   5 .SH  SYNOPSIS
   6 .B bcacheadm
   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 bcache 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/bcache.
  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 bcacheadm commands
  55 .RE
  56
  57 .SH OPTIONS
  58 .SH Options for bcacheadm
  59 .TP
  60 .BR \--help
  61
  62
  63 .SH Options for format
  64 .TP
  65 .BR \-C
  66 Create a cache
  67 .TP
  68 .BR \-B
  69 Create a backing device
  70 .TP
  71 .BR \-b\ --bucket-size=
  72 Specifies the bucket size.
  73 .TP
  74 .BR \-l\ --label=
  75 label
  76 .TP
  77 .BR \-w,\ --block=
  78 block size (hard sector size of SSD, often 2k
  79 .TP
  80 .BR \-t,\ --tier=
  81 tier of subsequent devices
  82 .TP
  83 .BR \--cache-replacement-policy=
  84 one of lru, fifo, or random
  85 .TP
  86 .BR \-o,\ --data_offset=
  87 data offset in sectors
  88 .TP
  89 .BR \--cset-uuid=
  90 Create a cache device with the specified UUID
  91 .TP
  92 .BR \--csum_type=
  93 One of none, csc32c, or csc64
  94 .TP
  95 .BR \--meta-replicas=
  96 Number of metadata replicas
  97 .TP
  98 .BR \--data-replicas=
  99 Number of data replicas
 100 .TP
 101 .BR \--wipe-bcache
 102 Destroy existing bcache data if present
 103 .TP
 104 .BR \--discard
 105 Enable discards
 106 .TP
 107 .BR \--writeback
 108 Enable writeback
 109
 110 .SH Options for register
 111
 112 .SH Options for list-cachesets
 113 .TP
 114 .BR \-d,\ --dir=
 115 Provide a directory other than /sys/fs/bcache
 116
 117 .SH Options for query-devs
 118 .TP
 119 .BR \-f,\ --force-csum
 120 Enables bcacheadm to going even if the superblock crc is invalid
 121
 122 .SH Options for status
 123
 124 .SH Options for stats
 125 .TP
 126 .BR \-a,\ --all
 127 List all stats and their values for the given device.
 128 .TP
 129 .BR \-l,\ --list
 130 List the names of the different stats for the given device.
 131 .TP
 132 .BR \-u,\ --set=
 133 UUID for the cacheset
 134 .TP
 135 .BR \-d,\ --dev=
 136 UUID for a device within the cacheset. Must pass in the cacheset UUID in order to search for a dev.
 137 .TP
 138 .BR \-c,\ --cache=
 139 Cache number, starts from 0
 140 .TP
 141 .BR \--five-min-stats
 142 stats accumulated in the last 5 minutes
 143 .TP
 144 .BR \--hour-stats
 145 stats accumulated in the last hour
 146 .TP
 147 .BR \--day-stats
 148 stats accumulated in the last day
 149 .TP
 150 .BR \--total-stats
 151 stats accumulated in total