1 .\" Copyright (c) 2011 The DragonFly Project. All rights reserved.
3 .\" This code is derived from software contributed to The DragonFly Project
4 .\" by Matthew Dillon <dillon@backplane.com>
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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
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.
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
38 .Nd construct a new HAMMER2 file system
52 file system on device(s)
54 If multiple devices are specified a single
56 file system is created
57 which spans all of them.
60 will constitute a volume which the
62 file system is built on.
64 file systems are sector-size agnostic, however the
66 implementation requires the sector size to be no larger than 16K.
68 file systems start at a relative offset of 0 and may only be created
69 under out-of-band disk labels
78 partitions which do not overlap the label area (have a starting sector
82 file systems are designed for large storage systems, up to 1 Exabyte, and
83 will not operate efficiently on small storage systems.
84 The minimum recommended file system size is 50GB.
86 must reserve 500MB to 1GB of its storage for reblocking and UNDO/REDO.
89 file systems operating normally, with full history
90 retention and daily snapshots, do not immediately reclaim space when
92 A regular system maintenance job runs once a day by
94 to handle reclamation.
97 works best when the machine's normal workload would not otherwise fill
98 the file system up in the course of 60 days of operation.
100 The options are as follows:
101 .Bl -tag -width indent
105 file systems must be named and names should be unique on a
108 Specify a fixed area in which a boot related kernel and data can be stored.
111 is specified in bytes.
112 By default a boot area of approximately 4MB will be created.
115 This is needed for the creation of a
117 file system less than 10GB size or
118 with less than 500MB UNDO/REDO FIFO.
119 This should not be used under normal circumstances.
121 Specify the size of the fixed REDO FIFO.
124 is specified in bytes.
125 By default 0.1% of the root
126 volume's size is used, with a reasonable minimum and a reasonable cap.
127 The UNDO/REDO FIFO is used to sequence meta-data out to the media for
128 instant crash recovery.
132 file system version to format.
135 formats the file system using the highest production version number
139 .Va vfs.hammer2.supported_version
141 If you need to maintain compatibility with an older version of
143 you may specify the version with this option.
150 must be given with a suffix of
154 meaning kilobyte, megabyte, gigabyte and terabyte.
155 Lower case can also be used for suffix.
157 .Bd -literal -offset indent
158 newfs_hammer2 -L Home /dev/ad0s1d
161 Create a file system named
166 Exit status is 0 on success and 1 on error.
177 utility first appeared in
180 .An Matthew Dillon Aq dillon@backplane.com