xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-bookmark.8 (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1.\"
2.\" CDDL HEADER START
3.\"
4.\" The contents of this file are subject to the terms of the
5.\" Common Development and Distribution License (the "License").
6.\" You may not use this file except in compliance with the License.
7.\"
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9.\" or http://www.opensolaris.org/os/licensing.
10.\" See the License for the specific language governing permissions
11.\" and limitations under the License.
12.\"
13.\" When distributing Covered Code, include this CDDL HEADER in each
14.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15.\" If applicable, add the following below this CDDL HEADER, with the
16.\" fields enclosed by brackets "[]" replaced with your own identifying
17.\" information: Portions Copyright [yyyy] [name of copyright owner]
18.\"
19.\" CDDL HEADER END
20.\"
21.\"
22.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28.\" Copyright (c) 2014 Integros [integros.com]
29.\" Copyright 2019 Richard Laager. All rights reserved.
30.\" Copyright 2018 Nexenta Systems, Inc.
31.\" Copyright 2019 Joyent, Inc.
32.\" Copyright (c) 2019, 2020 by Christian Schwarz. All Rights Reserved.
33.\"
34.Dd June 30, 2019
35.Dt ZFS-BOOKMARK 8 SMM
36.Os
37.Sh NAME
38.Nm zfs-bookmark
39.Nd Creates a bookmark of the given snapshot.
40.Sh SYNOPSIS
41.Sh DESCRIPTION
42.Bl -tag -width ""
43.It Xo
44.Nm zfs
45.Cm bookmark
46.Ar snapshot Ns | Ns Ar bookmark newbookmark
47.Xc
48Creates a new bookmark of the given snapshot or bookmark.
49Bookmarks mark the point in time when the snapshot was created, and can be used
50as the incremental source for a
51.Xr zfs-send 8
52command.
53.Pp
54When creating a bookmark from an existing redaction bookmark, the resulting
55bookmark is
56.Sy not
57a redaction bookmark.
58.Pp
59This feature must be enabled to be used.
60See
61.Xr zpool-features 5
62for details on ZFS feature flags and the
63.Sy bookmarks
64feature.
65.El
66.Sh SEE ALSO
67.Xr zfs-destroy 8 ,
68.Xr zfs-send 8 ,
69.Xr zfs-snapshot 8
70