comparison docs/man/man8/fzfs-copy-tree.rst @ 623:b74c65ceab96

Docs: Enhanced manuals
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 22 Sep 2024 19:07:26 +0200
parents 54c6eecbe53f
children
comparison
equal deleted inserted replaced
622:54c6eecbe53f 623:b74c65ceab96
16 ----------- 16 -----------
17 17
18 Copy the ZFS filesystem or snapshot that is rooted at `source-dataset` 18 Copy the ZFS filesystem or snapshot that is rooted at `source-dataset`
19 and all descendent datasets to the destination rooted at `dest-dataset`. 19 and all descendent datasets to the destination rooted at `dest-dataset`.
20 20
21 The structure and content of the filesystems is copied. 21 The structure, content and properties of the filesystems are copied.
22 The properties `canmount` and `mountpoint` are handled specially.
22 23
23 If `source-dataset` is a snapshot then all of its child datasets also must 24 If `source-dataset` is a snapshot then all of its child datasets also must
24 have a snapshot with the same snapshot name. 25 have a snapshot with the same snapshot name.
25 26
26 `dest-dataset` must not exist already. 27 `dest-dataset` must not exist already.
27 28
28 By default `canmount` is also copied. But this can be modified with 29 By default `canmount` is also copied. But this can be modified with
29 option :option:`-A`. 30 option :option:`-A`.
30 31
32 The `mountpoint` property is not copied. Normally it will be inherited
33 as the ZFS rules for `dest-dataset` regarding its parent are applied.
34 This can be changed with :option:`-M mountpoint`. Child datasets always
35 will inherit their mountpoint from `dest-dataset`.
36
31 37
32 Options 38 Options
33 ------- 39 -------
34 40
35 .. option:: -A 41 .. option:: -A
36 42
37 Unconditionally set the ZFS property `canmount=noauto` for all 43 Unconditionally set the ZFS property `canmount=noauto` for all
38 created datasets in the destination tree, unless the source dataset 44 created datasets in the destination tree, `unless` the source dataset
39 has `canmount=off`. 45 has `canmount=off`. If not given then `canmount` is copied from the
46 source to the destination.
40 47
41 .. option:: -M <mountpoint> 48 .. option:: -M <mountpoint>
42 49
43 Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`. 50 Set the `mountpoint` property for the destination root `dest-dataset`
44 All children will be set to inherit it. 51 to `mountpoint`. All children will be set to inherit it.
52
53 If not given then the mountpoint will we inherited by normal ZFS
54 inheritance from the destination's parent.
45 55
46 .. option:: -k 56 .. option:: -k
47 57
48 When copying from a snapshot source a corresponding snapshot will be 58 When copying from a snapshot source a corresponding snapshot will be
49 copied to the target dataset. By default this snapshot will be 59 copied to the target dataset. By default this snapshot will be
54 Dry-run. Do not really create and copy datasets but show what would 64 Dry-run. Do not really create and copy datasets but show what would
55 be done. 65 be done.
56 66
57 .. option:: -u 67 .. option:: -u
58 68
59 Do not mount the copied datasets. 69 Do not mount the copied datasets automatically when they are created.
70
71
72 Implementation Notes
73 --------------------
74
75 The current implementation uses :manpage:`zfs-send(8)`
76 and :manpage:`zfs-receive(8)` to implement the actual copying.
60 77
61 78
62 Environment 79 Environment
63 ----------- 80 -----------
64 81