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

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
children 25de0d27e407
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
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:
diff changeset
2
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:
diff changeset
3 ftjail-check-freebsd-update
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:
diff changeset
4 ===========================
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:
diff changeset
5
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:
diff changeset
6 .. program:: ftjail freebsd-update
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:
diff changeset
7
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:
diff changeset
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:
diff changeset
9 Synopsis
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:
diff changeset
10 --------
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:
diff changeset
11
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:
diff changeset
12 **ftjail check-freebsd-update** [**-k**] [**-o** `old-origin`] `directory` `new-origin` [`etcupdate-tarball`]
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:
diff changeset
13
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:
diff changeset
14
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:
diff changeset
15 Description
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:
diff changeset
16 -----------
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:
diff changeset
17
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:
diff changeset
18 A thorough check for preconditions to run :manpage:`ftjail-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:
diff changeset
19 for a Thin Jail 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:
diff changeset
20
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:
diff changeset
21 It does all checks that :manpage:`ftjail-freebsd-update(8)` does but
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:
diff changeset
22 tries to collect all errors.
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:
diff changeset
23
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:
diff changeset
24 It is intended that a successful run of :command:`ftjail check-freebsd-update`
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:
diff changeset
25 implies a successful run of :command:`ftjail freebsd-update` if the same
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:
diff changeset
26 arguments are given.
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:
diff changeset
27
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:
diff changeset
28
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:
diff changeset
29 Options
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:
diff changeset
30 -------
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:
diff changeset
31
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:
diff changeset
32 .. option:: -k
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:
diff changeset
33
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:
diff changeset
34 Does nothing.
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:
diff changeset
35 Implemented for compatibility to :manpage:`ftjail-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:
diff changeset
36
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:
diff changeset
37 .. option:: -o <old-origin>
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:
diff changeset
38
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:
diff changeset
39 In addition to check that `directory` is a ZFS clone also check 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:
diff changeset
40 its origin is equal to `old-origin`.
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:
diff changeset
41
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:
diff changeset
42 Note that a check that `directory` is a ZFS clone with some origin
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:
diff changeset
43 is done by default.
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:
diff changeset
44
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:
diff changeset
45
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:
diff changeset
46 Environment
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:
diff changeset
47 -----------
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:
diff changeset
48
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:
diff changeset
49 All environment variables that affect :command:`zfs` are effective also.
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:
diff changeset
50
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:
diff changeset
51
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:
diff changeset
52 Files
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:
diff changeset
53 -----
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:
diff changeset
54
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:
diff changeset
55 A unique temporary directory is created within :file:`/var/tmp`. All
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:
diff changeset
56 temporary files are created within this directory.
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:
diff changeset
57
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:
diff changeset
58
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:
diff changeset
59 See Also
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:
diff changeset
60 --------
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:
diff changeset
61
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:
diff changeset
62 :manpage:`ftjail(8)`, :manpage:`ftjail-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:
diff changeset
63 :manpage:`freebsd-update(8)`, :manpage:`etcupdate(8)`