New upstream release

[bcachefs-tools-debian] / bcachefs.8

diff --git a/bcachefs.8 b/bcachefs.8
index d5c4e8906e793a84939daa2b35a9253abd04acb3..994b50f25e9ebf71a5774eac483d7b22a70ba3a7 100644 (file)
--- a/bcachefs.8
+++ b/bcachefs.8
@@ -1,4 +1,4 @@
-.Dd May 26, 2018
+.Dd March 7, 2023
 .Dt BCACHEFS 8 SMM
 .Os
 .Sh NAME
@@ -21,22 +21,16 @@ Format one or a list of devices with bcachefs data structures.
 .It Ic show-super
 Dump superblock information to stdout.
 .El
+.Ss Mount commands
+.Bl -tag -width 18n -compact
+.It Ic mount
+Mount a filesystem.
+.El
 .Ss Repair commands
 .Bl -tag -width 18n -compact
 .It Ic fsck
 Check an existing filesystem for errors.
 .El
-.Ss Startup/shutdown, assembly of multi device filesystems
-.Bl -tag -width 18n -compact
-.It Ic assemble
-Assemble an existing multi device filesystem
-.It Ic incremental
-Incrementally assemble an existing multi device filesystem
-.It Ic run
-Start a partially assembled filesystem.
-.It Ic stop
-Stop a running filesystem.
-.El
 .Ss Commands for managing a running filesystem
 .Bl -tag -width 18n -compact
 .It Ic fs usage
@@ -162,6 +156,47 @@ List of sections to print
 Print superblock layout
 .El
 .El
+.Sh Mount commands
+.Bl -tag -width Ds
+.It Nm Ic mount Oo Ar options Oc Ar device mountpoint
+Mount a filesystem. The
+.Ar device
+can be a device, a colon-separated list of devices, or UUID=<UUID>. The
+.Ar mountpoint
+is the path where the filesystem should be mounted. If not set, then the filesystem won't actually be mounted
+but all steps preceeding mounting the filesystem (e.g. asking for passphrase) will still be performed.
+.Pp the options are as follows:
+.Bl -tag -width Ds
+.It Fl o Ar options
+Mount options provided as a comma-separated list. See userguide for complete list.
+.Bl -tag -width Ds -compact
+.It Cm degraded
+Allow mounting with data degraded
+.It Cm verbose
+Extra debugging info during mount/recovery
+.It Cm fsck
+Run fsck during mount
+.It Cm fix_errors
+Fix errors without asking during fsck
+.It Cm read_only
+Mount in read only mode
+.It Cm version_upgrade
+.El
+.It Fl k , Fl -key-location Ns = Ns ( Cm fail | wait | ask )
+Where the password would be loaded from. (default:
+.Cm ask ) .
+.Bl -tag -width Ds -compact
+.It Cm fail
+don't ask for password, fail if filesystem is encrypted.
+.It Cm wait
+wait for password to become available before mounting.
+.It Cm ask
+prompt the user for password.
+.El
+.It Fl v
+Be verbose. Can be specified more than once.
+.El
+.El
 .Sh Repair commands
 .Bl -tag -width Ds
 .It Nm Ic fsck Oo Ar options Oc Ar devices\ ...
@@ -179,17 +214,6 @@ Force checking even if filesystem is marked clean
 Be verbose
 .El
 .El
-.Sh Startup/shutdown, assembly of multi device filesystems
-.Bl -tag -width Ds
-.It Nm Ic assemble Ar devices\ ...
-Assemble an existing multi device filesystem.
-.It Nm Ic incremental Ar device
-Incrementally assemble an existing multi device filesystem.
-.It Nm Ic run
-Start a partially assembled filesystem.
-.It Nm Ic stop Ar filesystem
-Stop a running filesystem.
-.El
 .Sh Commands for managing a running filesystem
 .Bl -tag -width Ds
 .It Nm Ic fs Ic usage Oo Ar options Oc Op Ar filesystem