Module Name: src
Committed By: pgoyette
Date: Fri Jul 29 05:20:33 UTC 2016
Modified Files:
src/usr.sbin/fssconfig: fssconfig.8
Log Message:
Improve wording, enhance the example
To generate a diff of this commit:
cvs rdiff -u -r1.11 -r1.12 src/usr.sbin/fssconfig/fssconfig.8
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.sbin/fssconfig/fssconfig.8
diff -u src/usr.sbin/fssconfig/fssconfig.8:1.11 src/usr.sbin/fssconfig/fssconfig.8:1.12
--- src/usr.sbin/fssconfig/fssconfig.8:1.11 Fri Nov 15 09:13:57 2013
+++ src/usr.sbin/fssconfig/fssconfig.8 Fri Jul 29 05:20:33 2016
@@ -1,4 +1,4 @@
-.\" $NetBSD: fssconfig.8,v 1.11 2013/11/15 09:13:57 hannken Exp $ */
+.\" $NetBSD: fssconfig.8,v 1.12 2016/07/29 05:20:33 pgoyette Exp $ */
.\"
.\"
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
@@ -28,7 +28,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd November 15, 2013
+.Dd July 29, 2016
.Dt FSSCONFIG 8
.Os
.Sh NAME
@@ -53,9 +53,11 @@ The
command configures file system snapshot pseudo disk devices.
It will associate the file system snapshot disk
.Ar device
-with a snapshot of
-.Ar path
-allowing the latter to be accessed as though it were a disk.
+with a snapshot of the file system mounted on
+.Ar path ,
+allowing
+.Ar device
+to be accessed as though it were a disk.
.Pp
If
.Ar backup
@@ -65,7 +67,7 @@ This snapshot is active until
is unlinked.
Persistent snapshots save the file system as if it had been unmounted.
Unlinked but open files get removed from the snapshot.
-The time to create a persistent snapshot increases with the size of the
+The time needed to create a persistent snapshot increases with the size of the
file system and decreases with the file system block size.
This snapshot mode is only supported for FFS file systems.
.Pp
@@ -84,9 +86,9 @@ Data is saved to
in units of
.Ar cluster
bytes.
-The snapshot is an image in time of the underlying block device.
+The snapshot is an image of the underlying block device at a moment in time.
Unlinked but open files are still present on the snapshot.
-The time to create a snapshot is independent of the size of the
+The time needed to create a snapshot is independent of the size of the
file system or the file system block size.
.Pp
Options indicate an action to be performed:
@@ -130,12 +132,14 @@ is assumed.
.El
.Sh EXAMPLES
.Dl fssconfig fss0 /usr /tmp/back
+.Dl mount /dev/fss0 /mnt
.Pp
Configures the snapshot device
.Pa fss0
-for a snapshot of the
+as a snapshot of the
.Pa /usr
-file system.
+file system, and makes the contents of the snapshot available via
+.Pa /mnt .
Data written through
.Pa /usr
will be backed up in
@@ -145,7 +149,7 @@ will be backed up in
.Pp
Configures the snapshot device
.Pa fss1
-for a snapshot of the
+as a snapshot of the
.Pa /
file system.
Data written through
@@ -162,6 +166,7 @@ device.
.Sh SEE ALSO
.Xr opendisk 3 ,
.Xr fss 4 ,
+.Xr dump 8 ,
.Xr mount 8 ,
.Xr umount 8
.Sh HISTORY
