Add some examples and move some stuff around.
authorSascha Wildner <swildner@dragonflybsd.org>
Wed, 16 Jul 2008 20:39:28 +0000 (20:39 +0000)
committerSascha Wildner <swildner@dragonflybsd.org>
Wed, 16 Jul 2008 20:39:28 +0000 (20:39 +0000)
share/man/man5/hammer.5

index 88ccf6c..0aaea6c 100644 (file)
@@ -29,7 +29,7 @@
 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $DragonFly: src/share/man/man5/hammer.5,v 1.1 2008/07/16 12:45:13 swildner Exp $
+.\" $DragonFly: src/share/man/man5/hammer.5,v 1.2 2008/07/16 20:39:28 swildner Exp $
 .\"
 .Dd July 16, 2008
 .Os
@@ -60,31 +60,15 @@ and is intended to replace UFS as the default file system for
 Among its features are fine grained history retention, file systems spanning
 multiple volumes, mirroring capability, and pseudo file systems.
 .Pp
+All functions related to managing
 .Nm
-file systems are constructed with
-.Xr newfs_hammer 8
-and mounted with
-.Xr mount_hammer 8 .
-All other functions related to managing a
-.Nm
-file system are provided by the
-.Xr hammer 8
+file systems are provided by the
+.Xr newfs_hammer 8 ,
+.Xr mount_hammer 8 ,
+.Xr hammer 8 ,
 and
 .Xr undo 1
 utilities.
-.Pp
-.Em NOTE:
-It is recommended that a nightly
-.Xr cron 8
-job be set up to reblock each
-.Nm
-file system over a longer period of time (using the
-.Fl c
-and
-.Fl t
-options of the
-.Xr hammer 8
-utility), for example up to 5 minutes every night.
 .Ss Transaction IDs
 The
 .Nm
@@ -111,7 +95,46 @@ Removing the symbolic link enables the file system to reclaim the space
 again.
 .\".Ss Mirroring
 .\".Ss Pseudo File Systems
-.\".Sh EXAMPLES
+.Sh EXAMPLES
+.Ss Preparing the file system
+To create and mount a
+.Nm
+file system use the
+.Xr newfs_hammer 8
+and
+.Xr mount_hammer 8
+commands.
+Note that all
+.Nm
+file systems must have a unique name on a per-machine basis.
+.Bd -literal
+newfs_hammer -L Home /dev/ad0s1d
+mount_hammer /dev/ad0s1d /home
+.Ed
+.Pp
+Similarly, multi volume file systems can be created and mounted by just
+specifying more arguments.
+.Bd -literal
+newfs_hammer -L MultiHome /dev/ad0s1d /dev/ad1s1d
+mount_hammer /dev/ad0s1d /dev/ad1s1d /home
+.Ed
+.Pp
+Once created and mounted,
+.Nm
+file systems need to be reblocked periodically in order not to fill up
+over time, either manually or with a
+.Xr cron 8
+job.
+It is recommended that the
+.Xr hammer 8
+utility's
+.Fl c
+and
+.Fl t
+options be used for this job (for example, every night up to 5 minutes).
+.Bd -literal
+2 15 * * * hammer -c /var/run/Home -t 300 reblock /home >/dev/null 2>&1
+.Ed
 .Sh SEE ALSO
 .Xr undo 1 ,
 .Xr hammer 8 ,