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