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