Clean up a bit.
[dragonfly.git] / share / man / man5 / hammer.5
index e8b465b..d6e93bf 100644 (file)
@@ -29,9 +29,9 @@
 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $DragonFly: src/share/man/man5/hammer.5,v 1.14 2008/10/22 20:15:55 swildner Exp $
+.\" $DragonFly: src/share/man/man5/hammer.5,v 1.15 2008/11/02 18:56:47 swildner Exp $
 .\"
-.Dd October 22, 2008
+.Dd November 2, 2008
 .Os
 .Dt HAMMER 5
 .Sh NAME
@@ -61,21 +61,15 @@ To mount via
 The
 .Nm
 file system provides facilities to store file system data onto disk devices
-and is intended to replace UFS as the default file system for
+and is intended to replace
+.Xr ffs 5
+as the default file system for
 .Dx .
 Among its features are instant crash recovery,
 large file systems spanning multiple volumes,
 data integrity checking,
 fine grained history retention,
 mirroring capability, and pseudo file systems.
-For a more detailed introduction refer to the paper listed in the
-.Sx SEE ALSO
-section.
-For some common usages of
-.Nm
-see the
-.Sx EXAMPLES
-section below.
 .Pp
 All functions related to managing
 .Nm
@@ -86,6 +80,15 @@ file systems are provided by the
 and
 .Xr undo 1
 utilities.
+.Pp
+For a more detailed introduction refer to the paper and slides listed in the
+.Sx SEE ALSO
+section.
+For some common usages of
+.Nm
+see the
+.Sx EXAMPLES
+section below.
 .Ss Instant Crash Recovery
 After a non-graceful system shutdown,
 .Nm
@@ -127,8 +130,10 @@ The
 .Nm
 file system uses 64 bit, hexadecimal transaction IDs to refer to historical
 file or directory data.
-An ID has the format
-.Li 0x%016llx ,
+An ID has the
+.Xr printf 3
+format
+.Li %#016llx ,
 such as
 .Li 0x00000001061a8ba6 .
 .Pp
@@ -154,6 +159,7 @@ again upon the next prune & reblock operations.
 Related
 .Xr hammer 8
 commands:
+.Ar cleanup ,
 .Ar history ,
 .Ar snapshot ;
 see also
@@ -174,13 +180,14 @@ option.
 Related
 .Xr hammer 8
 commands:
+.Ar cleanup ,
+.Ar prune ,
+.Ar prune-everything ,
 .Ar reblock ,
 .Ar reblock-btree ,
 .Ar reblock-inodes ,
 .Ar reblock-dirs ,
-.Ar reblock-data ,
-.Ar prune ,
-.Ar prune-everything
+.Ar reblock-data
 .Ss Mirroring & Pseudo File Systems
 In order to allow inode numbers to be duplicated on the slaves
 .Nm Ap s
@@ -225,10 +232,10 @@ commands:
 file systems support NFS export.
 NFS export of PFSs is done using
 .Nm null
-mounts, e.g.\&
-to export the PFS
+mounts.
+For example, to export the PFS
 .Pa /hammer/pfs/data ,
-make a
+create a
 .Nm null
 mount, e.g.\& to
 .Pa /hammer/data
@@ -258,14 +265,14 @@ Note that all
 .Nm
 file systems must have a unique name on a per-machine basis.
 .Bd -literal -offset indent
-newfs_hammer -L Home /dev/ad0s1d
+newfs_hammer -L HOME /dev/ad0s1d
 mount_hammer /dev/ad0s1d /home
 .Ed
 .Pp
 Similarly, multi volume file systems can be created and mounted by
 specifying additional arguments.
 .Bd -literal -offset indent
-newfs_hammer -L MultiHome /dev/ad0s1d /dev/ad1s1d
+newfs_hammer -L MULTIHOME /dev/ad0s1d /dev/ad1s1d
 mount_hammer /dev/ad0s1d /dev/ad1s1d /home
 .Ed
 .Pp
@@ -277,6 +284,7 @@ For this it is recommended to use the
 .Xr hammer 8
 .Ar cleanup
 metacommand.
+.Pp
 By default,
 .Dx
 is set up to run
@@ -284,12 +292,13 @@ is set up to run
 nightly via
 .Xr periodic 8 .
 .Pp
-It is also possible to make these operations individually.
+It is also possible to perform these operations individually via
+.Xr crontab 5 .
 For example, to reblock the
 .Pa /home
 file system every night at 2:15 for up to 5 minutes:
 .Bd -literal -offset indent
-15 2 * * * hammer -c /var/run/Home.reblock -t 300 reblock /home \e
+15 2 * * * hammer -c /var/run/HOME.reblock -t 300 reblock /home \e
        >/dev/null 2>&1
 .Ed
 .Ss Snapshots
@@ -312,6 +321,14 @@ point to the state of the
 .Pa /home
 directory at the time each snapshot was taken, and could now be used to copy
 the data somewhere else for backup purposes.
+.Pp
+By default,
+.Dx
+is set up to create nightly snapshots of all
+.Nm
+file systems via
+.Xr periodic 8
+and to keep them for 60 days.
 .Ss Pruning
 A snapshot directory is also the argument to the
 .Xr hammer 8 Ap s
@@ -400,6 +417,7 @@ Add to
 .Xr md5 1 ,
 .Xr tar 1 ,
 .Xr undo 1 ,
+.Xr ffs 5 ,
 .Xr disklabel64 8 ,
 .Xr gpt 8 ,
 .Xr hammer 8 ,
@@ -409,8 +427,15 @@ Add to
 .Rs
 .%A Matthew Dillon
 .%D June 2008
+.%O http://www.dragonflybsd.org/hammer/hammer.pdf
 .%T "The HAMMER Filesystem"
 .Re
+.Rs
+.%A Matthew Dillon
+.%D October 2008
+.%O http://www.dragonflybsd.org/hammer/nycbsdcon/
+.%T "Slideshow from NYCBSDCon 2008"
+.Re
 .Sh HISTORY
 The
 .Nm