Fix typo.
[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 .\" $DragonFly: src/sbin/mount_hammer/mount_hammer.8,v 1.12 2008/07/21 23:42:01 swildner Exp $
34 .Dd June 24, 2008
35 .Dt MOUNT_HAMMER 8
36 .Os
37 .Sh NAME
38 .Nm mount_hammer
39 .Nd mount a HAMMER file system
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl o Ar mount-options
43 .Op Fl T Ar transaction-id
44 .Ar special ...
45 .Ar mount-point
46 .Nm
47 .Op Fl u
48 .Op Fl o Ar mount-options
49 .Ar mount-point
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility mounts a HAMMER filesystem backed by one or more block devices.
54 .Ar Special
55 files can be separated by colon,
56 .Dq \&: ,
57 instead of blanks, this is useful in
58 .Xr fstab 5 .
59 .Pp
60 The options are as follows:
61 .Bl -tag -width indent
62 .It Fl o Ar mount-options
63 Specify mount options, which are a comma delimited set of options (see
64 .Xr mount 8 ) .
65 Supported mount options are:
66 .Bl -tag -width indent
67 .It Ar ro
68 Issue a read-only mount.
69 .It Ar nohistory
70 Put the entire filesystem in no-history mode.  Change history is not
71 retained.
72 Use of this option may increase the overhead of doing mirroring.
73 This option is generally only used in an emergency.
74 .It Ar master=<id>
75 Assign a master id for the entire mount which applies to all PFSs under
76 the mount.  This is intended to help support multi-master and fail-over
77 operation.  Multi-master operation is not yet supported.  If you intend
78 to upgrade slaves to masters and downgrade masters to slaves as part of
79 a fail-over setup, it's a good idea to assign a different master id
80 to the HAMMER mounts making up the fail-over group.
81 .It Ar nomirror
82 By default a HAMMER mount assigns a master id of 0.  You can force
83 no-mirror operation by specifying this option.  This option disables
84 mirror transaction id propagation in the B-Tree and will improve write
85 performance somewhat but also prevents incremental mirroring from working
86 at all, and is not recommended.
87 .El
88 .It Fl T Ar transaction-id
89 Mount the filesystem as-of a particular
90 transaction id.
91 The mount will automatically be made read-only.
92 The
93 .Ar transaction-id
94 must be specified as a 64 bit hex value prefixed with "0x".
95 .It Fl u
96 Update the mount point.  This is typically used to upgrade a mount to
97 read-write or downgrade it to read-only.
98 .El
99 .Sh NOTES
100 Note that issuing a read-only mount which requires UNDOs to be run will
101 still run the UNDOs, but will not flush the buffer cache buffers until/if
102 the mount is updated to read-write.
103 .Sh EXAMPLES
104 .Bd -literal -offset indent
105 mount_hammer -o ro,noatime /dev/ad0s1d /dev/ad1s1d /mnt
106 .Ed
107 .Pp
108 Mount a HAMMER filesystem made up of two volumes onto
109 .Pa /mnt .
110 .Sh DIAGNOSTICS
111 Exit status is 0 on success and 1 on error.
112 .Sh SEE ALSO
113 .Xr mount 2 ,
114 .Xr unmount 2 ,
115 .Xr fstab 5 ,
116 .Xr disklabel 8 ,
117 .Xr disklabel64 8 ,
118 .Xr fdisk 8 ,
119 .Xr hammer 8 ,
120 .Xr mount 8 ,
121 .Xr newfs_hammer 8
122 .Sh HISTORY
123 The
124 .Nm
125 utility first appeared in
126 .Dx 1.11 .
127 .Sh AUTHORS
128 .An Matthew Dillon Aq dillon@backplane.com