mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-11-18 10:21:01 +03:00
79bfba2fa8
Use proper names (i.e. zfs-allow and zpool-add) in NAME subsections of zfs/zpool subcommands instead of current "pretty-printed" ones as makewhatis utilities (or some implementations of it, namely the one from mandoc suite used in FreeBSD) look not only at the document title but also in NAME subsection, adding zfs(8)/zpool(8) to search results which is not correct. (Common sense and other utilities splitting subcommands in multiple man pages, e.g. git, do the same.) Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: xtouqh <xtouqh@hotmail.com> Closes #11086
120 lines
3.7 KiB
Groff
120 lines
3.7 KiB
Groff
.\"
|
|
.\" CDDL HEADER START
|
|
.\"
|
|
.\" The contents of this file are subject to the terms of the
|
|
.\" Common Development and Distribution License (the "License").
|
|
.\" You may not use this file except in compliance with the License.
|
|
.\"
|
|
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
.\" or http://www.opensolaris.org/os/licensing.
|
|
.\" See the License for the specific language governing permissions
|
|
.\" and limitations under the License.
|
|
.\"
|
|
.\" When distributing Covered Code, include this CDDL HEADER in each
|
|
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
.\" If applicable, add the following below this CDDL HEADER, with the
|
|
.\" fields enclosed by brackets "[]" replaced with your own identifying
|
|
.\" information: Portions Copyright [yyyy] [name of copyright owner]
|
|
.\"
|
|
.\" CDDL HEADER END
|
|
.\"
|
|
.\"
|
|
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
|
|
.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
|
|
.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
|
|
.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org>
|
|
.\" Copyright (c) 2012, Glen Barber <gjb@FreeBSD.org>
|
|
.\" Copyright (c) 2012, Bryan Drewery <bdrewery@FreeBSD.org>
|
|
.\" Copyright (c) 2013, Steven Hartland <smh@FreeBSD.org>
|
|
.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
|
|
.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
|
|
.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
|
|
.\" Copyright (c) 2014 Integros [integros.com]
|
|
.\" Copyright (c) 2014, Xin LI <delphij@FreeBSD.org>
|
|
.\" Copyright (c) 2014-2015, The FreeBSD Foundation, All Rights Reserved.
|
|
.\" Copyright (c) 2016 Nexenta Systems, Inc. All Rights Reserved.
|
|
.\" Copyright 2019 Richard Laager. All rights reserved.
|
|
.\" Copyright 2018 Nexenta Systems, Inc.
|
|
.\" Copyright 2019 Joyent, Inc.
|
|
.\"
|
|
.Dd December 9, 2019
|
|
.Dt ZFS-JAIL 8
|
|
.Os FreeBSD
|
|
.Sh NAME
|
|
.Nm zfs-jail
|
|
.Nd Attaches and detaches ZFS filesystems from FreeBSD jails.
|
|
.No A Tn ZFS
|
|
dataset can be attached to a jail by using the
|
|
.Qq Nm Cm jail
|
|
subcommand. You cannot attach a dataset to one jail and the children of the
|
|
same dataset to another jail. You can also not attach the root file system
|
|
of the jail or any dataset which needs to be mounted before the zfs rc script
|
|
is run inside the jail, as it would be attached unmounted until it is
|
|
mounted from the rc script inside the jail. To allow management of the
|
|
dataset from within a jail, the
|
|
.Sy jailed
|
|
property has to be set and the jail needs access to the
|
|
.Pa /dev/zfs
|
|
device. The
|
|
.Sy quota
|
|
property cannot be changed from within a jail. See
|
|
.Xr jail 8
|
|
for information on how to allow mounting
|
|
.Tn ZFS
|
|
datasets from within a jail.
|
|
.Pp
|
|
.No A Tn ZFS
|
|
dataset can be detached from a jail using the
|
|
.Qq Nm Cm unjail
|
|
subcommand.
|
|
.Pp
|
|
After a dataset is attached to a jail and the jailed property is set, a jailed
|
|
file system cannot be mounted outside the jail, since the jail administrator
|
|
might have set the mount point to an unacceptable value.
|
|
.Sh SYNOPSIS
|
|
.Nm zfs
|
|
.Cm jail
|
|
.Ar jailid Ns | Ns Ar jailname filesystem
|
|
.Nm zfs
|
|
.Cm unjail
|
|
.Ar jailid Ns | Ns Ar jailname filesystem
|
|
.Sh DESCRIPTION
|
|
.Bl -tag -width ""
|
|
.It Xo
|
|
.Nm zfs
|
|
.Cm jail
|
|
.Ar jailid filesystem
|
|
.Xc
|
|
.Pp
|
|
Attaches the specified
|
|
.Ar filesystem
|
|
to the jail identified by JID
|
|
.Ar jailid .
|
|
From now on this file system tree can be managed from within a jail if the
|
|
.Sy jailed
|
|
property has been set. To use this functuinality, the jail needs the
|
|
.Va allow.mount
|
|
and
|
|
.Va allow.mount.zfs
|
|
parameters set to 1 and the
|
|
.Va enforce_statfs
|
|
parameter set to a value lower than 2.
|
|
.Pp
|
|
See
|
|
.Xr jail 8
|
|
for more information on managing jails and configuring the parameters above.
|
|
.It Xo
|
|
.Nm zfs
|
|
.Cm unjail
|
|
.Ar jailid filesystem
|
|
.Xc
|
|
.Pp
|
|
Detaches the specified
|
|
.Ar filesystem
|
|
from the jail identified by JID
|
|
.Ar jailid .
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr jail 8 ,
|
|
.Xr zfsprops 8
|