annotate docs/man/man8/ftjail-copy-skel.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 54c6eecbe53f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 ftjail-copy-skel
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ================
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
296
e64c726c4bd0 FIX: Copy/paster error: fzfs -> ftjail in ftjail-copy-skel
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
9 **ftjail copy-skel** [**-A**] [**-L**] [**-M** `mountpoint`] [**-P**] [**-u**] `source-dataset` `snapshot-name` `target-dataset`
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 Description
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 -----------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 Recursively copy the snapshot `snapshot-name` of the RW skeleton dataset
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16 `source-dataset` into dataset `target-dataset`.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18 Apply knowledge of the type and typical layout of the RW skeleton
375
9b6fdccfe13c FIX: filename "/usr"
Franz Glasner <fzglas.hg@dom66.de>
parents: 296
diff changeset
19 (e.g. handle the intermediate dataset of :file:`/usr` properly).
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22 Options
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23 -------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 .. program:: ftjail copy-skel
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27 .. option:: -A
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29 Set the ZFS property `canmount=noauto` for all datasets in the
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30 target dataset.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 375
diff changeset
32 .. option:: -D
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 375
diff changeset
33
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 375
diff changeset
34 Just copy the dataset tree including properties but no filesystem
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 375
diff changeset
35 data. This option is incompatible to option :option:`-L`.
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 375
diff changeset
36
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 .. option:: -L
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 Copy dataset properties optimized for employing a :file:`skeleton`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 subdirectory.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
622
54c6eecbe53f Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
42 .. option:: -M <mountpoint>
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 Set the `mountpoint` property for the TARGET-DS to `mountpoint`.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 All children will be set to inherit it.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47 .. option:: -P
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49 Copy dataset properties optimized for direct mounts of skeleton
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 children over an already mounted base.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 .. option:: -u
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54 Do not mount the target dataset `target-dataset` automatically.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57 Environment
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 -----------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60 All environment variables that affect :command:`zfs` are effective also.
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63 See Also
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64 --------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66 :manpage:`ftjail(8)`