MFC r1.11 (HEAD):
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Tue, 16 Sep 2008 21:39:25 +0000 (16 21:39 +0000)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Tue, 16 Sep 2008 21:39:25 +0000 (16 21:39 +0000)
Add note that NFS exporting PFSs isn't supported yet.

Add example crontab line to the prune section.

Update hammer.5:
 - expand description on reblocking and pruning a bit
 - correct no. PFS supported (PFS 0 is used for hammer file system)
 - add mirror-stream and mirror-read-stream reference

share/man/man5/hammer.5

index bed1581..d12a356 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.2.2.3 2008/07/25 03:16:12 swildner Exp $
+.\" $DragonFly: src/share/man/man5/hammer.5,v 1.2.2.4 2008/09/16 21:39:25 thomas Exp $
 .\"
-.Dd July 24, 2008
+.Dd September 9, 2008
 .Os
 .Dt HAMMER 5
 .Sh NAME
@@ -136,14 +136,17 @@ Related
 .Xr hammer 8
 commands:
 .Ar history ,
-.Ar snapshot
-.Ss Reblocking & Pruning
-Reblocking will reorder all elements and thus defragment the file system and
-free space for reuse.
+.Ar snapshot ;
+see also
+.Xr undo 1
+.Ss Pruning & Reblocking
 Pruning is the act of deleting file system history.
 Only history used by the given snapshots and history from after the latest
 snapshot will be retained.
 All other history is deleted.
+Reblocking will reorder all elements and thus defragment the file system and
+free space for reuse.
+After pruning a file system must be reblocked to recover all available space.
 .Pp
 Related
 .Xr hammer 8
@@ -163,7 +166,7 @@ mirroring feature uses
 (PFSs).
 A
 .Nm
-file system supports up to 65536 PFSs.
+file system supports up to 65535 PFSs.
 Multiple slaves per master are supported, but multiple masters per slave
 are not.
 Slaves are always read-only.
@@ -180,7 +183,9 @@ commands:
 .Ar pfs-upgrade ,
 .Ar pfs-downgrade ,
 .Ar mirror-copy ,
+.Ar mirror-stream ,
 .Ar mirror-read ,
+.Ar mirror-read-stream ,
 .Ar mirror-write ,
 .Ar mirror-dump
 .Sh EXAMPLES
@@ -224,7 +229,7 @@ for example, to reblock the
 .Pa /home
 file system every night at 2:15 for up to 5 minutes:
 .Bd -literal
-15 2 * * * hammer -c /var/run/Home -t 300 reblock /home >/dev/null 2>&1
+15 2 * * * hammer -c /var/run/Home.reblock -t 300 reblock /home >/dev/null 2>&1
 .Ed
 .Ss Snapshots
 The
@@ -262,6 +267,12 @@ Unless the file system is mounted with the
 option, it might be advisable to also set up
 .Xr cron 8
 jobs for pruning no longer used historical data regularly.
+For example, to prune the
+.Pa /snaps
+directory every night at 3:15 for up to 5 minutes:
+.Bd -literal
+15 3 * * * hammer -c /var/run/snaps.prune -t 300 prune /snaps >/dev/null 2>&1
+.Ed
 .Ss Mirroring
 Mirroring can be set up using
 .Nm Ap s
@@ -316,3 +327,12 @@ file system was designed and implemented by
 .An Matthew Dillon Aq dillon@backplane.com .
 This manual page was written by
 .An Sascha Wildner .
+.Sh BUGS
+NFS exporting
+.Nm
+PFSs
+isn't supported yet.
+A
+.Nm
+file system with PFSs defined can be NFS exported,
+but don't export directories which contains PFSs.