Update newfs_hammer.8:
[dragonfly.git] / sbin / newfs_hammer / newfs_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/newfs_hammer/newfs_hammer.8,v 1.9 2008/07/27 16:15:33 thomas Exp $
34 .Dd July 24, 2008
35 .Dt NEWFS_HAMMER 8
36 .Os
37 .Sh NAME
38 .Nm newfs_hammer
39 .Nd construct a new HAMMER file system
40 .Sh SYNOPSIS
41 .Nm
42 .Fl L Ar label
43 .Op Fl b Ar bootsize
44 .Op Fl f
45 .Op Fl m Ar savesize
46 .Op Fl u Ar undosize
47 .Ar special ...
48 .Sh DESCRIPTION
49 The
50 .Nm
51 utility creates a
52 .Nm HAMMER
53 file system on device
54 .Ar special .
55 If multiple devices are specified a single
56 .Nm HAMMER
57 file system is created
58 which spans all of them.
59 Each
60 .Ar special
61 will constitute a volume which the
62 .Nm HAMMER
63 file system is built on.
64 .Nm HAMMER
65 file systems are sector-size agnostic, however the
66 .Dx
67 implementation requires the sector size to be no larger than 16K.
68 .Nm HAMMER
69 file systems start at a relative offset of 0 and may only be created
70 under out-of-band disk labels
71 .Po
72 .Xr disklabel64 5
73 or
74 .Xr gpt 8
75 labels
76 .Pc ,
77 or in
78 .Xr disklabel 5
79 partitions which do not overlap the label area.
80 .Pp
81 The options are as follows:
82 .Bl -tag -width indent
83 .It Fl L Ar label
84 All
85 .Nm HAMMER
86 file systems must be named and names should be unique on a
87 per-machine basis.
88 .It Fl b Ar bootsize
89 Specify a fixed area in which a boot related kernel and data can be stored.
90 By default a boot area of approximately 4MB will be created.
91 .It Fl f
92 Force the creation of a
93 .Nm HAMMER
94 file system with less than 100M UNDO FIFO.
95 This should not be used under normal circumstances.
96 .It Fl m Ar savesize
97 Specify a fixed area which
98 .Nm HAMMER
99 may use as a memory log.  This area is
100 currently unused.
101 .It Fl u Ar undosize
102 Specify the size of the fixed UNDO FIFO.  By default 0.1% of the root
103 volume's size is used, with a reasonable minimum and a reasonable cap.
104 The UNDO FIFO is used to sequence meta-data out to the media for instant
105 crash recovery.
106 .El
107 .\".Sh NOTES
108 .Sh EXAMPLES
109 .Bd -literal -offset indent
110 newfs_hammer -L Home /dev/ad0s1d
111 .Ed
112 .Pp
113 Create a file system named
114 .Sq Home
115 on
116 .Pa /dev/ad0s1d .
117 .Sh DIAGNOSTICS
118 Exit status is 0 on success and 1 on error.
119 .Sh SEE ALSO
120 .Xr HAMMER 5 ,
121 .Xr disklabel 5 ,
122 .Xr disklabel64 5 ,
123 .Xr fdisk 8 ,
124 .Xr gpt 8 ,
125 .Xr newfs 8
126 .Sh HISTORY
127 The
128 .Nm
129 utility first appeared in
130 .Dx 1.11 .
131 .Sh AUTHORS
132 .An Matthew Dillon Aq dillon@backplane.com