view docs/man/man8/fjail.rst @ 323:e98bc7f40803

Man: Document the global options "-h" and "-V" in all affected manual pages
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 27 Nov 2022 20:42:37 +0100
parents 9c5b76df4f9d
children 6bdf954ad93e
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-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

: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


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.