Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools

annotate docs/man/man8/fzfs-copy-tree.rst @ 622:54c6eecbe53f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 22 Sep 2024 16:04:18 +0200
parents 7694275f2df1
children b74c65ceab96
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fzfs-copy-tree
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ==============
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 .. program:: fzfs copy-tree
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 Synopsis
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10 --------
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
429
bbdb1ab0ea00 Implement "-k" option for "fzfs copy-tree" to keep received snapshots
Franz Glasner <fzglas.hg@dom66.de>
parents: 425
diff changeset
12 **fzfs copy-tree** [**-A**] [**-M** `mountpoint`] [**-k**] [**-n**] [**-u**] `source-dataset` `dest-dataset`
421
a571a30bcf8a Begin the implementation of "fzfs copy-tree"
Franz Glasner <hg@dom66.de>
parents: 420
diff changeset
13
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 Description
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16 -----------
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17
421
a571a30bcf8a Begin the implementation of "fzfs copy-tree"
Franz Glasner <hg@dom66.de>
parents: 420
diff changeset
18 Copy the ZFS filesystem or snapshot that is rooted at `source-dataset`
a571a30bcf8a Begin the implementation of "fzfs copy-tree"
Franz Glasner <hg@dom66.de>
parents: 420
diff changeset
19 and all descendent datasets to the destination rooted at `dest-dataset`.
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
421
a571a30bcf8a Begin the implementation of "fzfs copy-tree"
Franz Glasner <hg@dom66.de>
parents: 420
diff changeset
21 The structure and content of the filesystems is copied.
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22
431
7694275f2df1 Manpage: wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 429
diff changeset
23 If `source-dataset` is a snapshot then all of its child datasets also must
424
a200c18603c9 Further work on "fzfs copy-tree"
Franz Glasner <fzglas.hg@dom66.de>
parents: 421
diff changeset
24 have a snapshot with the same snapshot name.
a200c18603c9 Further work on "fzfs copy-tree"
Franz Glasner <fzglas.hg@dom66.de>
parents: 421
diff changeset
25
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26 `dest-dataset` must not exist already.
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28 By default `canmount` is also copied. But this can be modified with
421
a571a30bcf8a Begin the implementation of "fzfs copy-tree"
Franz Glasner <hg@dom66.de>
parents: 420
diff changeset
29 option :option:`-A`.
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32 Options
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 -------
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 .. option:: -A
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 Unconditionally set the ZFS property `canmount=noauto` for all
425
3ebaa936b2b2 Docs: -A should not touch datasets with "canmount=off"
Franz Glasner <hg@dom66.de>
parents: 424
diff changeset
38 created datasets in the destination tree, unless the source dataset
3ebaa936b2b2 Docs: -A should not touch datasets with "canmount=off"
Franz Glasner <hg@dom66.de>
parents: 424
diff changeset
39 has `canmount=off`.
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40
622
54c6eecbe53f Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents: 431
diff changeset
41 .. option:: -M <mountpoint>
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43 Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`.
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 All children will be set to inherit it.
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45
429
bbdb1ab0ea00 Implement "-k" option for "fzfs copy-tree" to keep received snapshots
Franz Glasner <fzglas.hg@dom66.de>
parents: 425
diff changeset
46 .. option:: -k
bbdb1ab0ea00 Implement "-k" option for "fzfs copy-tree" to keep received snapshots
Franz Glasner <fzglas.hg@dom66.de>
parents: 425
diff changeset
47
bbdb1ab0ea00 Implement "-k" option for "fzfs copy-tree" to keep received snapshots
Franz Glasner <fzglas.hg@dom66.de>
parents: 425
diff changeset
48 When copying from a snapshot source a corresponding snapshot will be
bbdb1ab0ea00 Implement "-k" option for "fzfs copy-tree" to keep received snapshots
Franz Glasner <fzglas.hg@dom66.de>
parents: 425
diff changeset
49 copied to the target dataset. By default this snapshot will be
bbdb1ab0ea00 Implement "-k" option for "fzfs copy-tree" to keep received snapshots
Franz Glasner <fzglas.hg@dom66.de>
parents: 425
diff changeset
50 deleted. With this option this snapshot is kept.
bbdb1ab0ea00 Implement "-k" option for "fzfs copy-tree" to keep received snapshots
Franz Glasner <fzglas.hg@dom66.de>
parents: 425
diff changeset
51
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 .. option:: -n
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54 Dry-run. Do not really create and copy datasets but show what would
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55 be done.
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57 .. option:: -u
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59 Do not mount the copied datasets.
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62 Environment
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63 -----------
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65 All environment variables that affect :command:`zfs` are effective also.
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
67
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68 See Also
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69 --------
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71 :manpage:`fzfs(8)`, :manpage:`fzfs-create-tree(8)`