annotate docs/man/man8/fzfs-clone-tree.rst @ 784:b5b19c62da24

fports: FIX: man page: Synopsis should document the "deptree" subcommand
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 26 Oct 2024 22:42:01 +0200
parents b74c65ceab96
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
520
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fzfs-clone-tree
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ===============
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 .. program:: fzfs clone-tree
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 Synopsis
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10 --------
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
521
c05ef1c86c9c fzfs: Implement option "-k" for clone-tree and mount to keep cloned datasets or keep datasets mounted on errors
Franz Glasner <fzglas.hg@dom66.de>
parents: 520
diff changeset
12 **fzfs clone-tree** [**-k**] [**-n**] `source-dataset` `dest-dataset`
520
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 Description
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16 -----------
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18 Clone the ZFS snapshot that is rooted at `source-dataset` and all
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19 descendent snapshots into the destination dataset rooted at
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20 `dest-dataset`.
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22 `source-dataset` must be a snapshot. All of its children must have a
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23 snapshot with the very same snapshot.
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 `dest-dataset` must not exist already.
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 521
diff changeset
27 All properties that are of type ``local`` or ``received`` are copied to the
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 521
diff changeset
28 destination. This is also true for `canmount` and `mountpoint`.
520
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30 The cloned datasets will are *not* mounted automatically.
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32 If something fails it is tried to delete the intermediately created
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 datasets.
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 Options
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 -------
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38
521
c05ef1c86c9c fzfs: Implement option "-k" for clone-tree and mount to keep cloned datasets or keep datasets mounted on errors
Franz Glasner <fzglas.hg@dom66.de>
parents: 520
diff changeset
39 .. option:: -k
c05ef1c86c9c fzfs: Implement option "-k" for clone-tree and mount to keep cloned datasets or keep datasets mounted on errors
Franz Glasner <fzglas.hg@dom66.de>
parents: 520
diff changeset
40
c05ef1c86c9c fzfs: Implement option "-k" for clone-tree and mount to keep cloned datasets or keep datasets mounted on errors
Franz Glasner <fzglas.hg@dom66.de>
parents: 520
diff changeset
41 Do not try to destroy intermediately cloned datasets on errors but
c05ef1c86c9c fzfs: Implement option "-k" for clone-tree and mount to keep cloned datasets or keep datasets mounted on errors
Franz Glasner <fzglas.hg@dom66.de>
parents: 520
diff changeset
42 keep them.
c05ef1c86c9c fzfs: Implement option "-k" for clone-tree and mount to keep cloned datasets or keep datasets mounted on errors
Franz Glasner <fzglas.hg@dom66.de>
parents: 520
diff changeset
43
520
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 .. option:: -n
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46 Dry-run. Do not really clone datasets but show what would be done.
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49 Environment
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 -----------
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 All environment variables that affect :command:`zfs` are effective also.
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55 See Also
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56 --------
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 :manpage:`fzfs(8)`