man/man8/zfs-bookmark.8

   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 https://opensource.org/licenses/CDDL-1.0.
  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 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
  22 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  23 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
  24 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  25 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
  26 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
  27 .\" Copyright (c) 2014 Integros [integros.com]
  28 .\" Copyright 2019 Richard Laager. All rights reserved.
  29 .\" Copyright 2018 Nexenta Systems, Inc.
  30 .\" Copyright 2019 Joyent, Inc.
  31 .\" Copyright (c) 2019, 2020 by Christian Schwarz. All Rights Reserved.
  32 .\"
  33 .Dd May 12, 2022
  34 .Dt ZFS-BOOKMARK 8
  35 .Os
  36 .
  37 .Sh NAME
  38 .Nm zfs-bookmark
  39 .Nd create bookmark of ZFS snapshot
  40 .Sh SYNOPSIS
  41 .Nm zfs
  42 .Cm bookmark
  43 .Ar snapshot Ns | Ns Ar bookmark
  44 .Ar newbookmark
  45 .
  46 .Sh DESCRIPTION
  47 Creates a new bookmark of the given snapshot or bookmark.
  48 Bookmarks mark the point in time when the snapshot was created, and can be used
  49 as the incremental source for a
  50 .Nm zfs Cm send .
  51 .Pp
  52 When creating a bookmark from an existing redaction bookmark, the resulting
  53 bookmark is
  54 .Em not
  55 a redaction bookmark.
  56 .Pp
  57 This feature must be enabled to be used.
  58 See
  59 .Xr zpool-features 7
  60 for details on ZFS feature flags and the
  61 .Sy bookmarks
  62 feature.
  63 .
  64 .Sh EXAMPLES
  65 .\" These are, respectively, examples 23 from zfs.8
  66 .\" Make sure to update them bidirectionally
  67 .Ss Example 1 : No Creating a bookmark
  68 The following example creates a bookmark to a snapshot.
  69 This bookmark can then be used instead of a snapshot in send streams.
  70 .Dl # Nm zfs Cm bookmark Ar rpool Ns @ Ns Ar snapshot rpool Ns # Ns Ar bookmark
  71 .
  72 .Sh SEE ALSO
  73 .Xr zfs-destroy 8 ,
  74 .Xr zfs-send 8 ,
  75 .Xr zfs-snapshot 8