newfs_hammer(8): Update man page and program messages
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Mon, 28 Sep 2009 01:01:43 +0000 (03:01 +0200)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Mon, 28 Sep 2009 17:26:41 +0000 (19:26 +0200)
 * add `B' / `byte' in a few places

 * sort options

 * sync usage() to synopsis

 * improve markup

sbin/newfs_hammer/newfs_hammer.8
sbin/newfs_hammer/newfs_hammer.c

index a1a6508..0d2cee5 100644 (file)
@@ -31,7 +31,7 @@
 .\" SUCH DAMAGE.
 .\" 
 .\" $DragonFly: src/sbin/newfs_hammer/newfs_hammer.8,v 1.10 2008/07/27 16:47:19 thomas Exp $
-.Dd July 24, 2008
+.Dd September 28, 2009
 .Dt NEWFS_HAMMER 8
 .Os
 .Sh NAME
@@ -40,8 +40,8 @@
 .Sh SYNOPSIS
 .Nm
 .Fl L Ar label
-.Op Fl b Ar bootsize
 .Op Fl f
+.Op Fl b Ar bootsize
 .Op Fl m Ar savesize
 .Op Fl u Ar undosize
 .Op Fl V Ar version
@@ -51,7 +51,7 @@ The
 .Nm
 utility creates a
 .Nm HAMMER
-file system on device
+file system on device(s)
 .Ar special .
 If multiple devices are specified a single
 .Nm HAMMER
@@ -78,22 +78,26 @@ labels
 or in
 .Xr disklabel 5
 partitions which do not overlap the label area (have a starting sector
-greater then 16).
+greater than 16).
 .Pp
 .Nm HAMMER
-filesystems are designed for large storage systems, up to 1 Exabyte, and
+file systems are designed for large storage systems, up to 1 Exabyte, and
 will not operate efficiently on small storage systems.
-The minimum recommended filesystem size is 50GB.
+The minimum recommended file system size is 50GB.
 .Nm HAMMER
 must reserve 500MB to 1GB of its storage for reblocking and UNDO.
-In addition, HAMMER filesystems operating normally, with full history
+In addition,
+.Nm HAMMER
+file systems operating normally, with full history
 retention and daily snapshots, do not immediately reclaim space when
 files are deleted.
-A regular system maintenance cron job runs once a day to handle reclamation.
+A regular system maintenance job runs once a day by
+.Xr periodic 8
+to handle reclamation.
 .Pp
 .Nm HAMMER
 works best when the machine's normal workload would not otherwise fill
-the filesystem up in the course of 60 days of operation.
+the file system up in the course of 60 days of operation.
 .Pp
 The options are as follows:
 .Bl -tag -width indent
@@ -111,7 +115,7 @@ By default a boot area of approximately 4MB will be created.
 .It Fl f
 Force the creation of a
 .Nm HAMMER
-file system with less than 100M UNDO FIFO.
+file system with less than 100MB UNDO FIFO.
 This should not be used under normal circumstances.
 .It Fl m Ar savesize
 Specify a fixed area which
@@ -131,13 +135,19 @@ volume's size is used, with a reasonable minimum and a reasonable cap.
 The UNDO FIFO is used to sequence meta-data out to the media for instant
 crash recovery.
 .It Fl V Ar version
-Specify the HAMMER filesystem version to format.
+Specify the
+.Nm HAMMER
+file system version to format.
 By default
 .Nm
-formats the filesystem using the highest production version number
-supported by the HAMMER VFS by checking the vfs.hammer.supported_version
+formats the file system using the highest production version number
+supported by the
+.Nm HAMMER
+VFS by checking the
+.Va vfs.hammer.supported_version
 sysctl.
-If you need to maintain compatibility with an older version of HAMMER
+If you need to maintain compatibility with an older version of
+.Nm HAMMER
 you may specify the version with this option.
 .El
 .Pp
@@ -150,7 +160,7 @@ can be given with a suffix of
 .Cm K , M , G
 or
 .Cm T
-meaning kilo, mega, giga and tera.
+meaning kilobyte, megabyte, gigabyte and terabyte.
 Lower case can also be used for suffix.
 .Sh EXAMPLES
 .Bd -literal -offset indent
index 731847a..db67d56 100644 (file)
@@ -106,11 +106,11 @@ main(int ac, char **av)
                                         HAMMER_LARGEBLOCK_SIZE *
                                         HAMMER_UNDO_LAYER2, 2);
                        if (UndoBufferSize < 100*1024*1024 && ForceOpt == 0)
-                               errx(1, "The minimum UNDO fifo size is 100M\n");
+                               errx(1, "The minimum UNDO fifo size is 100MB\n");
                        if (UndoBufferSize < 100*1024*1024) {
                                fprintf(stderr, 
                                        "WARNING: you have specified an UNDO "
-                                       "FIFO size less than 100M, which may\n"
+                                       "FIFO size less than 100MB, which may\n"
                                        "lead to VFS panics.\n");
                        }
                        break;
@@ -133,7 +133,7 @@ main(int ac, char **av)
        if (label == NULL) {
                fprintf(stderr,
                        "newfs_hammer: A filesystem label must be specified\n");
-               exit(1);
+               usage();
        }
 
        if (HammerVersion < 0) {
@@ -145,7 +145,7 @@ main(int ac, char **av)
                                HammerVersion = HAMMER_VOL_VERSION_WIP - 1;
                                fprintf(stderr,
                                        "newfs_hammer: WARNING: HAMMER VFS "
-                                       "supports higher version then I "
+                                       "supports higher version than I "
                                        "understand,\n"
                                        "using version %d\n",
                                        HammerVersion);
@@ -246,13 +246,13 @@ main(int ac, char **av)
        printf("fsid:                %s\n", fsidstr);
        printf("\n");
        printf("NOTE: Please remember that you may have to manually set up a\n"
-               "cron job to prune and reblock the filesystem regularly.\n"
+               "cron(8) job to prune and reblock the filesystem regularly.\n"
                "By default, the system automatically runs 'hammer cleanup'\n"
                "on a nightly basis. The periodic.conf(5) variable\n"
                "'daily_clean_hammer_enable' can be unset to disable this.\n"
                "Also see 'man hammer' and 'man HAMMER' for more information.\n");
        if (total < 50*GIG) {
-               printf("\nWARNING: HAMMER filesystems less than 50G are "
+               printf("\nWARNING: HAMMER filesystems less than 50GB are "
                        "not recommended!\n"
                        "You may have to run 'hammer prune-everything' and "
                        "'hammer reblock'\n"
@@ -267,8 +267,8 @@ void
 usage(void)
 {
        fprintf(stderr,
-               "newfs_hammer -L label [-b bootsize] [-m savesize] [-u undosize] "
-                       "special ...\n"
+               "usage: newfs_hammer -L label [-f] [-b bootsize] [-m savesize] [-u undosize]\n"
+               "                    [-V version] special ...\n"
        );
        exit(1);
 }
@@ -512,7 +512,7 @@ format_volume(struct volume_info *vol, int nvols, const char *label,
                if (freebytes < 1*GIG && ForceOpt == 0) {
                        errx(1, "Cannot create a HAMMER filesystem less than "
                                "1GB unless you use -f.  HAMMER filesystems\n"
-                               "less than 50G are not recommended\n");
+                               "less than 50GB are not recommended\n");
                }
                        
                for (i = 8; i < HAMMER_MAX_ZONES; ++i) {