libc/nsdispatch: Use libc_dlopen().
[dragonfly.git] / sbin / mount_hammer / mount_hammer.8
1 .\" Copyright (c) 2007 The DragonFly Project.  All rights reserved.
2 .\"
3 .\" This code is derived from software contributed to The DragonFly Project
4 .\" by Matthew Dillon <dillon@backplane.com>
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\"
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in
14 .\"    the documentation and/or other materials provided with the
15 .\"    distribution.
16 .\" 3. Neither the name of The DragonFly Project nor the names of its
17 .\"    contributors may be used to endorse or promote products derived
18 .\"    from this software without specific, prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .Dd December 31, 2015
34 .Dt MOUNT_HAMMER 8
35 .Os
36 .Sh NAME
37 .Nm mount_hammer
38 .Nd mount a HAMMER file system
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl o Ar options
42 .Op Fl T Ar transaction-id
43 .Ar special ...
44 .Ar node
45 .Nm
46 .Op Fl o Ar options
47 .Op Fl T Ar transaction-id
48 .Ar special Ns Oo Cm \&: Ns Ar special Oc Ns *
49 .Ar node
50 .Nm
51 .Fl u
52 .Op Fl o Ar options
53 .Ar node
54 .Sh DESCRIPTION
55 The
56 .Nm
57 utility mounts a
58 .Nm HAMMER
59 file system backed by
60 .Ar special
61 file(s) at mount point
62 .Ar node .
63 .Pp
64 The options are as follows:
65 .Bl -tag -width indent
66 .It Fl o Ar options
67 Options are specified with a
68 .Fl o
69 flag followed by a comma separated string of options.
70 See the
71 .Xr mount 8
72 man page for possible options and their meanings.
73 The following
74 .Nm HAMMER
75 specific options are also available:
76 .Bl -tag -width indent
77 .It Cm nohistory
78 Put the entire file system in no-history mode.
79 Change history is not retained.
80 Use of this option may increase the overhead of doing mirroring.
81 This option is generally only used in an emergency.
82 .It Cm master= Ns Ar id
83 Assign a master id for the entire mount which applies to all PFSs under
84 the mount.
85 This is intended to help support multi-master and fail-over operation.
86 Multi-master operation is not yet supported.
87 If you intend
88 to upgrade slaves to masters and downgrade masters to slaves as part of
89 a fail-over setup, it's a good idea to assign a different master id
90 to the
91 .Nm HAMMER
92 mounts making up the fail-over group.
93 .It Cm nomirror
94 By default a
95 .Nm HAMMER
96 mount assigns a master id of 0.
97 You can force no-mirror operation by specifying this option.
98 This option disables
99 mirror transaction id propagation in the B-Tree and will improve write
100 performance somewhat but also prevents incremental mirroring from working
101 at all, and is not recommended.
102 .El
103 .It Fl T Ar transaction-id
104 Mount the file system as-of a particular
105 transaction id.
106 The mount will automatically be made read-only.
107 The
108 .Ar transaction-id
109 must be specified as a 64 bit hex value prefixed with "0x".
110 .It Fl u
111 Update the mount point.
112 This is typically used to upgrade a mount to
113 read-write or downgrade it to read-only.
114 .El
115 .Sh NOTES
116 Note that issuing a read-only mount which requires UNDOs to be run will
117 still run the UNDOs, but will not flush the buffer cache buffers until/if
118 the mount is updated to read-write.
119 .Sh EXIT STATUS
120 .Ex -std
121 .Sh EXAMPLES
122 Mount a
123 .Nm HAMMER
124 file system made up of two volumes onto
125 .Pa /mnt :
126 .Bd -literal -offset indent
127 mount_hammer -o ro,noatime /dev/ad0s1d /dev/ad1s1d /mnt
128 .Ed
129 .Pp
130 Above is equivalent to below using blkdevs format for
131 .Nm HAMMER
132 volumes as
133 .Nm
134 supports both formats.
135 .Bd -literal -offset indent
136 mount_hammer -o ro,noatime /dev/ad0s1d:/dev/ad1s1d /mnt
137 .Ed
138 .Pp
139 A corresponding
140 .Xr fstab 5
141 entry is:
142 .Bd -literal -offset indent
143 /dev/ad0s1d:/dev/ad1s1d /mnt hammer ro,noatime
144 .Ed
145 .Sh SEE ALSO
146 .Xr mount 2 ,
147 .Xr unmount 2 ,
148 .Xr fstab 5 ,
149 .Xr HAMMER 5 ,
150 .Xr disklabel 8 ,
151 .Xr disklabel64 8 ,
152 .Xr fdisk 8 ,
153 .Xr gpt 8 ,
154 .Xr hammer 8 ,
155 .Xr mount 8 ,
156 .Xr newfs_hammer 8
157 .Sh HISTORY
158 The
159 .Nm
160 utility first appeared in
161 .Dx 1.11 .
162 .Sh AUTHORS
163 .An Matthew Dillon Aq Mt dillon@backplane.com