sbin/hammer/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/hammer/hammer.8,v 1.3 2008/01/24 02:16:47 dillon Exp $
  34 .Dd December 31, 2007
  35 .Dt HAMMER 8
  36 .Os
  37 .Sh NAME
  38 .Nm hammer
  39 .Nd HAMMER file system utility
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl hr
  43 .Op Fl f Ar blkdev[:blkdev]*
  44 .Ar command
  45 .Ar ...
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility provides miscellanious functions related to managing a HAMMER
  50 filesystem.
  51 .Pp
  52 The options are as follows:
  53 .Bl -tag -width indent
  54 .It Fl h
  55 Get help
  56 .It Fl r
  57 Specify recursion for those commands which support it.
  58 .It Fl f Ar blkdev[:blkdev]*
  59 Specify the volumes making up a HAMMER filesystem.
  60 .El
  61 .Pp
  62 The commands are as follows:
  63 .Bl -tag -width indent
  64 .It Ar now
  65 Generate a timestamp suitable for use in the @@ filename extension,
  66 representing right now.
  67 .It Ar stamp
  68 Generate a timestamp suitable for use in the @@ filename extension.
  69 A time specification of
  70 .Pf yyyymmdd Oo :hhmmss Oc Ns Op .fractional
  71 specifies an exact as-of timestamp in local (not UTC) time.
  72 Set the TZ environment variable prior to running
  73 .Nm
  74 if you wish to specify the time by some other means.
  75 .It Ar show Op vol_no[:clu_no]
  76 Dump the B-Tree starting at the specified volume and cluster, or
  77 at the root volume if not specified.
  78 The B-Tree is dumped recursively if the
  79 .Fl r
  80 option is specified.
  81 .It Ar namekey Ar filename
  82 Generate a HAMMER 64 bit directory hash for the specified file name.
  83 The low 32 bits are used as an iterator for hash collisions and will be
  84 output as 0.
  85 .It Ar namekey32 Ar filename
  86 Generate the top 32 bits of a HAMMER 64 bit directory hash for the specified
  87 file name.
  88 .El
  89 .Sh EXAMPLES
  90 .Sh DIAGNOSTICS
  91 Exit status is 0 on success and 1 on error.
  92 .Sh SEE ALSO
  93 .Xr newfs_hammer 8
  94 .Sh HISTORY
  95 The
  96 .Nm
  97 utility first appeared in
  98 .Dx 1.11 .
  99 .Sh AUTHORS
 100 .An Matthew Dillon Aq dillon@backplane.com