Documentation/makefile work

[bcachefs-tools-debian] / bcache.8

diff --git a/bcache.8 b/bcache.8
index 52c5fe741f3ebb78327f57ef762045879e5ce906..7671cf313da0b86b6959b4489ef47ee5a4f076df 100644 (file)
--- a/bcache.8
+++ b/bcache.8
@@ -1,9 +1,9 @@
-.TH bcacheadm 8
+.TH bcache 8
 .SH NAME
-bcacheadm \- manage bcache devices
+bcache \- manage bcache filesystems/devices
 
 .SH  SYNOPSIS
-.B bcacheadm
+.B bcache
 [\fIoptions\fR]
 .B COMMAND
 [\fIoptions\fR]
@@ -51,61 +51,63 @@ to create the /dev/disk/by-uuid symlink.
 
 .BR help
 .RS
-List the bcacheadm commands
+List the bcache commands
 .RE
 
 .SH OPTIONS
-.SH Options for bcacheadm
+.SH Options for bcache
 .TP
 .BR \--help
 
 
 .SH Options for format
+.SH Global options:
 .TP
-.BR \-C
-Create a cache
+.BR \-w,\ --block=
+block size, in bytes (e.g. 4k)
 .TP
-.BR \-B
-Create a backing device
+.BR \-w,\ --btree_node_size=
+btree node size in bytes - default 256k
 .TP
-.BR \-b\ --bucket-size=
-Specifies the bucket size.
+.BR \--metadata_checksum_type=TYPE
 .TP
-.BR \-l\ --label=
-label
+.BR \--data_checksum_type=TYPE
+where TYPE is one of none, crc32c (default), or crc64
 .TP
-.BR \-w,\ --block=
-block size (hard sector size of SSD, often 2k
+.BR \--compression_type=TYPE
+where TYPE is one of none (default), lz4 or gzip
 .TP
-.BR \-t,\ --tier=
-tier of subsequent devices
+.BR \--encrypted
+Enable encryption; passphrase will be prompted for
 .TP
-.BR \--cache-replacement-policy=
-one of lru, fifo, or random
+.BR \--error_action=TYPE
+where TYPE is one of continue, readonly (default) or panic
 .TP
-.BR \-o,\ --data_offset=
-data offset in sectors
+.BR \-l\ --label=LABEL
+Create the filesystem with the specified label
 .TP
-.BR \--cset-uuid=
-Create a cache device with the specified UUID
+.BR \--uuid=UUID
+Create the filesystem with the specified UUID
 .TP
-.BR \--csum_type=
-One of none, csc32c, or csc64
+.BR \--force
+Force the filesystem to be created, even if the device already contains a
+filesystem
+
+.SH Options that apply to subsequent devices:
 .TP
-.BR \--meta-replicas=
-Number of metadata replicas
+.BR \--fs_size=SIZE
+Create the filesystem using SIZE bytes on the subsequent device
 .TP
-.BR \--data-replicas=
-Number of data replicas
+.BR \-b\ --bucket-size=SIZE
+Specifies the bucket size - must be greater than the btree node size
 .TP
-.BR \--wipe-bcache
-Destroy existing bcache data if present
+.BR \-t,\ --tier=INDEX
+Specifies the tier of subsequent devices, where INDEX is a small integer and a
+smaller index indicates a faster tier - tier 0 being the fastest. Currently only
+two tiers are supported.
 .TP
 .BR \--discard
-Enable discards
-.TP
-.BR \--writeback
-Enable writeback
+Enable discards on subsequent devices
 
 .SH Options for register
 
@@ -117,7 +119,7 @@ Provide a directory other than /sys/fs/bcache
 .SH Options for query-devs
 .TP
 .BR \-f,\ --force-csum
-Enables bcacheadm to going even if the superblock crc is invalid
+Enables bcache to going even if the superblock crc is invalid
 
 .SH Options for status