Merge from vendor branch SENDMAIL:
[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.1 2007/10/10 19:35:19 dillon Exp $
34 .Dd October 10, 2007
35 .Dt MOUNT_HAMMER 8
36 .Os
37 .Sh NAME
38 .Nm mount_hammer
39 .Nd construct a new HAMMER file system
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl T Ar time
43 .Op Fl o Ar mount-options
44 .Ar special
45 .Op special...
46 .Ar mount-point
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility mounts a HAMMER filesystem backed by one or more block devices.
51 .Pp
52 The options are as follow:
53 .Bl -tag -width indent
54 .It Fl T Ar time
55 Mount the filesystem as-of a particular time.  The mount will automatically
56 be made read-only.
57 .It Fl o Ar mount-options
58 Specify mount options, see
59 .Xr mount 8 .
60 .El
61 .Pp
62 Mount options are a comma delimited set of options.  Supported mount
63 options are:
64 .Bl -tag -width indent
65 .It Ar ro
66 Issue a read-only mount.
67 .El
68 .Sh NOTES
69 .Sh EXAMPLES
70 .Bd -literal -offset indent
71 mount_hammer -o ro,noatime /dev/ad0s1d /dev/ad1s1d /mnt
72 .Ed
73 .Pp
74 Mount a hammer filesystem made up of two volumes onto
75 .Pa /mnt .
76 .Sh DIAGNOSTICS
77 Exit status is 0 on success and 1 on error.
78 .Sh SEE ALSO
79 .Xr disklabel 8 ,
80 .Xr fdisk 8 ,
81 .Xr newfs_hammer 8
82 .Sh HISTORY
83 The
84 .Nm
85 utility first appeared in
86 .Dx 2.0 .
87 .Sh AUTHORS
88 .An Matthew Dillon Aq dillon@backplane.com .