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

annotate docs/man/man8/ftjail.rst @ 301:376c9f97b1cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 18 Sep 2022 18:49:13 +0200
parents 49890965e43c
children 23bcbbbd99ea
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
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
20
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21 Subcommands
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22 -----------
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 :manpage:`ftjail-datasets-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25
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
26 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
27
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28 :manpage:`ftjail-mount-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29
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
30 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
31
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32 :manpage:`ftjail-umount-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33
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
34 Unmount mounted Thin Jail template datasets
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 :manpage:`ftjail-interlink-tmpl(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
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
38 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
39
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 :manpage:`ftjail-populate(8)`
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
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
42 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
43 FreeBSD base system
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 :manpage:`ftjail-snapshot-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 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
48 skeleton datasets
293
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 :manpage:`ftjail-copy-skel(8)`
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 Copy a ZFS skeleton recursively
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
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55 Implementation Notes
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
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
58 All commands with the exception of :command:`ftjail populate` and
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
59 :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
60
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 Environment
73ac6bec36fe Man page for "ftjail copy-jail"
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63 -----------
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 All environment variables that affect :command:`zfs` are effective also.