annotate docs/man/man8/ftjail-check-freebsd-update.rst @ 806:b59054f11029

fports: Implement "fports detail -b" to print details about all packages that are not installed from the blessed FreeBSD repo. While there change option handling to allow a combination of selection flags: merge all selected packages and sort if needed.
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 05 Nov 2024 10:57:06 +0100
parents 82a98db83a13
children
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
659
25de0d27e407 FIX: docs: ".. program::" for ftjail-check-freebsd-update
Franz Glasner <fzglas.hg@dom66.de>
parents: 658
diff changeset
6 .. program:: ftjail check-freebsd-update
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
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
660
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
12 **ftjail check-freebsd-update** [**-k**] [**-o** `old-origin`] [[**-R** `dataset@snapname`]...] `directory` `new-origin` [`etcupdate-tarball`]
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
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
660
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
32 .. option:: -R <dataset@snapname>
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
33
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
34 Check that the creation of ZFS snapshots for `dataset` and all its children
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
35 will succeed:
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
36
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
37 The existence if `dataset` will be prooved.
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
38
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
39 The snapshots may not exist already; this is prooved for `dataset`
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
40 and all its children.
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
41
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
42 Can be given more than once.
82a98db83a13 ftjail: Implement a "-R" option for "ftjail freebsd-update" and "ftjail check-freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 659
diff changeset
43
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
44 .. 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
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 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
47 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
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 .. 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
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 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
52 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
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 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
55 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
56
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 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
59 -----------
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 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
62
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
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
64 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
65 -----
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
66
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
67 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
68 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
69
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
70
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
71 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
72 --------
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
73
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
74 :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
75 :manpage:`freebsd-update(8)`, :manpage:`etcupdate(8)`