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

annotate docs/man/man8/fzfs-create-tree.rst @ 649:4ee9a8042f4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
common.subr: _get_jail_from_path() now just returns when the jail is dying. But it prints the name of the jail if it is yet dying. Real error reporting must not consistently be done in the caller.
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 27 Sep 2024 21:21:34 +0200
parents b74c65ceab96
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fzfs-create-tree
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ================
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 .. program:: fzfs create-tree
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 Synopsis
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10 --------
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 **fzfs create-tree** [**-A**] [**-M** `mountpoint`] [**-n**] [**-p**] [**-u**] `source-dataset` `dest-dataset`
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14 Description
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 -----------
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17 Copy the ZFS filesystem structure that is rooted at `source-dataset`
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18 to the destination rooted at `dest-dataset`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20 The content of the filesystems is **not** copied. This is also true for
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21 permissions and/or ACLs.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23 `dest-dataset` must not exist already.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
25 By default some important dataset properties are copied from
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
26 the source tree to the destination. This includes `atime`,
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27 `exec`, `setuid`, `compression`, `primarycache`, `sync` and
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
28 `readonly`. But they are copied *only* if are of type ``local`` in
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
29 the source.
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31 By default `canmount` is also copied. But this can be modified with
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32 options :option:`-A` and :option:`-p`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
34 The `mountpoint` property is not copied. Normally it will be inherited
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
35 as the ZFS rules for `dest-dataset` regarding its parent are applied.
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
36 This can be changed with :option:`-M mountpoint`. Child datasets always
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
37 will inherit their mountpoint from `dest-dataset`.
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
38
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 Options
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41 -------
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43 .. option:: -A
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 Unconditionally set the ZFS property `canmount=noauto` for all
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
46 created datasets in the destination tree. This option also overwrites
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47 option :option:`-p`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48
622
54c6eecbe53f Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents: 420
diff changeset
49 .. option:: -M <mountpoint>
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
51 Set the `mountpoint` property for the destination root `dest-dataset`
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
52 to `mountpoint`. All children will be set to inherit it.
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
53
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
54 If not given then the mountpoint will we inherited by normal ZFS
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
55 inheritance from the destination's parent.
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57 .. option:: -n
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59 Dry-run. Do not really create datasets but show what would be done.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61 .. option:: -p
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
63 Copy the `canmount` property only from the source root to the destinaion
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
64 root dataset This will be overwritten by the option :option:`-A`.
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66 .. option:: -u
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
67
623
b74c65ceab96 Docs: Enhanced manuals
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
68 Do not mount the newly created datasets when they are created.
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71 Environment
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
72 -----------
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
73
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
74 All environment variables that affect :command:`zfs` are effective also.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
75
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
76
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
77 See Also
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
78 --------
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
79
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
80 :manpage:`fzfs(8)`, :manpage:`fzfs-copy-tree(8)`