mount_hammer2(8): Add man page.
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Sat, 7 Oct 2017 13:13:11 +0000 (15:13 +0200)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Sat, 7 Oct 2017 13:13:11 +0000 (15:13 +0200)
sbin/mount_hammer2/Makefile
sbin/mount_hammer2/mount_hammer2.8 [new file with mode: 0644]

index d69ad3a..3b77f30 100644 (file)
@@ -1,6 +1,6 @@
 PROG=  mount_hammer2
 SRCS=  mount_hammer2.c
-MAN=
+MAN=   mount_hammer2.8
 
 CFLAGS+= -I${.CURDIR}/..
 CFLAGS+= -I${.CURDIR}/../../crypto/libressl/include
diff --git a/sbin/mount_hammer2/mount_hammer2.8 b/sbin/mount_hammer2/mount_hammer2.8
new file mode 100644 (file)
index 0000000..514545e
--- /dev/null
@@ -0,0 +1,142 @@
+.\" Copyright (c) 2017 The DragonFly Project.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\" 3. Neither the name of The DragonFly Project nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific, prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd October 7, 2017
+.Dt MOUNT_HAMMER2 8
+.Os
+.Sh NAME
+.Nm mount_hammer2
+.Nd mount a HAMMER2 file system
+.Sh SYNOPSIS
+.Nm
+.Op Fl o Ar options
+.Ar special Ns Op Cm @ Ns Ar label
+.Ar node
+.Nm
+.Op Fl o Ar options
+.Cm @ Ns Ar label
+.Ar node
+.Nm
+.Fl u
+.Op Fl o Ar options
+.Ar node
+.Sh DESCRIPTION
+The
+.Nm
+utility mounts a
+.Nm HAMMER2
+file system backed by
+.Ar special
+file at mount point
+.Ar node .
+PFS
+.Ar label
+is mounted.
+.Cm @ Ns Ar label
+(no
+.Ar special )
+is a short form, which mounts
+.Ar label
+from an already mounted
+.Nm HAMMER2
+filesystem.
+.Pp
+Default value for
+.Ar label
+is based on partition of
+.Ar special :
+.Ql a
+defaults to "BOOT" ,
+.Ql d
+defaults to "ROOT",
+and any other partition defaults to "DATA".
+.Pp
+The options are as follows:
+.Bl -tag -width indent
+.It Fl o Ar options
+Options are specified with a
+.Fl o
+flag followed by a comma separated string of options.
+See the
+.Xr mount 8
+man page for possible options and their meanings.
+The following
+.Nm HAMMER2
+specific options are also available:
+.Bl -tag -width indent
+.It Cm local
+Disable PFS clustering.
+.El
+.It Fl u
+Update the mount point.
+This is typically used to upgrade a mount to
+read-write or downgrade it to read-only.
+.El
+.Sh EXIT STATUS
+.Ex -std
+.Sh EXAMPLES
+Mount a
+.Nm HAMMER2
+file system on
+.Pa /mnt ,
+PFS "ROOT" is mounted:
+.Bd -literal -offset indent
+mount_hammer2 /dev/da0s1d /mnt
+.Ed
+.Pp
+A corresponding
+.Xr fstab 5
+entry is:
+.Bd -literal -offset indent
+/dev/da0s1d /mnt hammer2
+.Ed
+.Pp
+Mount PFS "TEST" from same filesystem:
+.Bd -literal -offset indent
+mount_hammer2 @TEST /mnt2
+.Ed
+.Sh SEE ALSO
+.Xr mount 2 ,
+.Xr unmount 2 ,
+.Xr fstab 5 ,
+.Xr disklabel32 8 ,
+.Xr disklabel64 8 ,
+.Xr fdisk 8 ,
+.Xr gpt 8 ,
+.Xr hammer2 8 ,
+.Xr mount 8 ,
+.Xr newfs_hammer2 8
+.Sh HISTORY
+The
+.Nm
+utility first appeared in
+.Dx 3.3 .
+.Sh AUTHORS
+This manual page was written by
+.An Thomas Nikolajsen .