diff docs/man/man8/fzfs-clone-tree.rst @ 520:7d08fd78775c

fzfs: implement "fzfs clone-tree". Clone a ZFS dataset tree and preserve locally set properties.
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 01 Sep 2024 21:34:27 +0200
parents
children c05ef1c86c9c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/fzfs-clone-tree.rst	Sun Sep 01 21:34:27 2024 +0200
@@ -0,0 +1,53 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+fzfs-clone-tree
+===============
+
+.. program:: fzfs clone-tree
+
+
+Synopsis
+--------
+
+**fzfs clone-tree** [**-n**] `source-dataset` `dest-dataset`
+
+
+Description
+-----------
+
+Clone the ZFS snapshot that is rooted at `source-dataset` and all
+descendent snapshots into the destination dataset rooted at
+`dest-dataset`.
+
+`source-dataset` must be a snapshot. All of its children must have a
+snapshot with the very same snapshot.
+
+`dest-dataset` must not exist already.
+
+All properties that are of type ``local`` or ``received``are copied to the
+destination. This is also true for ``canmount`` and ``mountpoint``.
+
+The cloned datasets will are *not* mounted automatically.
+
+If something fails it is tried to delete the intermediately created
+datasets.
+
+
+Options
+-------
+
+.. option:: -n
+
+   Dry-run. Do not really clone datasets but show what would be done.
+
+
+Environment
+-----------
+
+All environment variables that affect :command:`zfs` are effective also.
+
+
+See Also
+--------
+
+:manpage:`fzfs(8)`