Add the 'hammer' utility. This is going to be a catch-all for various
[dragonfly.git] / 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.1 2008/01/01 00:57:57 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 .Ar command
43 .Ar ...
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility provides miscellanious functions related to managing a HAMMER
48 filesystem.
49 .Pp
50 The options are as follows:
51 .Bl -tag -width indent
52 .It Fl h
53 Get help
54 .El
55 .Pp
56 The commands are as follows:
57 .Bl -tag -width indent
58 .It Ar now
59 Generate a timestamp suitable for use in the @@ filename extension,
60 representing right now.
61 .It Ar stamp
62 Generate a timestamp suitable for use in the @@ filename extension.
63 A time specification of
64 .Pf yyyymmdd Oo :hhmmss Oc Ns Op .fractional
65 specifies an exact as-of timestamp in local (not UTC) time.
66 Set the TZ environment variable prior to running
67 .Nm
68 if you wish to specify the time by some other means.
69 .El
70 .Sh EXAMPLES
71 .Sh DIAGNOSTICS
72 Exit status is 0 on success and 1 on error.
73 .Sh SEE ALSO
74 .Xr newfs_hammer 8
75 .Sh HISTORY
76 The
77 .Nm
78 utility first appeared in
79 .Dx 1.11 .
80 .Sh AUTHORS
81 .An Matthew Dillon Aq dillon@backplane.com