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

annotate docs/man/man8/ftjail.rst @ 374:38a5d6693b8b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
FIX: Remove duplicate ref to ftjail-copy-skel(8)
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 18 Feb 2023 18:04:37 +0100
parents c10fce8ffe91
children 3108ce603fa1
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
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
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 **ftjail -hV**
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 **ftjail subcommand**
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
298
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
14 Description
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
15 -----------
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
16
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
17 Management tool for Thin Jails: creation of base and skeleton datasets,
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
18 mount and population helpers.
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
19
323
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
20 The following global options are implemented:
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
21
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
22 .. program:: ftjail
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
23
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
24 .. option:: -h
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
25
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
26 Print a short usage message to stdout and exit.
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
27
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
28 .. option:: -V
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
29
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
30 Print the program name and version number to stdout and exit.
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
31
298
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
32
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 Subcommands
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 -----------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
308
2102b46566f0 Implement "ftjail build-etcupdate-curent-tmpl".
Franz Glasner <fzglas.hg@dom66.de>
parents: 307
diff changeset
36 :manpage:`ftjail-build-etcupdate-current-tmpl(8)`
2102b46566f0 Implement "ftjail build-etcupdate-curent-tmpl".
Franz Glasner <fzglas.hg@dom66.de>
parents: 307
diff changeset
37
2102b46566f0 Implement "ftjail build-etcupdate-curent-tmpl".
Franz Glasner <fzglas.hg@dom66.de>
parents: 307
diff changeset
38 Build a "current" tree suitable for the default and extract mode
2102b46566f0 Implement "ftjail build-etcupdate-curent-tmpl".
Franz Glasner <fzglas.hg@dom66.de>
parents: 307
diff changeset
39 of \"etcupdate\"
2102b46566f0 Implement "ftjail build-etcupdate-curent-tmpl".
Franz Glasner <fzglas.hg@dom66.de>
parents: 307
diff changeset
40
372
c10fce8ffe91 FIX: The manpage of ftjail-copy-skel(8) was missing in ftjail(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
41 :manpage:`ftjail-copy-skel(8)`
c10fce8ffe91 FIX: The manpage of ftjail-copy-skel(8) was missing in ftjail(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
42
c10fce8ffe91 FIX: The manpage of ftjail-copy-skel(8) was missing in ftjail(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
43 Recursively copy template skeleton contents into jail-specific datasets
c10fce8ffe91 FIX: The manpage of ftjail-copy-skel(8) was missing in ftjail(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
44
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 :manpage:`ftjail-datasets-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
47 Create ZFS template datasets for new Thin Jails using base and skeleton
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48
334
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
49 :manpage:`ftjail-freebsd-update(8)`
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
50
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
51 A :manpage:`freebsd-update(8)` implementation for Thin Jails
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
52
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53 :manpage:`ftjail-mount-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
55 Canonically mount the RO base and the RW skeleton of a Thin Jail
293
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 :manpage:`ftjail-umount-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
59 Unmount mounted Thin Jail template datasets
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61 :manpage:`ftjail-interlink-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
63 Create proper symlinks for "skeleton" style Thin Jails
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64
307
23bcbbbd99ea FIX: Rename "ftjail-populate.rst" to "ftjail-populate-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
65 :manpage:`ftjail-populate-tmpl(8)`
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
67 Populate a prepared directory structure with the contents of a
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
68 FreeBSD base system
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70 :manpage:`ftjail-snapshot-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
72 Recursively create ZFS snapshots of the RO base datasets and the RW
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 299
diff changeset
73 skeleton datasets
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
74
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
75
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
76 Implementation Notes
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
77 --------------------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
78
307
23bcbbbd99ea FIX: Rename "ftjail-populate.rst" to "ftjail-populate-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
79 All commands with the exception of :command:`ftjail populate-tmpl` and
299
49890965e43c FIX: "ftjail interlink-tmpl" also does NOT need a ZFS filesystem: document it accordingly
Franz Glasner <fzglas.hg@dom66.de>
parents: 298
diff changeset
80 :command:`ftjail interlink-tmpl` require ZFS as filesystem.
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
81
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
82
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
83 Environment
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
84 -----------
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
85
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
86 All environment variables that affect :command:`zfs` are effective also.