diff docs/man/man8/fzfs-copy-tree.rst @ 420:bf0d63c8e682

Begin fzfs-copy-tree: man page structure done
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 18 Sep 2023 09:43:12 +0200
parents
children a571a30bcf8a
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/fzfs-copy-tree.rst	Mon Sep 18 09:43:12 2023 +0200
@@ -0,0 +1,67 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+fzfs-copy-tree
+==============
+
+.. program:: fzfs copy-tree
+
+
+Synopsis
+--------
+
+**fzfs copy-tree** [**-A**] [**-M** `mountpoint`] [**-n**] [**-p**] [**-u**] `source-dataset` `dest-dataset`
+
+Description
+-----------
+
+Copy the ZFS filesystem structure and contents that is rooted at
+`source-dataset` to the destination rooted at `dest-dataset`.
+
+The content of the filesystems is copied also.
+
+`dest-dataset` must not exist already.
+
+By default `canmount` is also copied. But this can be modified with
+options :option:`-A` and :option:`-p`.
+
+
+Options
+-------
+
+.. option:: -A
+
+   Unconditionally set the ZFS property `canmount=noauto` for all
+   created datasets in the destination tree. This option overwrites
+   option :option:`-p`.
+
+.. option:: -M mountpoint
+
+   Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`.
+   All children will be set to inherit it.
+
+.. option:: -n
+
+   Dry-run. Do not really create and copy datasets but show what would
+   be done.
+
+.. option:: -p
+
+   Copy the `canmount` property only from the source to the root
+   destination dataset This will be overwritten by the option
+   :option:`-A`.
+
+.. option:: -u
+
+   Do not mount the copied datasets.
+
+
+Environment
+-----------
+
+All environment variables that affect :command:`zfs` are effective also.
+
+
+See Also
+--------
+
+:manpage:`fzfs(8)`, :manpage:`fzfs-create-tree(8)`