.. -*- coding: utf-8; indent-tabs-mode: nil; -*-

ftjail-check-freebsd-update
===========================

.. program:: ftjail check-freebsd-update


Synopsis
--------

**ftjail check-freebsd-update** [**-k**] [**-o** `old-origin`] [[**-R** `dataset@snapname`]...] `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:: -R <dataset@snapname>

   Check that the creation of ZFS snapshots for `dataset` and all its children
   will succeed:
   
     The existence if `dataset` will be prooved.

     The snapshots may not exist already; this is prooved for `dataset`
     and all its children.

   Can be given more than once.

.. 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)`