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

annotate docs/man/man8/ftjail-freebsd-update.rst @ 658:260a81d769a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Implemented "ftjail check-freebsd-update": thorough check for preconditions to a successful run of "ftjail freebsd-update". All checks that "ftjail freebsd-update" does are replicated in "ftjail check-freebsd-update".
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 28 Sep 2024 19:12:05 +0200
parents 54c6eecbe53f
children 82a98db83a13
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
334
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 ftjail-freebsd-update
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 =====================
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
341
a204a7415d4a "ftjail freebsd-update" is implemented.
Franz Glasner <fzglas.hg@dom66.de>
parents: 340
diff changeset
9 **ftjail freebsd-update** [**-k**] [**-o** `old-origin`] `directory` `new-origin` [`etcupdate-tarball`]
334
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 Description
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 -----------
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 A :manpage:`freebsd-update(8)` for a Thin Jail.
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
341
a204a7415d4a "ftjail freebsd-update" is implemented.
Franz Glasner <fzglas.hg@dom66.de>
parents: 340
diff changeset
17 Make the ZFS dataset mounted at `directory` a read-only clone of `new-origin`.
a204a7415d4a "ftjail freebsd-update" is implemented.
Franz Glasner <fzglas.hg@dom66.de>
parents: 340
diff changeset
18
a204a7415d4a "ftjail freebsd-update" is implemented.
Franz Glasner <fzglas.hg@dom66.de>
parents: 340
diff changeset
19 If `etcupdate-tarball` is given also call :manpage:`etcupdate(8)` on
a204a7415d4a "ftjail freebsd-update" is implemented.
Franz Glasner <fzglas.hg@dom66.de>
parents: 340
diff changeset
20 the fully re-mounted directory tree that is rooted at `directory`
430
a05c5d520f86 Wording in manpage Glasner <hg@dom66.de>
Franz Glasner <hg@dom66.de>
parents: 342
diff changeset
21 using `etcupdate-tarball` as the new "current".
341
a204a7415d4a "ftjail freebsd-update" is implemented.
Franz Glasner <fzglas.hg@dom66.de>
parents: 340
diff changeset
22
658
260a81d769a6 Implemented "ftjail check-freebsd-update": thorough check for preconditions to a successful run of "ftjail freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
23 See also :manpage:`ftjail-check-freebsd-update(8)` for a tool that
260a81d769a6 Implemented "ftjail check-freebsd-update": thorough check for preconditions to a successful run of "ftjail freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
24 tries to thoroughly check the preconditions to run this tool successfully.
260a81d769a6 Implemented "ftjail check-freebsd-update": thorough check for preconditions to a successful run of "ftjail freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
25
334
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27 Options
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28 -------
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30 .. program:: ftjail freebsd-update
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31
339
e1d6807b0c4d Implement option handling for ftjail freebsd-update and the "-k" option
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
32 .. option:: -k
e1d6807b0c4d Implement option handling for ftjail freebsd-update and the "-k" option
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
33
342
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
34 Keep all temporary files.
339
e1d6807b0c4d Implement option handling for ftjail freebsd-update and the "-k" option
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
35
e1d6807b0c4d Implement option handling for ftjail freebsd-update and the "-k" option
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
36 .. note:: On unexpected errors temp files are automatically kept.
e1d6807b0c4d Implement option handling for ftjail freebsd-update and the "-k" option
Franz Glasner <fzglas.hg@dom66.de>
parents: 334
diff changeset
37
622
54c6eecbe53f Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents: 430
diff changeset
38 .. option:: -o <old-origin>
340
d3b5fe2712ca Implement "ftjail freebsd-update -o" for a more exhaustige check the clone's origin
Franz Glasner <fzglas.hg@dom66.de>
parents: 339
diff changeset
39
d3b5fe2712ca Implement "ftjail freebsd-update -o" for a more exhaustige check the clone's origin
Franz Glasner <fzglas.hg@dom66.de>
parents: 339
diff changeset
40 In addition to check that `directory` is a ZFS clone also check that
d3b5fe2712ca Implement "ftjail freebsd-update -o" for a more exhaustige check the clone's origin
Franz Glasner <fzglas.hg@dom66.de>
parents: 339
diff changeset
41 its origin is equal to `old-origin`.
d3b5fe2712ca Implement "ftjail freebsd-update -o" for a more exhaustige check the clone's origin
Franz Glasner <fzglas.hg@dom66.de>
parents: 339
diff changeset
42
d3b5fe2712ca Implement "ftjail freebsd-update -o" for a more exhaustige check the clone's origin
Franz Glasner <fzglas.hg@dom66.de>
parents: 339
diff changeset
43 Note that a check that `directory` is a ZFS clone with some origin
d3b5fe2712ca Implement "ftjail freebsd-update -o" for a more exhaustige check the clone's origin
Franz Glasner <fzglas.hg@dom66.de>
parents: 339
diff changeset
44 is done by default.
d3b5fe2712ca Implement "ftjail freebsd-update -o" for a more exhaustige check the clone's origin
Franz Glasner <fzglas.hg@dom66.de>
parents: 339
diff changeset
45
334
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47 Environment
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48 -----------
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 All environment variables that affect :command:`zfs` are effective also.
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52
342
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
53 Files
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
54 -----
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
55
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
56 A unique temporary directory is created within :file:`/var/tmp`. All
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
57 temporary files are created within this directory.
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
58
89877869a665 Create all temporary files within a unique temporary directory
Franz Glasner <fzglas.hg@dom66.de>
parents: 341
diff changeset
59
334
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60 See Also
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61 --------
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62
658
260a81d769a6 Implemented "ftjail check-freebsd-update": thorough check for preconditions to a successful run of "ftjail freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
63 :manpage:`ftjail(8)`, :manpage:`ftjail-check-freebsd-update(8)`,
260a81d769a6 Implemented "ftjail check-freebsd-update": thorough check for preconditions to a successful run of "ftjail freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 622
diff changeset
64 :manpage:`freebsd-update(8)`, :manpage:`etcupdate(8)`