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