From: Alexander Fougner <fougner89@gmail.com>
Date: Wed, 8 Mar 2023 19:57:50 +0000 (+0100)
Subject: Add manpage for mount command
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=46ba4fb48ca5ac28f442b74c44ca53196112423f;p=bcachefs-tools-debian

Add manpage for mount command

Signed-off-by: Alexander Fougner <fougner89@gmail.com>
---

diff --git a/bcachefs.8 b/bcachefs.8
index f5ee775..994b50f 100644
--- a/bcachefs.8
+++ b/bcachefs.8
@@ -21,6 +21,11 @@ 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
@@ -151,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\ ...
diff --git a/bcachefs.c b/bcachefs.c
index 70b950a..f6148e2 100644
--- a/bcachefs.c
+++ b/bcachefs.c
@@ -35,6 +35,9 @@ static void usage(void)
 	     "  show-super               Dump superblock information to stdout\n"
 	     "  set-option               Set a filesystem option\n"
 	     "\n"
+	     "Mount:\n"
+	     "  mount                    Mount a filesystem\n"
+	     "\n"
 	     "Repair:\n"
 	     "  fsck                     Check an existing filesystem for errors\n"
 	     "\n"