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

annotate docs/man/man8/fzfs-create-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 bf0d63c8e682
children b74c65ceab96
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
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 By default some important dataset properties that are set locally in
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26 the source tree are copied to the destination. This includes `atime`,
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27 `exec`, `setuid`, `compression`, `primarycache`, `sync` and
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28 `readonly`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30 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
31 options :option:`-A` and :option:`-p`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 Options
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 -------
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 .. option:: -A
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 Unconditionally set the ZFS property `canmount=noauto` for all
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 created datasets in the destination tree. This option overwrites
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41 option :option:`-p`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42
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
43 .. option:: -M <mountpoint>
380
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 Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46 All children will be set to inherit it.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48 .. option:: -n
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 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
51
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 .. option:: -p
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54 Copy the `canmount` property only from the source to the root
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55 destination dataset This will be overwritten by the option
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56 :option:`-A`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 .. option:: -u
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60 Do not mount the newly created datasets.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63 Environment
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64 -----------
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 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
67
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69 See Also
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
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
72 :manpage:`fzfs(8)`, :manpage:`fzfs-copy-tree(8)`