1.\" Copyright (c) 2017 The DragonFly Project.  All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\"
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in
11.\"    the documentation and/or other materials provided with the
12.\"    distribution.
13.\" 3. Neither the name of The DragonFly Project nor the names of its
14.\"    contributors may be used to endorse or promote products derived
15.\"    from this software without specific, prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
21.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
23.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
27.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd October 8, 2020
31.Dt MOUNT_HAMMER2 8
32.Os
33.Sh NAME
34.Nm mount_hammer2
35.Nd mount a HAMMER2 file system
36.Sh SYNOPSIS
37.Nm
38.Op Fl o Ar options
39.Ar special Ns Op Cm @ Ns Ar label
40.Ar node
41.Nm
42.Op Fl o Ar options
43.Cm @ Ns Ar label
44.Ar node
45.Nm
46.Fl u
47.Op Fl o Ar options
48.Ar node
49.Sh DESCRIPTION
50The
51.Nm
52utility mounts a
53.Nm HAMMER2
54file system backed by
55.Ar special
56file at mount point
57.Ar node .
58PFS
59.Ar label
60is mounted.
61.Pp
62.Cm @ Ns Ar label
63(no
64.Ar special )
65is a short form, which mounts
66.Ar label
67from an already mounted
68.Nm HAMMER2
69filesystem.
70If there are multiple mounts with the same
71.Ar label ,
72the first one mounted takes precedence over others.
73.Pp
74Default value for
75.Ar label
76is based on partition of
77.Ar special :
78.Ql a
79defaults to "BOOT" ,
80.Ql d
81defaults to "ROOT",
82and any other partition defaults to "DATA".
83.Pp
84The options are as follows:
85.Bl -tag -width indent
86.It Fl o Ar options
87Options are specified with a
88.Fl o
89flag followed by a comma separated string of options.
90See the
91.Xr mount 8
92man page for possible options and their meanings.
93The following
94.Nm HAMMER2
95specific options are also available:
96.Bl -tag -width indent
97.It Cm local
98Disable PFS clustering.
99.El
100.It Fl u
101Update the mount point.
102This is used to upgrade a mount to read-write.
103.El
104.Sh EXIT STATUS
105.Ex -std
106.Sh EXAMPLES
107Mount a
108.Nm HAMMER2
109file system on
110.Pa /mnt ,
111PFS "ROOT" is mounted:
112.Bd -literal -offset indent
113mount_hammer2 /dev/da0s1d /mnt
114.Ed
115.Pp
116A corresponding
117.Xr fstab 5
118entry is:
119.Bd -literal -offset indent
120/dev/da0s1d /mnt hammer2
121.Ed
122.Pp
123Mount PFS "TEST" from same filesystem:
124.Bd -literal -offset indent
125mount_hammer2 @TEST /mnt2
126.Ed
127.Sh SEE ALSO
128.Xr mount 2 ,
129.Xr unmount 2 ,
130.Xr fstab 5 ,
131.Xr disklabel32 8 ,
132.Xr disklabel64 8 ,
133.Xr fdisk 8 ,
134.Xr gpt 8 ,
135.Xr hammer2 8 ,
136.Xr mount 8 ,
137.Xr newfs_hammer2 8
138.Sh HISTORY
139The
140.Nm
141utility first appeared in
142.Dx 3.3 .
143.Sh AUTHORS
144This manual page was written by
145.An Thomas Nikolajsen .
146