aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKirk McKusick <mckusick@FreeBSD.org>2023-03-06 05:37:23 +0000
committerKirk McKusick <mckusick@FreeBSD.org>2023-03-20 05:22:06 +0000
commit24ed6ac445497ce2489c7be1723462030eef47d4 (patch)
tree3a8d8d68a7cd0d3979e6ce520f6600b2175db63b
parent799d67ec407f6d93b00b7d8a364a3284aeb5d07f (diff)
downloadsrc-24ed6ac445497ce2489c7be1723462030eef47d4.tar.gz
src-24ed6ac445497ce2489c7be1723462030eef47d4.zip
FFS/UFS snapshots: improve documentation.
This update provides a more detailed description of FFS/UFS snapshots and adds links to useful man pages. Requested by: Graham Perrin Submitted by: darius-dons.net.au Reviewed by: Ravi Pokala PR: 266358 Differential Revision: https://reviews.freebsd.org/D38817 (cherry picked from commit 528d8e55c8d338e78fa4e6c9f182e8975f75199a)
-rw-r--r--sbin/mksnap_ffs/mksnap_ffs.829
1 files changed, 23 insertions, 6 deletions
diff --git a/sbin/mksnap_ffs/mksnap_ffs.8 b/sbin/mksnap_ffs/mksnap_ffs.8
index 201014522721..658502cffdcb 100644
--- a/sbin/mksnap_ffs/mksnap_ffs.8
+++ b/sbin/mksnap_ffs/mksnap_ffs.8
@@ -32,9 +32,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $FreeBSD$
-.\"
-.Dd October 3, 2016
+.Dd March 5, 2023
.Dt MKSNAP_FFS 8
.Os
.Sh NAME
@@ -48,6 +46,18 @@ The
.Nm
utility creates a snapshot named
.Ar snapshot_name .
+This name is a path in the file system being snapshotted.
+Typically this is under the
+.Pa .snap
+directory in the root of the file system, but it can
+be anywhere.
+Snapshots can be listed using the
+.Xr snapinfo 8
+command.
+.Pp
+After a snapshot is taken it appears as a file.
+The file is the size of the file system from which it was taken.
+It can be moved, renamed or deleted (which removes the snapshot).
.Pp
The group ownership of the file is set to
.Dq Li operator ;
@@ -62,15 +72,22 @@ Create a snapshot of
.Pa /usr/home
file system and mount the snapshot elsewhere:
.Bd -literal -offset indent
-mksnap_ffs /usr/home/snapshot
-mdconfig -a -t vnode -o readonly -f /usr/home/snapshot
+mksnap_ffs /usr/home/.snap/snap1
+mdconfig -a -t vnode -o readonly -f /usr/home/.snap/snap1
mount -o ro /dev/md0 /mnt/
.Ed
+.Pp
+Delete a snapshot:
+.Bd -literal -offset indent
+rm /usr/home/.snap/snap1
+.Ed
.Sh SEE ALSO
+.Xr rm 1 ,
.Xr chmod 2 ,
.Xr chown 8 ,
.Xr mdconfig 8 ,
-.Xr mount 8
+.Xr mount 8 ,
+.Xr snapinfo 8
.Sh HISTORY
The
.Nm