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.2 2007/11/01 22:26:37 dillon Exp $
34.Dd September 10, 2007
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 c Ar clusize
44.Op Fl S
45.Op Fl U Ar uuid
46.Ar special
47.Op special...
48.Sh DESCRIPTION
49The
50.Nm
51utility creates a HAMMER filesystem on device
52.Ar special .
53If multiple devices are specified a single HAMMER filesystem is created
54which spans all of them.  HAMMER filesystems are sector-size agnostic,
55however the
56.DX
57implementation requires the sector size to be no larger then 16K.
58HAMMER filesystems start at a relative offset of 0 and may only be created
59under out-of-band disk labels (disklabel64 or gpt labels), or in standard
60disklabel partitions which do not overlap the label area.
61.Pp
62The options are as follow:
63.Bl -tag -width indent
64.It Fl L Ar label
65All HAMMER filesystems must be named and names should be unique on a
66per-machine basis.
67.It Fl U Ar uuid
68All HAMMER filesystems are assigned a globally unique UUID.  If no UUID
69is specified one will be synthesized.
70.It Fl S
71Force the HAMMER filesystem to be formatted with a supercluster layer,
72allowing it to support volumes greater then 2TB.  This option is automatically
73enabled if formatting HAMMER on a large disk.
74.It Fl c Ar clusize
75HAMMER organizes file objects in clusters and supeclusters.  Clusters
76default to the maximum size, which is 64MB.  A smaller size may be chosen
77if desired.  This option is not recommended.  HAMMER will use a truncated
78cluster as the last cluster and still use all available disk space
79regardless of the cluster size.
80.El
81.Sh NOTES
82.Sh EXAMPLES
83.Bd -literal -offset indent
84newfs_hammer -L Home /dev/ad0s1d
85.Ed
86.Pp
87Create a file system named 'Home' on
88.Pa /dev/ad0s1d .
89.Sh DIAGNOSTICS
90Exit status is 0 on success and 1 on error.
91.Sh SEE ALSO
92.Xr disklabel 8 ,
93.Xr fdisk 8 ,
94.Xr newfs 8
95.Sh HISTORY
96The
97.Nm
98utility first appeared in
99.Dx 2.0 .
100.Sh AUTHORS
101.An Matthew Dillon Aq dillon@backplane.com .
102