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

   1 .Dd November 17, 2023
   2 .Dt BCACHEFS 8 SMM
   3 .Os
   4 .Sh NAME
   5 .Nm bcachefs
   6 .Nd manage bcachefs filesystems/devices
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Ar command
  10 .Op Ar options
  11 .Op Ar arguments
  12 .Sh DESCRIPTION
  13 The
  14 .Nm
  15 utility supports the following subcommands,
  16 which are documented in detail below:
  17 .Ss Superblock commands
  18 .Bl -tag -width 18n -compact
  19 .It Ic format
  20 Format one or a list of devices with bcachefs data structures.
  21 .It Ic show-super
  22 Dump superblock information to stdout.
  23 .It Ic set-option
  24 Set a filesystem option
  25 .El
  26 .Ss Mount commands
  27 .Bl -tag -width 18n -compact
  28 .It Ic mount
  29 Mount a filesystem.
  30 .El
  31 .Ss Repair commands
  32 .Bl -tag -width 18n -compact
  33 .It Ic fsck
  34 Check an existing filesystem for errors.
  35 .El
  36 .Ss Commands for managing a running filesystem
  37 .Bl -tag -width 18n -compact
  38 .It Ic fs usage
  39 Show disk usage
  40 .El
  41 .Ss Commands for managing devices within a running filesystem
  42 .Bl -tag -width 22n -compact
  43 .It Ic device add
  44 Add a new device to an existing filesystem
  45 .It Ic device remove
  46 Remove a device from an existing filesystem
  47 .It Ic device online
  48 Re-add an existing member to a filesystem
  49 .It Ic device offline
  50 Take a device offline, without removing it
  51 .It Ic device evacuate
  52 Migrate data off of a specific device
  53 .It Ic device set-state
  54 Mark a device as failed
  55 .It Ic device resize
  56 Resize filesystem on a device
  57 .It Ic device resize-journal
  58 Resize journal on a device
  59 .El
  60 .Ss Commands for managing subvolumes and snapshots
  61 .Bl -tag -width 18n -compact
  62 .It Ic subvolume create
  63 Create a new subvolume
  64 .It Ic subvolume delete
  65 Delete an existing subvolume
  66 .It Ic subvolume snapshot
  67 Create a snapshot
  68 .El
  69 .Ss Commands for managing filesystem data
  70 .Bl -tag -width 18n -compact
  71 .It Ic data rereplicate
  72 Rereplicate degraded data
  73 .It Ic data job
  74 Kick off low level data jobs
  75 .El
  76 .Ss Commands for encryption
  77 .Bl -tag -width 18n -compact
  78 .It Ic unlock
  79 Unlock an encrypted filesystem prior to running/mounting
  80 .It Ic set-passphrase
  81 Change passphrase on an existing (unmounted) filesystem
  82 .It Ic remove-passphrase
  83 Remove passphrase on an existing (unmounted) filesystem
  84 .El
  85 .Ss Commands for migration
  86 .Bl -tag -width 18n -compact
  87 .It Ic migrate
  88 Migrate an existing filesystem to bcachefs, in place
  89 .It Ic migrate-superblock
  90 Add default superblock, after bcachefs migrate
  91 .El
  92 .Ss Commands for operating on files in a bcachefs filesystem
  93 .Bl -tag -width 18n -compact
  94 .It Ic setattr
  95 Set various per file attributes
  96 .El
  97 .Ss Commands for debugging
  98 .Bl -tag -width 18n -compact
  99 .It Ic dump
 100 Dump filesystem metadata to a qcow2 image
 101 .It Ic list
 102 List filesystem metadata in textual form
 103 .It Ic list_journal
 104 List contents of journal
 105 .El
 106 .Ss FUSE commands
 107 .Bl -tag -width 18n -compact
 108 .It Ic fusemount Mount a filesystem via FUSE
 109 .El
 110 .Ss Miscellaneous commands
 111 .Bl -tag -width 18n -compact
 112 .It Ic version
 113 Display the version of the invoked bcachefs tool
 114 .It Ic completions
 115 Generate shell completions
 116 .El
 117 .Sh Superblock commands
 118 .Bl -tag -width Ds
 119 .It Nm Ic format Oo Ar options Oc Ar devices\ ...
 120 Format one or a list of devices with bcachefs data structures.
 121 You need to do this before you create a volume.
 122 .Pp
 123 Device specific options must come before corresponding devices, e.g.
 124 .Dl bcachefs format --label=ssd /dev/sda --label=hdd /dev/sdb
 125 .Bl -tag -width Ds
 126 .It Fl -block_size Ns = Ns Ar size
 127 block size, in bytes (e.g. 4k)
 128 .It Fl -btree_node_size Ns = Ns Ar size
 129 Btree node size, default 256k
 130 .It Fl -errors Ns = Ns ( Cm continue | ro | panic )
 131 Action to take on filesystem error
 132 .It Fl -data_replicas Ns = Ns Ar number
 133 Number of data replicas
 134 .It Fl -metadata_replicas Ns = Ns Ar number
 135 Number of metadata replicas
 136 .It Fl -data_replicas_required Ns = Ns Ar number
 137
 138 .It Fl -metadata_replicas_required Ns = Ns Ar number
 139
 140 .It Fl -encoded_extent_max Ns = Ns Ar size
 141 Maximum size of checksummed/compressed extents
 142 .It Fl -metadata_checksum Ns = Ns ( Cm none | crc32c | crc64 | xxhash )
 143 Set metadata checksum type (default:
 144 .Cm crc32c ) .
 145 .It Fl -data_checksum Ns = Ns ( Cm none | crc32c | crc64 | xxhash )
 146 Set data checksum type (default:
 147 .Cm crc32c ) .
 148 .It Fl -compression Ns = Ns ( Cm none | lz4 | gzip | zstd )
 149 Set compression type (default:
 150 .Cm none ) .
 151 .It Fl -background_compression Ns = Ns ( Cm none | lz4 | gzip | zstd )
 152
 153 .It Fl -str_hash Ns = Ns ( Cm crc32c | crc64 | siphash )
 154 Hash function for directory entries and xattrs
 155 .It Fl -metadata_target Ns = Ns Ar target
 156 Device or label for metadata writes
 157 .It Fl -foreground_target Ns = Ns Ar target
 158 Device or label for foreground writes
 159 .It Fl -background_target Ns = Ns Ar target
 160 Device or label to move data to in the background
 161 .It Fl -promote_target Ns = Ns Ar target
 162 Device or label to promote data to on read
 163 .It Fl -erasure_code
 164 Enable erasure coding (DO NOT USE YET)
 165 .It Fl -inodes_32bit
 166 Constrain inode numbers to 32 bits
 167 .It Fl -shared_inode_numbers
 168 Shared new inode numbers by CPU id
 169 .It Fl -inodes_use_key_cache
 170 Use the btree key cache for the inodes btree
 171 .It Fl -gc_reserve_percent Ns = Ns Ar percentage
 172 Percentage of disk space to reserve for copygc
 173 .It Fl -gc_reserve_bytes Ns = Ns Ar percentage
 174 Amount of disk space to reserve for copygc
 175 .sp
 176 This takes precedence over
 177 .Cm gc_reserve_percent
 178 if set
 179 .It Fl -root_reserve_percent Ns = Ns Ar percentage
 180 Percentage of disk space to reserve for superuser
 181 .It Fl -wide_macs
 182 Store full 128bits of cryptographic MACS, instead of 80
 183 .It Fl -acl
 184 Enable POSIX acls
 185 .It Fl -usrquota
 186 Enable user quotas
 187 .It Fl -grpquota
 188 Enable group quotas
 189 .It Fl prjquota
 190 Enable project quotas
 191 .It Fl -journal_transaction_names
 192 Log transaction function names in journal
 193 .It Fl -nocow
 194 Nocow mode: Writes will be done in place when possible.
 195 .sp
 196 Snapshots and reflink will still caused writes to be COW.
 197 .sp
 198 This flag implicitly disables data checksumming, compression and
 199 encryption.
 200 .It Fl -replicas Ns = Ns Ar number
 201 Sets both data and metadata replicas
 202 .It Fl -encrypted
 203 Enable whole filesystem encryption (chacha20/poly1305);
 204 passphrase will be prompted for.
 205 .It Fl -no_passphrase
 206 Don't encrypt master encryption key
 207 .It Fl L , Fl -fs_label Ns = Ns Ar label
 208 Create the filesystem with the specified
 209 .Ar label
 210 .It Fl U , -uuid Ns = Ns Ar uuid
 211 Create the filesystem with the specified
 212 .Ar uuid
 213 .It Fl -superblock_size Ns = Ns Ar size
 214
 215 .El
 216 .Pp
 217 Device specific options:
 218 .Bl -tag -width Ds
 219 .It Fl -discard
 220 Enable discard/TRIM support
 221 .It Fl -fs_size Ns = Ns Ar size
 222 Create the filesystem using
 223 .Ar size
 224 bytes on the subsequent device.
 225 .It Fl -bucket Ns = Ns Ar size
 226 Specifies the bucket size;
 227 must be greater than the btree node size
 228 .It Fl -durability Ns = Ns Ar n
 229 Data written to this device will be considered
 230 to have already been replicated
 231 .Ar n
 232 times
 233 .It Fl l , Fl -label
 234 Disk label
 235 .It Fl f , Fl -force
 236 Force the filesystem to be created,
 237 even if the device already contains a filesystem.
 238 .It Fl q , Fl -quiet
 239 Only print errors
 240 .It Fl v , Fl -verbose
 241 Verbose filesystem initialization
 242 .El
 243 .It Nm Ic show-super Oo Ar options Oc Ar device
 244 Dump superblock information to stdout.
 245 .Bl -tag -width Ds
 246 .It Fl f , Fl -fields Ns = Ns Ar fields
 247 List of sections to print
 248 .It Fl l , Fl -layout
 249 Print superblock layout
 250 .El
 251 .It Nm Ic set-option Oo Ar options Oc Ar device
 252 .Bl -tag -width Ds
 253 .It Fl -errors Ns = Ns ( Cm continue | ro | panic )
 254 Action to take on filesystem error
 255 .It Fl -metadata_replicas Ns = Ns Ar number
 256 Number of metadata replicas
 257 .It Fl -data_replicas Ns = Ns Ar number
 258 Number of data replicas
 259 .It Fl -metadata_replicas_required Ns = Ns Ar number
 260
 261 .It Fl -data_replicas_required Ns = Ns Ar number
 262
 263 .It Fl -metadata_checksum Ns = Ns ( Cm none | crc32c | crc64 | xxhash )
 264 Set metadata checksum type (default:
 265 .Cm crc32c ) .
 266 .It Fl -data_checksum Ns = Ns ( Cm none | crc32c | crc64 | xxhash )
 267 Set data checksum type (default:
 268 .Cm crc32c ) .
 269 .It Fl -compression Ns = Ns ( Cm none | lz4 | gzip | zstd )
 270 Set compression type (default:
 271 .Cm none ) .
 272 .It Fl -background_compression Ns = Ns ( Cm none | lz4 | gzip | zstd )
 273
 274 .It Fl -str_hash Ns = Ns ( Cm crc32c | crc64 | siphash )
 275 Hash function for directory entries and xattrs
 276 .It Fl -metadata_target Ns = Ns Ar target
 277 Device or label for metadata writes
 278 .It Fl -foreground_target Ns = Ns Ar target
 279 Device or label for foreground writes
 280 .It Fl -background_target Ns = Ns Ar target
 281 Device or label to move data to in the background
 282 .It Fl -promote_target Ns = Ns Ar target
 283 Device or label to promote data to on read
 284 .It Fl -erasure_code
 285 Enable erasure coding (DO NOT USE YET)
 286 .It Fl -inodes_32bit
 287 Constrain inode numbers to 32 bits
 288 .It Fl -shared_inode_numbers
 289 Shared new inode numbers by CPU id
 290 .It Fl -inodes_use_key_cache
 291 Use the btree key cache for the inodes btree
 292 .It Fl -gc_reserve_percent Ns = Ns Ar percentage
 293 Percentage of disk space to reserve for copygc
 294 .It Fl -gc_reserve_bytes Ns = Ns Ar percentage
 295 Amount of disk space to reserve for copygc
 296 .sp
 297 This takes precedence over
 298 .Cm gc_reserve_percent
 299 if set
 300 .It Fl -root_reserve_percent Ns = Ns Ar percentage
 301 Percentage of disk space to reserve for superuser
 302 .It Fl -wide_macs
 303 Store full 128bits of cryptographic MACS, instead of 80
 304 .It Fl -acl
 305 Enable POSIX acls
 306 .It Fl -usrquota
 307 Enable user quotas
 308 .It Fl -grpquota
 309 Enable group quotas
 310 .It Fl -prjquota
 311 Enable project quotas
 312 .It Fl -degraded
 313 Allow mounting in degraded mode
 314 .It Fl -very_degraded
 315 Allow mounting in when data will be missing
 316 .It Fl -discard
 317 Enable discard/TRIM support
 318 .It Fl -verbose
 319 Extra debugging information during mount/recovery
 320 .It Fl -journal_flush_delay Ns = Ns Ar ms
 321 Delay in milliseconds before automatic journal commits
 322 .It Fl -journal_flush_disabled
 323 Disable journal flush on sync/fsync
 324 .sp
 325 If enabled, writes can be lost, but only since the
 326 last journal write (default 1 second)
 327 .It Fl -journal_reclaim_delay Ns = Ns Ar ms
 328 Delay in milliseconds before automatic journal reclaim
 329 .It Fl -move_bytes_in_flight Ns = Ns Ar bytes
 330 Maximum Amount of IO to keep in flight by the move path
 331 .It Fl -move_ios_in_flight Ns = Ns Ar number
 332 Maximum number of IOs to keep in flight by the move path
 333 .It Fl -fsck
 334 Run fsck on mount
 335 .It Fl -fix_errors Ns = Ns Ar error
 336 Fix errors during fsck without asking
 337 .It Fl -ratelimit_errors
 338 Ratelimit error messages during fsck
 339 .It Fl -nochanges
 340 Super read only mode - no writes at all will be issued,
 341 even if we have to replay the journal
 342 .It Fl -norecovery
 343 Don't replay the journal
 344 .It Fl -journal_transaction_names
 345 Log transaction function names in journal
 346 .It Fl -noexcl
 347 Don't open device in exclusive mode
 348 .It Fl -direct_io
 349 Use O_DIRECT (userspace only)
 350 .It Fl -sb Ns = Ns Ar offset
 351 Sector offset of superblock
 352 .It Fl -reconstruct_alloc
 353 Reconstruct alloc btree
 354 .It Fl -version_upgrade Ns = Ns ( Cm compatible | incompatible | none )
 355 Set superblock to latest version, allowing any new features
 356 to be used
 357 .It Fl -nocow
 358 Nocow mode: Writes will be done in place when possible.
 359 .sp
 360 Snapshots and reflink will still caused writes to be COW.
 361 .sp
 362 This flag implicitly disables data checksumming, compression and
 363 encryption.
 364 .It Fl -nocow_enabled
 365 Enable nocow mode: enables runtime locking in data
 366 move path needed if nocow will ever be in use
 367 .It Fl -no_data_io
 368 Skip submit_bio() for data reads and writes,
 369 for performance testing purposes
 370 .El
 371 .El
 372 .Sh Mount commands
 373 .Bl -tag -width Ds
 374 .It Nm Ic mount Oo Ar options Oc Ar device mountpoint
 375 Mount a filesystem. The
 376 .Ar device
 377 can be a device, a colon-separated list of devices, or UUID=<UUID>. The
 378 .Ar mountpoint
 379 is the path where the filesystem should be mounted. If not set, then the filesystem won't actually be mounted
 380 but all steps preceding mounting the filesystem (e.g. asking for passphrase) will still be performed.
 381 .Pp the options are as follows:
 382 .Bl -tag -width Ds
 383 .It Fl o Ar options
 384 Mount options provided as a comma-separated list. See user guide for complete list.
 385 .Bl -tag -width Ds -compact
 386 .It Cm degraded
 387 Allow mounting with data degraded
 388 .It Cm verbose
 389 Extra debugging info during mount/recovery
 390 .It Cm fsck
 391 Run fsck during mount
 392 .It Cm fix_errors
 393 Fix errors without asking during fsck
 394 .It Cm read_only
 395 Mount in read only mode
 396 .It Cm version_upgrade
 397 .El
 398 .It Fl k , Fl -key-location Ns = Ns ( Cm fail | wait | ask )
 399 Where the password would be loaded from. (default:
 400 .Cm ask ) .
 401 .Bl -tag -width Ds -compact
 402 .It Cm fail
 403 don't ask for password, fail if filesystem is encrypted.
 404 .It Cm wait
 405 wait for password to become available before mounting.
 406 .It Cm ask
 407 prompt the user for password.
 408 .El
 409 .It Fl c , Fl -colorize Ns = Ns ( Cm true | false )
 410 Force color on/off. Default: auto-detect TTY
 411 .It Fl v
 412 Be verbose. Can be specified more than once.
 413 .El
 414 .El
 415 .Sh Repair commands
 416 .Bl -tag -width Ds
 417 .It Nm Ic fsck Oo Ar options Oc Ar devices\ ...
 418 Check an existing filesystem for errors.
 419 .Bl -tag -width Ds
 420 .It Fl p
 421 Automatic repair (no questions)
 422 .It Fl n
 423 Don't repair, only check for errors
 424 .It Fl y
 425 Assume "yes" to all questions
 426 .It Fl f
 427 Force checking even if filesystem is marked clean
 428 .It Fl r , Fl -ratelimit_errors
 429 Don't display more than 10 errors of a given type
 430 .It Fl R , Fl -reconstruct_alloc
 431 Reconstruct the alloc btree
 432 .It Fl v
 433 Be verbose
 434 .El
 435 .El
 436 .Sh Commands for managing a running filesystem
 437 .Bl -tag -width Ds
 438 .It Nm Ic fs Ic usage Oo Ar options Oc Op Ar filesystem
 439 Show disk usage.
 440 .Bl -tag -width Ds
 441 .It Fl h , Fl -human-readable
 442 Print human readable sizes.
 443 .El
 444 .El
 445 .Sh Commands for managing devices within a running filesystem
 446 .Bl -tag -width Ds
 447 .It Nm Ic device Ic add Oo Ar options Oc Ar device
 448 Add a device to an existing filesystem.
 449 .Bl -tag -width Ds
 450 .It Fl -fs_size Ns = Ns Ar size
 451 Size of filesystem on device
 452 .It Fl -bucket Ns = Ns Ar size
 453 Set bucket size
 454 .It Fl -discard
 455 Enable discards
 456 .It Fl l , Fl -label Ns = Ns Ar label
 457 Disk label
 458 .It Fl f , Fl -force
 459 Use device even if it appears to already be formatted
 460 .El
 461 .It Nm Ic device Ic remove Oo Ar options Oc Ar device
 462 Remove a device from a filesystem
 463 .Bl -tag -width Ds
 464 .It Fl f , Fl -force
 465 Force removal, even if some data couldn't be migrated
 466 .It Fl F , Fl -force-metadata
 467 Force removal, even if some metadata couldn't be migrated
 468 .El
 469 .It Nm Ic device Ic online Ar device
 470 Re-add a device to a running filesystem
 471 .It Nm Ic device Ic offline Ar device
 472 Take a device offline, without removing it
 473 .Bl -tag -width Ds
 474 .It Fl f , Fl -force
 475 Force, if data redundancy will be degraded
 476 .El
 477 .It Nm Ic device Ic evacuate Ar device
 478 Move data off of a given device
 479 .It Nm Ic device Ic set-state Oo Ar options Oc Ar new-state Ar device
 480 .Bl -tag -width Ds
 481 .It Ar  new-state Ns = Ns ( Ar rw | ro | failed | spare )
 482 .It Fl f , Fl -force
 483 Force, if data redundancy will be degraded
 484 .It Fl -force-if-data-lost
 485 Force, if data will be lost
 486 .It Fl o , Fl -offline
 487 Set state of an offline device
 488 .El
 489 .It Nm Ic device Ic resize Ar device Op Ar size
 490 Resize filesystem on a device
 491 .It Nm Ic device Ic resize-journal Ar device Op Ar size
 492 Resize journal on a device
 493 .El
 494 .Sh Commands for managing subvolumes and snapshots
 495 .Bl -tag -width Ds
 496 .It Ic subvolume create Oo Ar options Oc Ar path
 497 Create a new subvolume
 498 .It Ic subvolume delete Oo Ar options Oc Ar path
 499 Delete an existing subvolume
 500 .It Ic subvolume delete Oo Ar options Oc Ar source dest
 501 Create a snapshot of
 502 .Ar source
 503 at
 504 .Ar dest .
 505 If specified,
 506 .Ar source
 507 must be a subvolume;
 508 if not specified the snapshot will be of the subvolume containing
 509 .Ar dest .
 510 .Bl -tag -width Ds
 511 .It Fl r
 512 Make snapshot read-only
 513 .El
 514 .El
 515 .Sh Commands for managing filesystem data
 516 .Bl -tag -width Ds
 517 .It Nm Ic data Ic rereplicate Ar filesystem
 518 Walks existing data in a filesystem,
 519 writing additional copies of any degraded data.
 520 .It Nm Ic data Ic job Ar job filesystem
 521 Kick off a data job and report progress
 522 .sp
 523 .Ar job
 524 is one of (
 525 .Cm scrub | rereplicate | migrate | rewrite_old_nodes
 526 )
 527 .Bl -tag -width Ds
 528 .It Fl b Ar btree
 529 Btree to operate on
 530 .It Fl s Ar inode Ns Cm \&: Ns Ar offset
 531 Start position
 532 .It Fl e Ar inode Ns Cm \&: Ns Ar offset
 533 End position
 534 .El
 535 .El
 536 .Sh Commands for encryption
 537 .Bl -tag -width Ds
 538 .It Nm Ic unlock Ar device
 539 Unlock an encrypted filesystem prior to running/mounting.
 540 .Bl -tag -width Ds
 541 .It Fl c
 542 Check if a device is encrypted
 543 .It Fl k Ns = Ns ( Cm session | user | user_session )
 544 Keyring to add to (default:
 545 .Cm user )
 546 .El
 547 .It Nm Ic set-passphrase Ar devices\ ...
 548 Change passphrase on an existing (unmounted) filesystem.
 549 .It Nm Ic remove-passphrase Ar devices\ ...
 550 Remove passphrase on an existing (unmounted) filesystem.
 551 .El
 552 .Sh Commands for migration
 553 .Bl -tag -width Ds
 554 .It Nm Ic migrate Oo Ar options Oc Ar device
 555 Migrate an existing filesystem to bcachefs
 556 .Bl -tag -width Ds
 557 .It Fl f Ar fs
 558 Root of filesystem to migrate
 559 .It Fl -encrypted
 560 Enable whole filesystem encryption (chacha20/poly1305)
 561 .It Fl -no_passphrase
 562 Don't encrypt master encryption key
 563 .It Fl F
 564 Force, even if metadata file already exists
 565 .El
 566 .It Nm Ic migrate-superblock Oo Ar options Oc Ar device
 567 Create default superblock after migrating
 568 .Bl -tag -width Ds
 569 .It Fl d Ar device
 570 Device to create superblock for
 571 .It Fl o Ar offset
 572 Offset of existing superblock
 573 .El
 574 .El
 575 .Sh Commands for operating on files in a bcachefs filesystem
 576 .Bl -tag -width Ds
 577 .It Nm Ic setattr Oo Ar options Oc Ar devices\ ...
 578 .Bl -tag -width Ds
 579 .It Fl -data_replicas Ns = Ns Ar number
 580 Number of data replicas
 581 .It Fl -data_checksum Ns = Ns ( Cm none | crc32c | crc64 | xxhash )
 582 Set data checksum type (default:
 583 .Cm crc32c ) .
 584 .It Fl -compression Ns = Ns ( Cm none | lz4 | gzip | zstd )
 585 Set compression type (default:
 586 .Cm none ) .
 587 .It Fl -background_compression Ns = Ns ( Cm none | lz4 | gzip | zstd )
 588
 589 .It Fl -metadata_target Ns = Ns Ar target
 590 Device or label for metadata writes
 591 .It Fl -foreground_target Ns = Ns Ar target
 592 Device or label for foreground writes
 593 .It Fl -background_target Ns = Ns Ar target
 594 Device or label to move data to in the background
 595 .It Fl -promote_target Ns = Ns Ar target
 596 Device or label to promote data to on read
 597 .It Fl -erasure_code
 598 Enable erasure coding (DO NOT USE YET)
 599 .It Fl -project
 600
 601 .It Fl -nocow
 602 Nocow mode: Writes will be done in place when possible.
 603 .El
 604 .El
 605 .Sh Commands for debugging
 606 These commands work on offline, unmounted filesystems.
 607 .Bl -tag -width Ds
 608 .It Nm Ic dump Oo Ar options Oc Ar device
 609 Dump filesystem metadata
 610 .Bl -tag -width Ds
 611 .It Fl o Ar output
 612 Required flag: Output qcow2 image(s)
 613 .It Fl f , Fl -force
 614 Force; overwrite when needed
 615 .It Fl -nojournal
 616 Don't dump entire journal, just dirty entries
 617 .El
 618 .It Nm Ic list Oo Ar options Oc Ar devices\ ...
 619 List filesystem metadata to stdout
 620 .Bl -tag -width Ds
 621 .It Fl b ( Cm extents | inodes | dirents | xattrs )
 622 Btree to list from. (default:
 623 .Cm extents)
 624 .It Fl l , Fl -level
 625 Btree depth to descend to. (
 626 .Cm 0
 627 == leaves; default:
 628 .Cm 0)
 629 .It Fl s Ar inode Ns Cm \&: Ns Ar offset
 630 Start position to list from
 631 .It Fl e Ar inode Ns Cm \&: Ns Ar offset
 632 End position
 633 .It Fl m , Fl -mode ( Cm keys | formats | nodes | nodes-ondisk )
 634 (default:
 635 .Cm keys)
 636 .It Fl f
 637 Check (fsck) the filesystem first
 638 .It Fl c , Fl -colorize Ns = Ns ( Cm true | false )
 639 Force color on/off. Default: auto-detect TTY
 640 .It Fl v
 641 Verbose mode
 642 .El
 643 .It Nm Ic list_journal Oo Ar options Oc Ar devices\ ...
 644 .Bl -tag -width Ds
 645 .It Fl a
 646 Read entire journal, not just dirty entries
 647 .It Fl n , Fl -nr-entries Ns = Ns Ar nr
 648 Number of journal entries to print, starting from the most recent
 649 .It Fl t , Fl -transaction-filter Ns = Ns Ar bbpos
 650 Filter transactions not updating
 651 .Ar bbpos
 652 .It Fl k , Fl -key-filter Ns = Ns Ar btree
 653 Filter keys not updating
 654 .Ar btree
 655 .It Fl v , Fl -verbose
 656 Verbose mode
 657 .El
 658 .El
 659 .Sh FUSE commands
 660 .Bl -tag -width Ds
 661 .It Nm Ic fusemount
 662 Mount a filesystem via FUSE
 663 .El
 664 .Sh Miscellaneous commands
 665 .Bl -tag -width Ds
 666 .It Nm Ic completions Ar shell
 667 Generate shell completions
 668 .It Nm Ic version
 669 Display the version of the invoked bcachefs tool
 670 .El
 671 .Sh EXIT STATUS
 672 .Ex -std