diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/ftjail-check-freebsd-update.rst	Sat Sep 28 19:12:05 2024 +0200
@@ -0,0 +1,63 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+ftjail-check-freebsd-update
+===========================
+
+.. program:: ftjail freebsd-update
+
+
+Synopsis
+--------
+
+**ftjail check-freebsd-update** [**-k**] [**-o** `old-origin`] `directory` `new-origin` [`etcupdate-tarball`]
+
+
+Description
+-----------
+
+A thorough check for preconditions to run :manpage:`ftjail-freebsd-update(8)`
+for a Thin Jail successfully.
+
+It does all checks that :manpage:`ftjail-freebsd-update(8)` does but
+tries to collect all errors.
+
+It is intended that a successful run of :command:`ftjail check-freebsd-update`
+implies a successful run of :command:`ftjail freebsd-update` if the same
+arguments are given.
+
+
+Options
+-------
+
+.. option:: -k
+
+   Does nothing.
+   Implemented for compatibility to :manpage:`ftjail-freebsd-update(8)`.
+
+.. option:: -o <old-origin>
+
+   In addition to check that `directory` is a ZFS clone also check that
+   its origin is equal to `old-origin`.
+
+   Note that a check that `directory` is a ZFS clone with some origin
+   is done by default.
+
+
+Environment
+-----------
+
+All environment variables that affect :command:`zfs` are effective also.
+
+
+Files
+-----
+
+A unique temporary directory is created within :file:`/var/tmp`. All
+temporary files are created within this directory.
+
+
+See Also
+--------
+
+:manpage:`ftjail(8)`, :manpage:`ftjail-freebsd-update(8)`,
+:manpage:`freebsd-update(8)`, :manpage:`etcupdate(8)`