Merge from vendor branch LIBARCHIVE:
[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.5 2008/04/23 21:59:22 thomas Exp $
34 .Dd October 10, 2007
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 time
44 .Ar special ...
45 .Ar mount-point
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility mounts a HAMMER filesystem backed by one or more block devices.
50 .Pp
51 The options are as follows:
52 .Bl -tag -width indent
53 .It Fl o Ar mount-options
54 Specify mount options, which are a comma delimited set of options (see
55 .Xr mount 8 ) .
56 Supported mount options are:
57 .Bl -tag -width indent
58 .It Ar ro
59 Issue a read-only mount.
60 .El
61 .It Fl T Ar time
62 Mount the filesystem as-of a particular
63 .Ar time .
64 The mount will automatically be made read-only.
65 The
66 .Ar time
67 may be specified two ways.
68 A single integer followed by
69 .Sq s ,
70 .Sq m ,
71 .Sq h ,
72 .Sq D ,
73 .Sq M ,
74 or
75 .Sq Y
76 issues a historical mount as-of a number of seconds, minutes, hours, days,
77 months, or years ago.
78 A time specification of
79 .Pf yyyymmdd Oo :hhmmss Oc Ns Op .fractional
80 specifies an exact as-of timestamp in local (not UTC) time.
81 Set the TZ environment variable prior to running
82 .Nm
83 if you wish to specify the time by some other means.
84 .El
85 .\".Sh NOTES
86 .Sh EXAMPLES
87 .Bd -literal -offset indent
88 mount_hammer -o ro,noatime /dev/ad0s1d /dev/ad1s1d /mnt
89 .Ed
90 .Pp
91 Mount a hammer filesystem made up of two volumes onto
92 .Pa /mnt .
93 .Sh DIAGNOSTICS
94 Exit status is 0 on success and 1 on error.
95 .Sh SEE ALSO
96 .Xr disklabel 8 ,
97 .Xr fdisk 8 ,
98 .Xr hammer 8 ,
99 .Xr newfs_hammer 8
100 .Sh HISTORY
101 The
102 .Nm
103 utility first appeared in
104 .Dx 1.11 .
105 .Sh AUTHORS
106 .An Matthew Dillon Aq dillon@backplane.com