xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-bookmark.8 (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1.\" SPDX-License-Identifier: CDDL-1.0
2.\"
3.\" CDDL HEADER START
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or https://opensource.org/licenses/CDDL-1.0.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.\" CDDL HEADER END
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 May 12, 2022
35.Dt ZFS-BOOKMARK 8
36.Os
37.
38.Sh NAME
39.Nm zfs-bookmark
40.Nd create bookmark of ZFS snapshot
41.Sh SYNOPSIS
42.Nm zfs
43.Cm bookmark
44.Ar snapshot Ns | Ns Ar bookmark
45.Ar newbookmark
46.
47.Sh DESCRIPTION
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.Nm zfs Cm send .
52.Pp
53When creating a bookmark from an existing redaction bookmark, the resulting
54bookmark is
55.Em not
56a redaction bookmark.
57.Pp
58This feature must be enabled to be used.
59See
60.Xr zpool-features 7
61for details on ZFS feature flags and the
62.Sy bookmarks
63feature.
64.
65.Sh EXAMPLES
66.\" These are, respectively, examples 23 from zfs.8
67.\" Make sure to update them bidirectionally
68.Ss Example 1 : No Creating a bookmark
69The following example creates a bookmark to a snapshot.
70This bookmark can then be used instead of a snapshot in send streams.
71.Dl # Nm zfs Cm bookmark Ar rpool Ns @ Ns Ar snapshot rpool Ns # Ns Ar bookmark
72.
73.Sh SEE ALSO
74.Xr zfs-destroy 8 ,
75.Xr zfs-send 8 ,
76.Xr zfs-snapshot 8
77