.. -*- coding: utf-8; indent-tabs-mode: nil; -*-

fzfs-copy-tree
==============

.. program:: fzfs copy-tree


Synopsis
--------

**fzfs copy-tree** [**-A**] [**-M** `mountpoint`] [**-k**] [**-n**] [**-u**] `source-dataset` `dest-dataset`


Description
-----------

Copy the ZFS filesystem or snapshot that is rooted at `source-dataset`
and all descendent datasets to the destination rooted at `dest-dataset`.

The structure and content of the filesystems is copied.

If `source-dataset` is a snapshot then all of its child datasets also must
have a snapshot with the same snapshot name.

`dest-dataset` must not exist already.

By default `canmount` is also copied. But this can be modified with
option :option:`-A`.


Options
-------

.. option:: -A

   Unconditionally set the ZFS property `canmount=noauto` for all
   created datasets in the destination tree, unless the source dataset
   has `canmount=off`.

.. option:: -M mountpoint

   Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`.
   All children will be set to inherit it.

.. option:: -k

   When copying from a snapshot source a corresponding snapshot will be
   copied to the target dataset. By default this snapshot will be
   deleted. With this option this snapshot is kept.

.. option:: -n

   Dry-run. Do not really create and copy datasets but show what would
   be done.

.. 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)`