newfs_hammer.8: Mdoc fix
[dragonfly.git] / sbin / newfs_hammer / newfs_hammer.8
CommitLineData
9a8bf4a7 1.\" Copyright (c) 2007 The DragonFly Project. All rights reserved.
dac7444f 2.\"
9a8bf4a7
MD
3.\" This code is derived from software contributed to The DragonFly Project
4.\" by Matthew Dillon <dillon@backplane.com>
dac7444f 5.\"
9a8bf4a7
MD
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
dac7444f 9.\"
9a8bf4a7
MD
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.
dac7444f 19.\"
9a8bf4a7
MD
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.
dac7444f 32.\"
7b8c2c90 33.Dd October 7, 2011
9a8bf4a7
MD
34.Dt NEWFS_HAMMER 8
35.Os
36.Sh NAME
37.Nm newfs_hammer
38.Nd construct a new HAMMER file system
39.Sh SYNOPSIS
40.Nm
41.Fl L Ar label
91ce3856 42.Op Fl \&Ef
240a4e41 43.Op Fl b Ar bootsize
64c21cf3
MD
44.Op Fl m Ar savesize
45.Op Fl u Ar undosize
47921633 46.Op Fl V Ar version
cb66b1a3 47.Ar special ...
9a8bf4a7
MD
48.Sh DESCRIPTION
49The
50.Nm
1d961ee9
TN
51utility creates a
52.Nm HAMMER
240a4e41 53file system on device(s)
9a8bf4a7 54.Ar special .
1d961ee9
TN
55If multiple devices are specified a single
56.Nm HAMMER
57file system is created
cb66b1a3 58which spans all of them.
1d961ee9
TN
59Each
60.Ar special
61will constitute a volume which the
62.Nm HAMMER
63file system is built on.
64.Nm HAMMER
65file systems are sector-size agnostic, however the
cb66b1a3
SW
66.Dx
67implementation requires the sector size to be no larger than 16K.
1d961ee9
TN
68.Nm HAMMER
69file systems start at a relative offset of 0 and may only be created
70under out-of-band disk labels
71.Po
72.Xr disklabel64 5
73or
74.Xr gpt 8
75labels
76.Pc ,
77or in
dac7444f 78.Xr disklabel32 5
c55db763 79partitions which do not overlap the label area (have a starting sector
240a4e41 80greater than 16).
c55db763
MD
81.Pp
82.Nm HAMMER
240a4e41 83file systems are designed for large storage systems, up to 1 Exabyte, and
c55db763 84will not operate efficiently on small storage systems.
240a4e41 85The minimum recommended file system size is 50GB.
c55db763 86.Nm HAMMER
dac7444f 87must reserve 500MB to 1GB of its storage for reblocking and UNDO/REDO.
240a4e41
TN
88In addition,
89.Nm HAMMER
90file systems operating normally, with full history
c55db763 91retention and daily snapshots, do not immediately reclaim space when
3542f322 92files are deleted.
240a4e41
TN
93A regular system maintenance job runs once a day by
94.Xr periodic 8
95to handle reclamation.
c55db763
MD
96.Pp
97.Nm HAMMER
98works best when the machine's normal workload would not otherwise fill
240a4e41 99the file system up in the course of 60 days of operation.
9a8bf4a7 100.Pp
cb66b1a3 101The options are as follows:
9a8bf4a7
MD
102.Bl -tag -width indent
103.It Fl L Ar label
1d961ee9
TN
104All
105.Nm HAMMER
106file systems must be named and names should be unique on a
9a8bf4a7 107per-machine basis.
64c21cf3
MD
108.It Fl b Ar bootsize
109Specify a fixed area in which a boot related kernel and data can be stored.
2b2e8d5b
TN
110The
111.Ar bootsize
112is specified in bytes.
64c21cf3 113By default a boot area of approximately 4MB will be created.
04a2b4c0 114.It Fl f
dac7444f
TN
115Force operation.
116This is needed for the creation of a
1d961ee9 117.Nm HAMMER
dac7444f
TN
118file system less than 10GB size or
119with less than 500MB UNDO/REDO FIFO.
04a2b4c0 120This should not be used under normal circumstances.
e0fb398b 121.It Fl E
7b8c2c90
SW
122Use TRIM to erase the device's data before creating the file system.
123The underlying device must have the TRIM sysctl enabled.
124Only devices that support TRIM will have such a sysctl option
125.Va ( kern.cam.da.X.trim_enabled ) .
64c21cf3 126.It Fl m Ar savesize
1d961ee9
TN
127Specify a fixed area which
128.Nm HAMMER
2b2e8d5b
TN
129may use as a memory log.
130This area is currently unused.
131The
132.Ar savesize
133is specified in bytes.
64c21cf3 134.It Fl u Ar undosize
dac7444f 135Specify the size of the fixed UNDO/REDO FIFO.
2b2e8d5b
TN
136The
137.Ar undosize
138is specified in bytes.
139By default 0.1% of the root
64c21cf3 140volume's size is used, with a reasonable minimum and a reasonable cap.
dac7444f
TN
141The UNDO/REDO FIFO is used to sequence meta-data out to the media for
142instant crash recovery.
47921633 143.It Fl V Ar version
240a4e41
TN
144Specify the
145.Nm HAMMER
146file system version to format.
3542f322 147By default
47921633 148.Nm
240a4e41
TN
149formats the file system using the highest production version number
150supported by the
151.Nm HAMMER
152VFS by checking the
153.Va vfs.hammer.supported_version
47921633 154sysctl.
240a4e41
TN
155If you need to maintain compatibility with an older version of
156.Nm HAMMER
47921633 157you may specify the version with this option.
9a8bf4a7 158.El
2b2e8d5b
TN
159.Pp
160The
161.Ar bootsize ,
162.Ar savesize
163and
164.Ar undosize
dac7444f 165must be given with a suffix of
2b2e8d5b
TN
166.Cm K , M , G
167or
168.Cm T
240a4e41 169meaning kilobyte, megabyte, gigabyte and terabyte.
3542f322 170Lower case can also be used for suffix.
9a8bf4a7
MD
171.Sh EXAMPLES
172.Bd -literal -offset indent
173newfs_hammer -L Home /dev/ad0s1d
174.Ed
175.Pp
cb66b1a3
SW
176Create a file system named
177.Sq Home
178on
9a8bf4a7
MD
179.Pa /dev/ad0s1d .
180.Sh DIAGNOSTICS
181Exit status is 0 on success and 1 on error.
182.Sh SEE ALSO
dac7444f 183.Xr disklabel32 5 ,
1d961ee9 184.Xr disklabel64 5 ,
666855ca 185.Xr HAMMER 5 ,
9a8bf4a7 186.Xr fdisk 8 ,
1d961ee9 187.Xr gpt 8 ,
9a8bf4a7
MD
188.Xr newfs 8
189.Sh HISTORY
190The
191.Nm
192utility first appeared in
cb66b1a3 193.Dx 1.11 .
9a8bf4a7 194.Sh AUTHORS
71681d11 195.An Matthew Dillon Aq dillon@backplane.com