view docs/man/man8/fjail.rst @ 649:4ee9a8042f4a

common.subr: _get_jail_from_path() now just returns when the jail is dying. But it prints the name of the jail if it is yet dying. Real error reporting must not consistently be done in the caller.
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 27 Sep 2024 21:21:34 +0200
parents 673505e96cea
children
line wrap: on
line source

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

ftjail
======

Synopsis
--------

**fjail -hV**

**fjail subcommand**


Description
-----------

Management tool for Jails: creation of ZFS dataset hierarchies, mount,
population and configuration helpers.

The following global options are implemented:

.. program:: fjail

.. option:: -h

   Print a short usage message to stdout and exit.

.. option:: -V

   Print the program name and version number to stdout and exit.


Subcommands
-----------

:manpage:`fjail-configure(8)`

    Do some basic configuration of an already populated and mounted
    jail

:manpage:`fjail-copy(8)`

    Recursively copy ZFS datasets including all properties

:manpage:`fjail-datasets(8)`

    Create a new tree of ZFS datasets that will encompass a jail

:manpage:`fjail-freebsd-update(8)`

    Do a :manpage:`freebsd-update(8)` with some additional
    compatibility checks

:manpage:`fjail-hostid(8)`

    Generate a proposal for a new BSD host UUID and ID

:manpage:`fjail-mount(8)`

    Recursively mount a ZFS dataset and its children.

    It is just an alias for :command:`fzfs mount`
    (see :manpage:`fzfs-mount(8)`).

:manpage:`fjail-populate(8)`

    Populate a directory with content from a FreeBSD base.txz

:manpage:`fjail-privs(8)`

    Adjust some privileges within a mounted jail

:manpage:`fjail-umount(8)`

    Recursively unmount a ZFS datasets and its children.

    It is just an alias for :command:`fzfs umount`
    (see :manpage:`fzfs-umount(8)`).


Implementation Notes
--------------------

Some commands require ZFS as filesystem.

Some commands are suitable for Thin Jails also.


Environment
-----------

All environment variables that affect :command:`zfs` are effective also.