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.6.2.2 2008/07/25 03:18:36 swildner 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 HAMMER filesystem on device
  52 .Ar special .
  53 If multiple devices are specified a single HAMMER filesystem is created
  54 which spans all of them.
  55 HAMMER filesystems are sector-size agnostic, however the
  56 .Dx
  57 implementation requires the sector size to be no larger than 16K.
  58 HAMMER filesystems start at a relative offset of 0 and may only be created
  59 under out-of-band disk labels (disklabel64 or gpt labels), or in standard
  60 disklabel partitions which do not overlap the label area.
  61 .Pp
  62 The options are as follows:
  63 .Bl -tag -width indent
  64 .It Fl L Ar label
  65 All HAMMER filesystems must be named and names should be unique on a
  66 per-machine basis.
  67 .It Fl b Ar bootsize
  68 Specify a fixed area in which a boot related kernel and data can be stored.
  69 By default a boot area of approximately 4MB will be created.
  70 .It Fl f
  71 Force the creation of a HAMMER file system with less than 100M UNDO FIFO.
  72 This should not be used under normal circumstances.
  73 .It Fl m Ar savesize
  74 Specify a fixed area which HAMMER may use as a memory log.  This area is
  75 currently unused.
  76 .It Fl u Ar undosize
  77 Specify the size of the fixed UNDO FIFO.  By default 0.1% of the root
  78 volume's size is used, with a reasonable minimum and a reasonable cap.
  79 The UNDO FIFO is used to sequence meta-data out to the media for instant
  80 crash recovery.
  81 .El
  82 .\".Sh NOTES
  83 .Sh EXAMPLES
  84 .Bd -literal -offset indent
  85 newfs_hammer -L Home /dev/ad0s1d
  86 .Ed
  87 .Pp
  88 Create a file system named
  89 .Sq Home
  90 on
  91 .Pa /dev/ad0s1d .
  92 .Sh DIAGNOSTICS
  93 Exit status is 0 on success and 1 on error.
  94 .Sh SEE ALSO
  95 .Xr disklabel 8 ,
  96 .Xr disklabel64 8 ,
  97 .Xr fdisk 8 ,
  98 .Xr newfs 8
  99 .Sh HISTORY
 100 The
 101 .Nm
 102 utility first appeared in
 103 .Dx 1.11 .
 104 .Sh AUTHORS
 105 .An Matthew Dillon Aq dillon@backplane.com