xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-bookmark.8 (revision 271171e0d97b88ba2a7c3bf750c9672b484c1c13)
1eda14cbcSMatt Macy.\"
2eda14cbcSMatt Macy.\" CDDL HEADER START
3eda14cbcSMatt Macy.\"
4eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7eda14cbcSMatt Macy.\"
8eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*271171e0SMartin Matuska.\" or https://opensource.org/licenses/CDDL-1.0.
10eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11eda14cbcSMatt Macy.\" and limitations under the License.
12eda14cbcSMatt Macy.\"
13eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18eda14cbcSMatt Macy.\"
19eda14cbcSMatt Macy.\" CDDL HEADER END
20eda14cbcSMatt Macy.\"
21eda14cbcSMatt Macy.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
22eda14cbcSMatt Macy.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
23eda14cbcSMatt Macy.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
24eda14cbcSMatt Macy.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25eda14cbcSMatt Macy.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
26eda14cbcSMatt Macy.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
27eda14cbcSMatt Macy.\" Copyright (c) 2014 Integros [integros.com]
28eda14cbcSMatt Macy.\" Copyright 2019 Richard Laager. All rights reserved.
29eda14cbcSMatt Macy.\" Copyright 2018 Nexenta Systems, Inc.
30eda14cbcSMatt Macy.\" Copyright 2019 Joyent, Inc.
31eda14cbcSMatt Macy.\" Copyright (c) 2019, 2020 by Christian Schwarz. All Rights Reserved.
32eda14cbcSMatt Macy.\"
33716fd348SMartin Matuska.Dd May 12, 2022
3416038816SMartin Matuska.Dt ZFS-BOOKMARK 8
35eda14cbcSMatt Macy.Os
3616038816SMartin Matuska.
37eda14cbcSMatt Macy.Sh NAME
387877fdebSMatt Macy.Nm zfs-bookmark
3916038816SMartin Matuska.Nd create bookmark of ZFS snapshot
40eda14cbcSMatt Macy.Sh SYNOPSIS
417877fdebSMatt Macy.Nm zfs
42eda14cbcSMatt Macy.Cm bookmark
4316038816SMartin Matuska.Ar snapshot Ns | Ns Ar bookmark
4416038816SMartin Matuska.Ar newbookmark
4516038816SMartin Matuska.
4616038816SMartin Matuska.Sh DESCRIPTION
47eda14cbcSMatt MacyCreates a new bookmark of the given snapshot or bookmark.
48eda14cbcSMatt MacyBookmarks mark the point in time when the snapshot was created, and can be used
49eda14cbcSMatt Macyas the incremental source for a
5016038816SMartin Matuska.Nm zfs Cm send .
51eda14cbcSMatt Macy.Pp
52eda14cbcSMatt MacyWhen creating a bookmark from an existing redaction bookmark, the resulting
53eda14cbcSMatt Macybookmark is
5416038816SMartin Matuska.Em not
55eda14cbcSMatt Macya redaction bookmark.
56eda14cbcSMatt Macy.Pp
57eda14cbcSMatt MacyThis feature must be enabled to be used.
58eda14cbcSMatt MacySee
593ff01b23SMartin Matuska.Xr zpool-features 7
60eda14cbcSMatt Macyfor details on ZFS feature flags and the
61eda14cbcSMatt Macy.Sy bookmarks
62eda14cbcSMatt Macyfeature.
6316038816SMartin Matuska.
64da5137abSMartin Matuska.Sh EXAMPLES
65da5137abSMartin Matuska.\" These are, respectively, examples 23 from zfs.8
66da5137abSMartin Matuska.\" Make sure to update them bidirectionally
67da5137abSMartin Matuska.Ss Example 1 : No Creating a bookmark
68716fd348SMartin MatuskaThe following example creates a bookmark to a snapshot.
69716fd348SMartin MatuskaThis bookmark can then be used instead of a snapshot in send streams.
70da5137abSMartin Matuska.Dl # Nm zfs Cm bookmark Ar rpool Ns @ Ns Ar snapshot rpool Ns # Ns Ar bookmark
71da5137abSMartin Matuska.
72eda14cbcSMatt Macy.Sh SEE ALSO
73eda14cbcSMatt Macy.Xr zfs-destroy 8 ,
74eda14cbcSMatt Macy.Xr zfs-send 8 ,
75eda14cbcSMatt Macy.Xr zfs-snapshot 8
76