[prev in list] [next in list] [prev in thread] [next in thread]
List: freebsd-doc
Subject: Re: docs/144984: commit references a PR
From: dfilter () freebsd ! org (dfilter service)
Date: 2010-03-26 0:50:11
Message-ID: 201003260050.o2Q0oBqV041936 () freefall ! freebsd ! org
[Download RAW message or body]
The following reply was made to PR docs/144984; it has been noted by GNATS.
From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:
Subject: Re: docs/144984: commit references a PR
Date: Fri, 26 Mar 2010 00:49:32 +0000 (UTC)
Author: danger (doc committer)
Date: Fri Mar 26 00:49:06 2010
New Revision: 205659
URL: http://svn.freebsd.org/changeset/base/205659
Log:
- update zfs and zpool manual pages to match the current state of the source
PR: 144984
Submitted by: mm@
Approved by: pjd@
Obtained from: OpenSolaris
MFC after: 4 days
Modified:
head/cddl/contrib/opensolaris/cmd/zfs/zfs.8
head/cddl/contrib/opensolaris/cmd/zpool/zpool.8
Modified: head/cddl/contrib/opensolaris/cmd/zfs/zfs.8
==============================================================================
--- head/cddl/contrib/opensolaris/cmd/zfs/zfs.8 Fri Mar 26 00:05:42 2010 (r205658)
+++ head/cddl/contrib/opensolaris/cmd/zfs/zfs.8 Fri Mar 26 00:49:06 2010 (r205659)
@@ -1,24 +1,9 @@
'\" te
-.\" 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) 2007 Sun Microsystems, Inc. All Rights Reserved.
-.TH zfs 1M "8 Apr 2008" "SunOS 5.11" "System Administration Commands"
+.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
+.\" 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] +.TH zfs 1M "14 Feb 2009" "SunOS 5.11" "System Administration Commands"
.SH NAME
zfs \- configures ZFS file systems
.SH SYNOPSIS
@@ -44,7 +29,8 @@ zfs \- configures ZFS file systems
.LP
.nf
-\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] \fIfilesystem@snapname\fR|\fIvolume@snapname\fR
+\fBzfs\fR \fBsnapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR]...
+ \fIfilesystem@snapname\fR|\fIvolume@snapname\fR
.fi
.LP
@@ -54,7 +40,7 @@ zfs \- configures ZFS file systems
.LP
.nf
-\fBzfs\fR \fBclone\fR [\fB-p\fR] \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
+\fBzfs\fR \fBclone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \
\fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR
.fi
.LP
@@ -65,7 +51,7 @@ zfs \- configures ZFS file systems
.LP
.nf
\fBzfs\fR \fBrename\fR \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
- \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
+ \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR
.fi
.LP
@@ -81,23 +67,23 @@ zfs \- configures ZFS file systems
.LP
.nf
\fBzfs\fR \fBlist\fR [\fB-rH\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fB-t\fR \
\fItype\fR[,...]]
- [\fB-s\fR \fIproperty\fR] ... [\fB-S\fR \fIproperty\fR ... \
[\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ... + [\fB-s\fR \fIproperty\fR] \
... [\fB-S\fR \fIproperty\fR] ... \
[\fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR] ...
.fi
.LP
.nf
-\fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \fIfilesystem\fR|\fIvolume\fR ...
+\fBzfs\fR \fBset\fR \fIproperty\fR=\fIvalue\fR \
\fIfilesystem\fR|\fIvolume\fR|snapshot ...
.fi
.LP
.nf
\fBzfs\fR \fBget\fR [\fB-rHp\fR] [\fB-o\fR \fIfield\fR[,...]] [\fB-s\fR \
\fIsource\fR[,...]] "\fIall\fR" | \fIproperty\fR[,...]
- \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
+ \fIfilesystem\fR|\fIvolume\fR|\fIsnapshot\fR ...
.fi
.LP
.nf
-\fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \fIfilesystem\fR|\fIvolume\fR ...
+\fBzfs\fR \fBinherit\fR [\fB-r\fR] \fIproperty\fR \
\fIfilesystem\fR|\fIvolume|snapshot\fR ...
.fi
.LP
@@ -132,12 +118,12 @@ zfs \- configures ZFS file systems
.LP
.nf
-\fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
+\fBzfs\fR \fBunshare\fR \fB-a\fR \fIfilesystem\fR|\fImountpoint\fR
.fi
.LP
.nf
-\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fB-iI\fR] \fIsnapshot\fR] \fIsnapshot\fR
+\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
.fi
.LP
@@ -153,7 +139,7 @@ zfs \- configures ZFS file systems
.LP
.nf
\fBzfs\fR \fBallow\fR [\fB-ldug\fR] "\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \
\fIperm\fR|\fI@setname\fR[,...]
- \fIfilesystem\fR|\fIvolume\fR
+ \fIfilesystem\fR|\fIvolume\fR
.fi
.LP
@@ -174,7 +160,7 @@ zfs \- configures ZFS file systems
.LP
.nf
\fBzfs\fR \fBunallow\fR [\fB-rldug\fR] \
"\fIeveryone\fR"|\fIuser\fR|\fIgroup\fR[,...] \
[\fIperm\fR|@\fIsetname\fR[,... ]]
- \fIfilesystem\fR|\fIvolume\fR
+ \fIfilesystem\fR|\fIvolume\fR
.fi
.LP
@@ -192,20 +178,10 @@ zfs \- configures ZFS file systems
\fBzfs\fR \fBunallow\fR [\fB-r\fR] \fB-s\fR @setname \
[\fIperm\fR|@\fIsetname\fR[,... ]] \fIfilesystem\fR|\fIvolume\fR
.fi
-.LP
-.nf
-\fBzfs\fR \fBjail\fR \fBjailid\fR \fB\fIfilesystem\fR\fR
-.fi
-.LP
-.nf
-\fBzfs\fR \fBunjail\fR \fBjailid\fR \fB\fIfilesystem\fR\fR
-.fi
-
.SH DESCRIPTION
.sp
.LP
-The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage \
pool, as described in \fBzpool\fR(1M). A
-dataset is identified by a unique path within the \fBZFS\fR namespace. For example:
+The \fBzfs\fR command configures \fBZFS\fR datasets within a \fBZFS\fR storage \
pool, as described in \fBzpool\fR(1M). A dataset is identified by a unique path \
within the \fBZFS\fR namespace. For example:
.sp
.in +2
.nf
@@ -226,9 +202,9 @@ A dataset can be one of the following:
.na
\fB\fIfile system\fR\fR
.ad
-.RS 15n
-.rt
-A standard \fBPOSIX\fR file system. \fBZFS\fR file systems can be mounted within \
the standard file system namespace and behave like any other file system. +.sp .6
+.RS 4n
+A \fBZFS\fR dataset of type "filesystem" that can be mounted within the standard \
system namespace and behaves like other file systems. While \fBZFS\fR file systems \
are designed to be \fBPOSIX\fR compliant, known issues exist that prevent compliance \
in some cases. Applications that depend on standards conformance might fail due to \
nonstandard behavior when checking file system free space.
.RE
.sp
@@ -237,8 +213,8 @@ A standard \fBPOSIX\fR file system. \fBZ
.na
\fB\fIvolume\fR\fR
.ad
-.RS 15n
-.rt
+.sp .6
+.RS 4n
A logical volume exported as a raw or block device. This type of dataset should \
only be used under special circumstances. File systems are typically used in most \
environments. Volumes cannot be used in a non-global zone.
.RE
@@ -248,8 +224,8 @@ A logical volume exported as a raw or bl
.na
\fB\fIsnapshot\fR\fR
.ad
-.RS 15n
-.rt
+.sp .6
+.RS 4n
A read-only version of a file system or volume at a given point in time. It is \
specified as \fIfilesystem@name\fR or \fIvolume@name\fR.
.RE
@@ -272,20 +248,17 @@ A snapshot is a read-only copy of a file
Snapshots can have arbitrary names. Snapshots of volumes can be cloned or rolled \
back, but cannot be accessed independently.
.sp
.LP
-File system snapshots can be accessed under the ".zfs/snapshot" directory in the \
root of the file system. Snapshots are automatically mounted on demand and may be \
unmounted at regular intervals. The visibility of the ".zfs" directory can be \
controlled by the "snapdir"
-property.
+File system snapshots can be accessed under the ".zfs/snapshot" directory in the \
root of the file system. Snapshots are automatically mounted on demand and may be \
unmounted at regular intervals. The visibility of the ".zfs" directory can be \
controlled by the "snapdir" property.
.SS "Clones"
.sp
.LP
A clone is a writable volume or file system whose initial contents are the same as \
another dataset. As with snapshots, creating a clone is nearly instantaneous, and \
initially consumes no additional space.
.sp
.LP
-Clones can only be created from a snapshot. When a snapshot is cloned, it creates \
an implicit dependency between the parent and child. Even though the clone is created \
somewhere else in the dataset hierarchy, the original snapshot cannot be destroyed as \
long as a clone exists. The "origin"
-property exposes this dependency, and the \fBdestroy\fR command lists any such \
dependencies, if they exist. +Clones can only be created from a snapshot. When a \
snapshot is cloned, it creates an implicit dependency between the parent and child. \
Even though the clone is created somewhere else in the dataset hierarchy, the \
original snapshot cannot be destroyed as long as a clone exists. The "origin" \
property exposes this dependency, and the \fBdestroy\fR command lists any such \
dependencies, if they exist.
.sp
.LP
-The clone parent-child dependency relationship can be reversed by using the \
"\fBpromote\fR" subcommand. This causes the "origin" file system to become a clone of \
the specified file system, which makes it possible to destroy the file system that \
the clone
-was created from.
+The clone parent-child dependency relationship can be reversed by using the \
"\fBpromote\fR" subcommand. This causes the "origin" file system to become a clone of \
the specified file system, which makes it possible to destroy the file system that \
the clone was created from.
.SS "Mount Points"
.sp
.LP
@@ -301,8 +274,7 @@ A file system can also have a mount poin
A file system mountpoint property of "none" prevents the file system from being \
mounted.
.sp
.LP
-If needed, \fBZFS\fR file systems can also be managed with traditional tools \
(\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's mount point is set \
to "legacy", \fBZFS\fR makes no attempt to manage
-the file system, and the administrator is responsible for mounting and unmounting \
the file system. +If needed, \fBZFS\fR file systems can also be managed with \
traditional tools (\fBmount\fR, \fBumount\fR, \fB/etc/vfstab\fR). If a file system's \
mount point is set to "legacy", \fBZFS\fR makes no attempt to manage the file system, \
and the administrator is responsible for mounting and unmounting the \
file system.
.SS "Zones"
.sp
.LP
@@ -312,8 +284,7 @@ A \fBZFS\fR file system can be added to
The physical properties of an added file system are controlled by the global \
administrator. However, the zone administrator can create, modify, or destroy files \
within the added file system, depending on how the file system is \
mounted.
.sp
.LP
-A dataset can also be delegated to a non-global zone by using zonecfg's "\fBadd \
dataset\fR" subcommand. You cannot delegate a dataset to one zone and the children of \
the same dataset to another zone. The zone administrator can change properties of the \
dataset or
-any of its children. However, the "quota" property is controlled by the global \
administrator. +A dataset can also be delegated to a non-global zone by using \
zonecfg's "\fBadd dataset\fR" subcommand. You cannot delegate a dataset to one zone \
and the children of the same dataset to another zone. The zone administrator can \
change properties of the dataset or any of its children. However, the "quota" \
property is controlled by the global administrator.
.sp
.LP
A \fBZFS\fR volume can be added as a device to a non-global zone by using zonecfg's \
"\fBadd device\fR" subcommand. However, its physical properties can only be modified \
by the global administrator. @@ -329,15 +300,13 @@ The global administrator can \
forcibly cl
.SS "Native Properties"
.sp
.LP
-Properties are divided into two types, native properties and user defined \
properties. Native properties either export internal statistics or control \fBZFS\fR \
behavior. In addition, native properties are either editable or read-only. User \
properties have no effect on \fBZFS\fR behavior,
-but you can use them to annotate datasets in a way that is meaningful in your \
environment. For more information about user properties, see the "User Properties" \
section. +Properties are divided into two types, native properties and user defined \
properties. Native properties either export internal statistics or control \fBZFS\fR \
behavior. In addition, native properties are either editable or read-only. User \
properties have no effect on \fBZFS\fR behavior, but you can use them to annotate \
datasets in a way that is meaningful in your environment. For more information about \
user properties, see the "User Properties" section.
.sp
.LP
-Every dataset has a set of properties that export statistics about the dataset as \
well as control various behavior. Properties are inherited from the parent unless \
overridden by the child. Snapshot properties can not be edited; they always inherit \
their inheritable properties. Properties
-that are not applicable to snapshots are not displayed.
+Every dataset has a set of properties that export statistics about the dataset as \
well as control various behavior. Properties are inherited from the parent unless \
overridden by the child. Some properties only apply to certain types of datasets \
(file systems, volumes or snapshots).
.sp
.LP
-The values of numeric properties can be specified using the following \
human-readable suffixes (for example, "k", "KB", "M", "Gb", etc, up to Z for \
zettabyte). The following are all valid (and equal) specifications: +The values of \
numeric properties can be specified using human-readable suffixes (for example, "k", \
"KB", "M", "Gb", etc, up to Z for zettabyte). The following are all valid (and equal) \
specifications:
.sp
.in +2
.nf
@@ -360,8 +329,7 @@ The following native properties consist
.ad
.sp .6
.RS 4n
-The amount of space available to the dataset and all its children, assuming that \
there is no other activity in the pool. Because space is shared within a pool, \
availability can be limited by any number of factors, including physical pool size, \
quotas, reservations, or other datasets
-within the pool.
+The amount of space available to the dataset and all its children, assuming that \
there is no other activity in the pool. Because space is shared within a pool, \
availability can be limited by any number of factors, including physical pool size, \
quotas, reservations, or other datasets within the pool.
.sp
This property can also be referred to by its shortened column name, "avail".
.RE
@@ -418,8 +386,7 @@ For cloned file systems or volumes, the
.ad
.sp .6
.RS 4n
-The amount of data that is accessible by this dataset, which may or may not be \
shared with other datasets in the pool. When a snapshot or clone is created, it \
initially references the same amount of space as the file system or snapshot it was \
created from, since its contents are
-identical.
+The amount of data that is accessible by this dataset, which may or may not be \
shared with other datasets in the pool. When a snapshot or clone is created, it \
initially references the same amount of space as the file system or snapshot it was \
created from, since its contents are identical.
.sp
This property can also be referred to by its shortened column name, "refer".
.RE
@@ -432,7 +399,7 @@ This property can also be referred to by
.ad
.sp .6
.RS 4n
-The type of dataset: "filesystem", "volume", "snapshot", or "clone".
+The type of dataset: "filesystem", "volume", or "snapshot".
.RE
.sp
@@ -443,11 +410,9 @@ The type of dataset: "filesystem", "volu
.ad
.sp .6
.RS 4n
-The amount of space consumed by this dataset and all its descendents. This is the \
value that is checked against this dataset's quota and reservation. The space used \
does not include this dataset's reservation, but does take into account the \
reservations of any descendent datasets.
-The amount of space that a dataset consumes from its parent, as well as the amount \
of space that are freed if this dataset is recursively destroyed, is the greater of \
its space used and its reservation. +The amount of space consumed by this dataset \
and all its descendents. This is the value that is checked against this dataset's \
quota and reservation. The space used does not include this dataset's reservation, \
but does take into account the reservations of any descendent datasets. The amount of \
space that a dataset consumes from its parent, as well as the amount of space that \
are freed if this dataset is recursively destroyed, is the greater of its space used \
and its reservation.
.sp
-When snapshots (see the "Snapshots" section) are created, their space is initially \
shared between the snapshot and the file system, and possibly with previous \
snapshots. As the file system changes, space that was previously shared becomes \
unique to the snapshot, and counted in
-the snapshot's space used. Additionally, deleting snapshots can increase the amount \
of space unique to (and used by) other snapshots. +When snapshots (see the \
"Snapshots" section) are created, their space is initially shared between the \
snapshot and the file system, and possibly with previous snapshots. As the file \
system changes, space that was previously shared becomes unique to the snapshot, and \
counted in the snapshot's space used. Additionally, deleting snapshots can increase \
the amount of space unique to (and used by) other snapshots.
.sp
The amount of space used, available, or referenced does not take into account \
pending changes. Pending changes are generally accounted for within a few seconds. \
Committing a change to a disk using \fBfsync\fR(3c) or \fBO_SYNC\fR does not \
necessarily guarantee that the space usage information is updated \
immediately.
.RE
@@ -456,12 +421,66 @@ The amount of space used, available, or
.ne 2
.mk
.na
+\fBusedby*\fR
+.ad
+.sp .6
+.RS 4n
+The \fBusedby*\fR snapshots decompose the "used" properties into the various \
reasons that space is used. Specifically, \fBused\fR = \fBusedbychildren\fR + \
\fBusedbydataset\fR + \fBusedbyrefreservation\fR +, \fBusedbysnapshots\fR. These \
properties are only available for datasets created on zpool "version 13" pools. +.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fBusedbychildren\fR
+.ad
+.sp .6
+.RS 4n
+The amount of space used by children of this dataset, which would be freed if all \
the dataset's children were destroyed. +.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fBusedbydataset\fR
+.ad
+.sp .6
+.RS 4n
+The amount of space used by this dataset itself, which would be freed if the \
dataset were destroyed (after first removing any \fBrefreservation\fR and destroying \
any necessary snapshots or descendents). +.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fBusedbyrefreservation\fR
+.ad
+.sp .6
+.RS 4n
+The amount of space used by a \fBrefreservation\fR set on this dataset, which would \
be freed if the \fBrefreservation\fR was removed. +.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fBusedbysnapshots\fR
+.ad
+.sp .6
+.RS 4n
+The amount of space consumed by snapshots of this dataset. In particular, it is the \
amount of space that would be freed if all of this dataset's snapshots were \
destroyed. Note that this is not simply the sum of the snapshots' "used" properties \
because space can be shared by multiple snapshots +.RE
+
+.sp
+.ne 2
+.mk
+.na
\fBvolblocksize=\fIblocksize\fR\fR
.ad
.sp .6
.RS 4n
-For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be \
changed once the volume has been written, so it should be set at volume creation \
time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 \
bytes
-to 128 Kbytes is valid.
+For volumes, specifies the block size of the volume. The \fBblocksize\fR cannot be \
changed once the volume has been written, so it should be set at volume creation \
time. The default \fBblocksize\fR for volumes is 8 Kbytes. Any power of 2 from 512 \
bytes to 128 Kbytes is valid.
.sp
This property can also be referred to by its shortened column name, "volblock".
.RE
@@ -473,15 +492,13 @@ The following native properties can be u
.ne 2
.mk
.na
-\fBaclinherit=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR | \
\fBpassthrough\fR\fR +\fBaclinherit=\fBdiscard\fR | \fBnoallow\fR | \fBrestricted\fR \
| \fBpassthrough\fR | \fBpassthrough-x\fR\fR
.ad
.sp .6
.RS 4n
-Controls how \fBACL\fR entries are inherited when files and directories are \
created. A file system with an "aclinherit" property of "\fBdiscard\fR" does not \
inherit any \fBACL\fR entries. A file system with an "aclinherit"
-property value of "\fBnoallow\fR" only inherits inheritable \fBACL\fR entries that \
specify "deny" permissions. The property value "\fBrestricted\fR" (the default) \
removes the "\fBwrite_acl\fR" and "\fBwrite_owner\fR" permissions when the \fBACL\fR \
entry is inherited. A file system with an "aclinherit" property value of \
"\fBpassthrough\fR" inherits all inheritable \fBACL\fR entries without any \
modifications made to the \fBACL\fR entries when they are inherited. +Controls how \
\fBACL\fR entries are inherited when files and directories are created. A file system \
with an "aclinherit" property of "\fBdiscard\fR" does not inherit any \fBACL\fR \
entries. A file system with an "aclinherit" property value of "\fBnoallow\fR" only \
inherits inheritable \fBACL\fR entries that specify "deny" permissions. The property \
value "\fBrestricted\fR" (the default) removes the "\fBwrite_acl\fR" and \
"\fBwrite_owner\fR" permissions when the \fBACL\fR entry is inherited. A file system \
with an "aclinherit" property value of "\fBpassthrough\fR" inherits all inheritable \
\fBACL\fR entries without any modifications made to the \fBACL\fR entries when they \
are inherited. A file system with an "aclinherit" property value of \
"\fBpassthrough-x\fR" has the same meaning as "\fBpassthrough\fR", except that the \
\fBowner@\fR, \fBgroup@\fR, and \fBeveryone@\fR \fBACE\fRs inherit the execute \
permission only if the file creation mode also requests the execute \
bit.
.sp
-When the property value is set to "\fBpassthrough\fR," files are created with a \
mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist \
that affect the mode, then the mode is set in accordance to the \
requested mode
-from the application.
+When the property value is set to "\fBpassthrough\fR," files are created with a \
mode determined by the inheritable \fBACE\fRs. If no inheritable \fBACE\fRs exist \
that affect the mode, then the mode is set in accordance to the requested mode from \
the application.
.RE
.sp
@@ -492,9 +509,7 @@ from the application.
.ad
.sp .6
.RS 4n
-Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file system with an \
"aclmode" property of "\fBdiscard\fR"
-deletes all \fBACL\fR entries that do not represent the mode of the file. An \
"aclmode" property of "\fBgroupmask\fR" (the default) reduces user or group \
permissions. The permissions are reduced, such that they are no greater than the \
group permission
-bits, unless it is a user entry that has the same \fBUID\fR as the owner of the \
file or directory. In this case, the \fBACL\fR permissions are reduced so that they \
are no greater than owner permission bits. A file system with an "aclmode" property \
of "\fBpassthrough\fR" indicates that no changes are made to the \fBACL\fR other than \
generating the necessary \fBACL\fR entries to represent the new mode of the file or \
directory. +Controls how an \fBACL\fR is modified during \fBchmod\fR(2). A file \
system with an "aclmode" property of "\fBdiscard\fR" deletes all \fBACL\fR entries \
that do not represent the mode of the file. An "aclmode" property of \
"\fBgroupmask\fR" (the default) reduces user or group permissions. The permissions \
are reduced, such that they are no greater than the group permission bits, unless it \
is a user entry that has the same \fBUID\fR as the owner of the file or directory. In \
this case, the \fBACL\fR permissions are reduced so that they are no greater than \
owner permission bits. A file system with an "aclmode" property of \
"\fBpassthrough\fR" indicates that no changes are made to the \fBACL\fR other than \
generating the necessary \fBACL\fR entries to represent the new mode of the file or \
directory.
.RE
.sp
@@ -505,8 +520,7 @@ bits, unless it is a user entry that has
.ad
.sp .6
.RS 4n
-Controls whether the access time for files is updated when they are read. Turning \
this property off avoids producing write traffic when reading files and can result in \
significant performance gains, though it might confuse mailers and other similar \
utilities. The default value
-is "on".
+Controls whether the access time for files is updated when they are read. Turning \
this property off avoids producing write traffic when reading files and can result in \
significant performance gains, though it might confuse mailers and other similar \
utilities. The default value is "on".
.RE
.sp
@@ -517,12 +531,9 @@ is "on".
.ad
.sp .6
.RS 4n
-If this property is set to "\fBoff\fR", the file system cannot be mounted, and is \
ignored by "\fBzfs mount -a\fR". Setting this property to "\fBoff\fR" is similar to \
setting the "mountpoint"
-property to "\fBnone\fR", except that the dataset still has a normal "mountpoint" \
property, which can be inherited. Setting this property to "\fBoff\fR" allows \
datasets to be used solely as a mechanism to inherit properties. One \
example
-of setting canmount=\fBoff\fR is to have two datasets with the same mountpoint, so \
that the children of both datasets appear in the same directory, but might have \
different inherited characteristics. +If this property is set to "\fBoff\fR", the \
file system cannot be mounted, and is ignored by "\fBzfs mount -a\fR". Setting this \
property to "\fBoff\fR" is similar to setting the "mountpoint" property to \
"\fBnone\fR", except that the dataset still has a normal "mountpoint" property, which \
can be inherited. Setting this property to "\fBoff\fR" allows datasets to be used \
solely as a mechanism to inherit properties. One example of setting \
canmount=\fBoff\fR is to have two datasets with the same mountpoint, so that the \
children of both datasets appear in the same directory, but might have different \
inherited characteristics.
.sp
-When the "\fBnoauto\fR" option is set, a dataset can only be mounted and unmounted \
explicitly. The dataset is not mounted automatically when the dataset is created or \
imported, nor is it mounted by the "\fBzfs mount -a\fR" command or \
unmounted
-by the "\fBzfs unmount -a\fR" command.
+When the "\fBnoauto\fR" option is set, a dataset can only be mounted and unmounted \
explicitly. The dataset is not mounted automatically when the dataset is created or \
imported, nor is it mounted by the "\fBzfs mount -a\fR" command or unmounted by the \
"\fBzfs unmount -a\fR" command.
.sp
This property is not inherited.
.RE
@@ -535,8 +546,7 @@ This property is not inherited.
.ad
.sp .6
.RS 4n
-Controls the checksum used to verify data integrity. The default value is "on", \
which automatically selects an appropriate algorithm (currently, \fIfletcher4\fR, but \
this may change in future releases). The value "off" disables \
integrity
-checking on user data. Disabling checksums is NOT a recommended practice.
+Controls the checksum used to verify data integrity. The default value is "on", \
which automatically selects an appropriate algorithm (currently, \fIfletcher2\fR, but \
this may change in future releases). The value "off" disables integrity checking on \
user data. Disabling checksums is NOT a recommended practice.
.RE
.sp
@@ -547,9 +557,7 @@ checking on user data. Disabling checksu
.ad
.sp .6
.RS 4n
-Controls the compression algorithm used for this dataset. The "lzjb" compression \
algorithm is optimized for performance while providing decent data compression. \
Setting compression to "on" uses the "lzjb" compression algorithm. \
The "gzip"
-compression algorithm uses the same compression as the \fBgzip\fR(1) command. You \
can specify the "gzip" level by using the value "gzip-\fIN\fR" where \
\fIN\fR is
-an integer from 1 (fastest) to 9 (best compression ratio). Currently, "gzip" is \
equivalent to "gzip-6" (which is also the default for \fBgzip\fR(1)). +Controls the \
compression algorithm used for this dataset. The "lzjb" compression algorithm is \
optimized for performance while providing decent data compression. Setting \
compression to "on" uses the "lzjb" compression algorithm. The "gzip" compression \
algorithm uses the same compression as the \fBgzip\fR(1) command. You can specify the \
"gzip" level by using the value "gzip-\fIN\fR" where \fIN\fR is an integer from 1 \
(fastest) to 9 (best compression ratio). Currently, "gzip" is equivalent to "gzip-6" \
(which is also the default for \fBgzip\fR(1)).
.sp
This property can also be referred to by its shortened column name "compress".
.RE
@@ -562,8 +570,7 @@ This property can also be referred to by
.ad
.sp .6
.RS 4n
-Controls the number of copies of data stored for this dataset. These copies are in \
addition to any redundancy provided by the pool, for example, mirroring or raid-z. \
The copies are stored on different disks, if possible. The space used by multiple \
copies is charged to the associated
-file and dataset, changing the "used" property and counting against quotas and \
reservations. +Controls the number of copies of data stored for this dataset. These \
copies are in addition to any redundancy provided by the pool, for example, mirroring \
or raid-z. The copies are stored on different disks, if possible. The space used by \
multiple copies is charged to the associated file and dataset, changing the "used" \
property and counting against quotas and reservations.
.sp
Changing this property only affects newly-written data. Therefore, set this \
property at file system creation time by using the "\fB-o\fR copies=" \
option.
.RE
@@ -600,8 +607,7 @@ Controls whether processes can be execut
.RS 4n
Controls the mount point used for this file system. See the "Mount Points" section \
for more information on how this property is used.
.sp
-When the mountpoint property is changed for a file system, the file system and any \
children that inherit the mount point are unmounted. If the new value is "legacy", \
then they remain unmounted. Otherwise, they are automatically remounted in the new \
location if the property was
-previously "legacy" or "none", or if they were mounted before the property was \
changed. In addition, any shared file systems are unshared and shared in the new \
location. +When the mountpoint property is changed for a file system, the file \
system and any children that inherit the mount point are unmounted. If the new value \
is "legacy", then they remain unmounted. Otherwise, they are automatically remounted \
in the new location if the property was previously "legacy" or "none", or if they \
were mounted before the property was changed. In addition, any shared file systems \
are unshared and shared in the new location.
.RE
.sp
@@ -612,7 +618,18 @@ previously "legacy" or "none", or if the
.ad
.sp .6
.RS 4n
-Controls whether the file system should be mounted with "\fBnbmand\fR" (Non \
Blocking mandatory locks). This is used for \fBCIFS\fR clients. Changes to this \
property only take effect when the file system is umounted and remounted. See \
\fBmount\fR(1M) for more information on "\fBnbmand\fR" mounts. +Controls whether the \
file system should be mounted with "\fBnbmand\fR" (Non Blocking mandatory locks). \
This is used for \fBCIFS\fR clients. Changes to this property only take effect when \
the file system is umounted and remounted. See \fBmount\fR(1M) for more information \
on "\fBnbmand\fR" mounts. +.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fBprimarycache=\fIall\fR | \fInone\fR | \fImetadata\fR\fR
+.ad
+.sp .6
+.RS 4n
+Controls what is cached in the primary cache (ARC). If this property is set to \
"all", then both user data and metadata is cached. If this property is set to "none", \
then neither user data nor metadata is cached. If this property is set to "metadata", \
then only metadata is cached. The default value is "all".
.RE
.sp
@@ -623,8 +640,7 @@ Controls whether the file system should
.ad
.sp .6
.RS 4n
-Limits the amount of space a dataset and its descendents can consume. This property \
enforces a hard limit on the amount of space used. This includes all space consumed \
by descendents, including file systems and snapshots. Setting a quota on a descendent \
of a dataset that already
-has a quota does not override the ancestor's quota, but rather imposes an \
additional limit. +Limits the amount of space a dataset and its descendents can \
consume. This property enforces a hard limit on the amount of space used. This \
includes all space consumed by descendents, including file systems and snapshots. \
Setting a quota on a descendent of a dataset that already has a quota does not \
override the ancestor's quota, but rather imposes an additional \
limit.
.sp
Quotas cannot be set on volumes, as the "volsize" property acts as an implicit \
quota.
.RE
@@ -650,11 +666,9 @@ This property can also be referred to by
.ad
.sp .6
.RS 4n
-Specifies a suggested block size for files in the file system. This property is \
designed solely for use with database workloads that access files in fixed-size \
records. \fBZFS\fR automatically tunes block sizes according to internal algorithms \
optimized for typical
-access patterns.
+Specifies a suggested block size for files in the file system. This property is \
designed solely for use with database workloads that access files in fixed-size \
records. \fBZFS\fR automatically tunes block sizes according to internal algorithms \
optimized for typical access patterns.
.sp
-For databases that create very large files but access them in small random chunks, \
these algorithms may be suboptimal. Specifying a "recordsize" greater than or equal \
to the record size of the database can result in significant performance gains. Use \
of this property for general
-purpose file systems is strongly discouraged, and may adversely affect performance.
+For databases that create very large files but access them in small random chunks, \
these algorithms may be suboptimal. Specifying a "recordsize" greater than or equal \
to the record size of the database can result in significant performance gains. Use \
of this property for general purpose file systems is strongly discouraged, and may \
adversely affect performance.
.sp
The size specified must be a power of two greater than or equal to 512 and less \
than or equal to 128 Kbytes.
.sp
@@ -682,8 +696,7 @@ Limits the amount of space a dataset can
.ad
.sp .6
.RS 4n
-The minimum amount of space guaranteed to a dataset, not including its descendents. \
When the amount of space used is below this value, the dataset is treated as if it \
were taking up the amount of space specified by \fBrefreservation\fR. The \
\fBrefreservation\fR reservation
-is accounted for in the parent datasets' space used, and counts against the parent \
datasets' quotas and reservations. +The minimum amount of space guaranteed to a \
dataset, not including its descendents. When the amount of space used is below this \
value, the dataset is treated as if it were taking up the amount of space specified \
by \fBrefreservation\fR. The \fBrefreservation\fR reservation is accounted for in the \
parent datasets' space used, and counts against the parent datasets' quotas and \
reservations.
.sp
If \fBrefreservation\fR is set, a snapshot is only allowed if there is enough free \
pool space outside of this reservation to accommodate the current number of \
"referenced" bytes in the dataset.
.sp
@@ -698,8 +711,7 @@ This property can also be referred to by
.ad
.sp .6
.RS 4n
-The minimum amount of space guaranteed to a dataset and its descendents. When the \
amount of space used is below this value, the dataset is treated as if it were taking \
up the amount of space specified by its reservation. Reservations are accounted for \
in the parent datasets' space
-used, and count against the parent datasets' quotas and reservations.
+The minimum amount of space guaranteed to a dataset and its descendents. When the \
amount of space used is below this value, the dataset is treated as if it were taking \
up the amount of space specified by its reservation. Reservations are accounted for \
in the parent datasets' space used, and count against the parent datasets' quotas and \
reservations.
.sp
This property can also be referred to by its shortened column name, "reserv".
.RE
@@ -708,6 +720,17 @@ This property can also be referred to by
.ne 2
.mk
.na
+\fBsecondarycache=\fIall\fR | \fInone\fR | \fImetadata\fR\fR
+.ad
+.sp .6
+.RS 4n
+Controls what is cached in the secondary cache (L2ARC). If this property is set to \
"all", then both user data and metadata is cached. If this property is set to "none", \
then neither user data nor metadata is cached. If this property is set to "metadata", \
then only metadata is cached. The default value is "all". +.RE
+
+.sp
+.ne 2
+.mk
+.na
\fBsetuid=\fIon\fR | \fIoff\fR\fR
.ad
.sp .6
@@ -723,8 +746,7 @@ Controls whether the set-\fBUID\fR bit i
.ad
.sp .6
.RS 4n
-Like the "sharenfs" property, "shareiscsi" indicates whether a \fBZFS\fR volume is \
exported as an \fBiSCSI\fR target. The acceptable values for this property are "on", \
"off", and "type=disk".
-The default value is "off". In the future, other target types might be supported. \
For example, "tape". +Like the "sharenfs" property, "shareiscsi" indicates whether a \
\fBZFS\fR volume is exported as an \fBiSCSI\fR target. The acceptable values for this \
property are "on", "off", and "type=disk". The default value is "off". In the future, \
other target types might be supported. For example, "tape".
.sp
You might want to set "shareiscsi=on" for a file system so that all \fBZFS\fR \
volumes within the file system are shared by default. Setting this property on a file \
system has no direct effect, however.
.RE
@@ -737,15 +759,13 @@ You might want to set "shareiscsi=on" fo
.ad
.sp .6
.RS 4n
-Controls whether the file system is shared by using the Solaris \fBCIFS\fR service, \
and what options are to be used. A file system with the "\fBsharesmb\fR" property set \
to "off" is managed through traditional tools such as \fBsharemgr\fR(1M). Otherwise, \
the file system is automatically shared and unshared with the "zfs share" and "zfs \
unshare" commands. If the property is set to "on",
-the \fBsharemgr\fR(1M) command is invoked with no options. Otherwise, the \
\fBsharemgr\fR(1M) command is invoked with options equivalent to the contents of this \
property. +Controls whether the file system is shared by using the Solaris \
\fBCIFS\fR service, and what options are to be used. A file system with the \
"\fBsharesmb\fR" property set to "off" is managed through traditional tools such as \
\fBsharemgr\fR(1M). Otherwise, the file system is automatically shared and unshared \
with the \fBzfs share\fR and \fBzfs unshare\fR commands. If the property is set to \
\fBon\fR, the \fBsharemgr\fR(1M) command is invoked with no options. Otherwise, the \
\fBsharemgr\fR(1M) command is invok ed with options equivalent to the contents of \
this property. +.sp
+Because \fBSMB\fR shares requires a resource name, a unique resource name is \
constructed from the dataset name. The constructed name is a copy of the dataset name \
except that the characters in the dataset name, which would be illegal in the \
resource name, are replaced with underscore (\fB_\fR) characters. A pseudo property \
"name" is also supported that allows you to replace the data set name with a \
specified name. The specified name is then used to replace the prefix dataset in the \
case of inheritance. Fo r example, if the dataset \fBdata/home/john\fR is set to \
\fBname=john\fR, then \fBdata/home/john\fR has a resource name of \fBjohn\fR. If a \
child dataset of \fBdata/home/john/backups\fR, it has a resource name of \
\fBjohn_backups\fR.
.sp
-Because \fBSMB\fR shares requires a resource name, a unique resource name is \
constructed from the dataset name. The constructed name is a copy of the dataset name \
except that the characters in the dataset name, which would be illegal in the \
resource name, are replaced with underscore
-(_) characters. A pseudo property "name" is also supported that allows you to \
replace the data set name with a specified name. The specified name is then used to \
replace the prefix dataset in the case of inheritance. For example, if the dataset \
"\fBdata/home/john\fR"
-is set to "name=john", then "\fBdata/home/john\fR" has a resource name of "john". \
If a child dataset of "\fBdata/home/john/backups\fR", it has a resource name of \
"john_backups". +When SMB shares are created, the SMB share name appears as an entry \
in the \fB\&.zfs/shares\fR directory. You can use the \fBls\fR or \fBchmod\fR command \
to display the share-level ACLs on the entries in this directory.
.sp
-When the "sharesmb" property is changed for a dataset, the dataset and any children \
inheriting the property are re-shared with the new options, only if the property was \
previously set to "off", or if they were shared before the property was changed. If \
the new property
-is set to "off", the file systems are unshared.
+When the \fBsharesmb\fR property is changed for a dataset, the dataset and any \
children inheriting the property are re-shared with the new options, only if the \
property was previously set to \fBoff\fR, or if they were shared before the property \
was changed. If the new property is set to \fBoff\fR, the file \
systems are unshared.
.RE
.sp
@@ -756,11 +776,9 @@ is set to "off", the file systems are un
.ad
.sp .6
.RS 4n
-Controls whether the file system is shared via \fBNFS\fR, and what options are \
used. A file system with a"\fBsharenfs\fR" property of "off" is managed through \
traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \fBdfstab\fR(4). \
Otherwise, the file system is automatically shared and unshared with the "\fBzfs \
share\fR" and "\fBzfs unshare\fR" commands. If the property is set to \
"on",
-the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \
\fBshare\fR(1M) command is invoked with options equivalent to the contents of this \
property. +Controls whether the file system is shared via \fBNFS\fR, and what \
options are used. A file system with a"\fBsharenfs\fR" property of "off" is managed \
through traditional tools such as \fBshare\fR(1M), \fBunshare\fR(1M), and \
\fBdfstab\fR(4). Otherwise, the file system is automatically shared and unshared with \
the "\fBzfs share\fR" and "\fBzfs unshare\fR" commands. If the property is set to \
"on", the \fBshare\fR(1M) command is invoked with no options. Otherwise, the \
\fBshare\fR(1M) command is invoked with options equivalent to the contents of this \
property.
.sp
-When the "sharenfs" property is changed for a dataset, the dataset and any children \
inheriting the property are re-shared with the new options, only if the property was \
previously "off", or if they were shared before the property was changed. If the new \
property is "off",
-the file systems are unshared.
+When the "sharenfs" property is changed for a dataset, the dataset and any children \
inheriting the property are re-shared with the new options, only if the property was \
previously "off", or if they were shared before the property was changed. If the new \
property is "off", the file systems are unshared.
.RE
.sp
@@ -793,14 +811,11 @@ The on-disk version of this file system,
.ad
.sp .6
.RS 4n
-For volumes, specifies the logical size of the volume. By default, creating a \
volume establishes a reservation of equal size. For storage pools with a version \
number of 9 or higher, a \fBrefreservation\fR is set instead. Any changes to \
\fBvolsize\fR are
-reflected in an equivalent change to the reservation (or \fBrefreservation\fR). The \
\fBvolsize\fR can only be set to a multiple of \fBvolblocksize\fR, and cannot be \
zero. +For volumes, specifies the logical size of the volume. By default, creating a \
volume establishes a reservation of equal size. For storage pools with a version \
number of 9 or higher, a \fBrefreservation\fR is set instead. Any changes to \
\fBvolsize\fR are reflected in an equivalent change to the reservation (or \
\fBrefreservation\fR). The \fBvolsize\fR can only be set to a multiple of \
\fBvolblocksize\fR, and cannot be zero.
.sp
-The reservation is kept equal to the volume's logical size to prevent unexpected \
behavior for consumers. Without the reservation, the volume could run out of space, \
resulting in undefined behavior or data corruption, depending on how the volume is \
used. These effects can also occur when
-the volume size is changed while it is in use (particularly when shrinking the \
size). Extreme care should be used when adjusting the volume size. +The reservation \
is kept equal to the volume's logical size to prevent unexpected behavior for \
consumers. Without the reservation, the volume could run out of space, resulting in \
undefined behavior or data corruption, depending on how the volume is used. These \
effects can also occur when the volume size is changed while it is in use \
(particularly when shrinking the size). Extreme care should be used when adjusting \
the volume size.
.sp
-Though not recommended, a "sparse volume" (also known as "thin provisioning") can \
be created by specifying the \fB-s\fR option to the "\fBzfs create -V\fR" command, or \
by changing the reservation after the volume has been created.
-A "sparse volume" is a volume where the reservation is less then the volume size. \
Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is \
low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the \
reservation. +Though not recommended, a "sparse volume" (also known as "thin \
provisioning") can be created by specifying the \fB-s\fR option to the "\fBzfs create \
-V\fR" command, or by changing the reservation after the volume has been created. A \
"sparse volume" is a volume where the reservation is less then the volume size. \
Consequently, writes to a sparse volume can fail with \fBENOSPC\fR when the pool is \
low on space. For a sparse volume, changes to \fBvolsize\fR are not reflected in the \
reservation.
.RE
.sp
@@ -838,8 +853,7 @@ Controls whether the dataset is managed
.sp
.LP
-The following three properties cannot be changed after the file system is created, \
and therefore, should be set when the file system is created. If the properties are \
not set with the "\fBzfs create\fR" command, these properties are inherited from the \
parent dataset.
-If the parent dataset lacks these properties due to having been created prior to \
these features being supported, the new file system will have the default values for \
these properties. +The following three properties cannot be changed after the file \
system is created, and therefore, should be set when the file system is created. If \
the properties are not set with the "\fBzfs create\fR" or "\fBzpool create\fR" \
commands, these properties are inherited from the parent dataset. If the parent \
dataset lacks these properties due to having been created prior to these features \
being supported, the new file system will have the default values for these \
properties.
.sp
.ne 2
.mk
@@ -848,11 +862,9 @@ If the parent dataset lacks these proper
.ad
.sp .6
.RS 4n
-Indicates whether the file name matching algorithm used by the file system should \
be case-sensitive, case-insensitive, or allow a combination of both styles of \
matching. The default value for the "\fBcasesensitivity\fR" property is \
"\fBsensitive\fR."
-Traditionally, UNIX and POSIX file systems have case-sensitive file names.
+Indicates whether the file name matching algorithm used by the file system should \
be case-sensitive, case-insensitive, or allow a combination of both styles of \
matching. The default value for the "\fBcasesensitivity\fR" property is \
"\fBsensitive\fR." Traditionally, UNIX and POSIX file systems have case-sensitive \
file names.
.sp
-The "\fBmixed\fR" value for the "\fBcasesensitivity\fR" property indicates that the \
file system can support requests for both case-sensitive and case-insensitive \
matching behavior. Currently, case-insensitive matching behavior on a \
file system
-that supports mixed behavior is limited to the Solaris CIFS server product. For \
more information about the "mixed" value behavior, see the \fIZFS Administration \
Guide\fR. +The "\fBmixed\fR" value for the "\fBcasesensitivity\fR" property \
indicates that the file system can support requests for both case-sensitive and \
case-insensitive matching behavior. Currently, case-insensitive matching behavior on \
a file system that supports mixed behavior is limited to the Solaris CIFS server \
product. For more information about the "mixed" value behavior, see the \fIZFS \
Administration Guide\fR.
.RE
.sp
@@ -863,20 +875,7 @@ that supports mixed behavior is limited
.ad
.sp .6
.RS 4n
-Indicates whether the file system should perform a \fBunicode\fR normalization of \
file names whenever two file names are compared, and which normalization algorithm \
should be used. File names are always stored unmodified, names are normalized as part \
of any comparison
-process. If this property is set to a legal value other than "\fBnone\fR," and the \
"\fButf8only\fR" property was left unspecified, the "\fButf8only\fR" property is \
automatically set to "\fBon\fR."
-The default value of the "\fBnormalization\fR" property is "\fBnone\fR." This \
property cannot be changed after the file system is created.
-.RE
-
-.sp
-.ne 2
-.mk
-.na
-\fBjailed =\fIon\fR | \fIoff\fR\fR
-.ad
-.sp .6
-.RS 4n
-Controls whether the dataset is managed from within a jail. The default value is \
"off". +Indicates whether the file system should perform a \fBunicode\fR \
normalization of file names whenever two file names are compared, and which \
normalization algorithm should be used. File names are always stored unmodified, \
names are normalized as part of any comparison process. If this property is set to a \
legal value other than "\fBnone\fR," and the "\fButf8only\fR" property was left \
unspecified, the "\fButf8only\fR" property is automatically set to "\fBon\fR." The \
default value of the "\fBnormalization\f R" property is "\fBnone\fR." This property \
cannot be changed after the file system is created.
.RE
.sp
@@ -887,63 +886,52 @@ Controls whether the dataset is managed
.ad
.sp .6
.RS 4n
-Indicates whether the file system should reject file names that include characters \
that are not present in the \fBUTF-8\fR character code set. If this property is \
explicitly set to "\fBoff\fR," the normalization property must either \
not be
-explicitly set or be set to "\fBnone\fR." The default value for the \
"\fButf8only\fR" property is "off." This property cannot be changed after the file \
system is created. +Indicates whether the file system should reject file names that \
include characters that are not present in the \fBUTF-8\fR character code set. If \
this property is explicitly set to "\fBoff\fR," the normalization property must \
either not be explicitly set or be set to "\fBnone\fR." The default value for the \
"\fButf8only\fR" property is "off." This property cannot be changed after the file \
system is created.
.RE
.sp
.LP
-The "\fBcasesensitivity\fR," "\fBnormalization\fR," and "\fButf8only\fR" properties \
are also new permissions that can be assigned to non-privileged users by using the \
\fBZFS\fR delegated administration
-feature.
+The "\fBcasesensitivity\fR," "\fBnormalization\fR," and "\fButf8only\fR" properties \
are also new permissions that can be assigned to non-privileged users by using the \
\fBZFS\fR delegated administration feature.
.SS "Temporary Mount Point Properties"
.sp
.LP
-When a file system is mounted, either through \fBmount\fR(1M) for legacy mounts or \
the "\fBzfs mount\fR" command for normal file systems,
-its mount options are set according to its properties. The correlation between \
properties and mount options is as follows: +When a file system is mounted, either \
through \fBmount\fR(1M) for legacy mounts or the "\fBzfs mount\fR" command for normal \
file systems, its mount options are set according to its properties. The correlation \
between properties and mount options is as follows:
.sp
.in +2
.nf
PROPERTY MOUNT OPTION
- devices devices/nodevices
- exec exec/noexec
- readonly ro/rw
- setuid setuid/nosetuid
- xattr xattr/noxattr
+ devices devices/nodevices
+ exec exec/noexec
+ readonly ro/rw
+ setuid setuid/nosetuid
+ xattr xattr/noxattr
.fi
.in -2
.sp
.sp
.LP
-In addition, these options can be set on a per-mount basis using the \fB-o\fR \
option, without affecting the property that is stored on disk. The values specified \
on the command line override the values stored in the dataset. The \fB-nosuid\fR \
option is an alias for "nodevices,nosetuid".
-These properties are reported as "temporary" by the "\fBzfs get\fR" command. If the \
properties are changed while the dataset is mounted, the new setting overrides any \
temporary settings. +In addition, these options can be set on a per-mount basis \
using the \fB-o\fR option, without affecting the property that is stored on disk. The \
values specified on the command line override the values stored in the dataset. The \
\fB-nosuid\fR option is an alias for "nodevices,nosetuid". These properties are \
reported as "temporary" by the "\fBzfs get\fR" command. If the properties are changed \
while the dataset is mounted, the new setting overrides any temporary \
settings.
.SS "User Properties"
.sp
.LP
-In addition to the standard native properties, \fBZFS\fR supports arbitrary user \
properties. User properties have no effect on \fBZFS\fR behavior, but applications or \
administrators can use them to annotate datasets.
-.sp
-.LP
-User property names must contain a colon (":") character, to distinguish them from \
native properties. They might contain lowercase letters, numbers, and the following \
punctuation characters: colon (":"), dash ("-"), period ("."), and \
underscore
-("_"). The expected convention is that the property name is divided into two \
portions such as "\fImodule\fR:\fIproperty\fR", but this namespace is not enforced by \
\fBZFS\fR. User property names can be at most 256 characters,
-and cannot begin with a dash ("-").
+In addition to the standard native properties, \fBZFS\fR supports arbitrary user \
properties. User properties have no effect on \fBZFS\fR behavior, but applications or \
administrators can use them to annotate datasets (file systems, volumes, and \
snapshots).
.sp
.LP
-When making programmatic use of user properties, it is strongly suggested to use a \
reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to \
reduce the chance that two independently-developed packages use the same property \
name for
-different purposes. Property names beginning with "com.sun." are reserved for use \
by Sun Microsystems. +User property names must contain a colon (":") character to \
distinguish them from native properties. They may contain lowercase letters, numbers, \
and the following punctuation characters: colon (":"), dash ("-"), period ("."), and \
underscore ("_"). The expected convention is that the property name is divided into \
two portions such as "\fImodule\fR:\fIproperty\fR", but this namespace is not \
enforced by \fBZFS\fR. User property names can be at most 256 characters, and cannot \
begin with a dash ("-").
.sp
.LP
-The values of user properties are arbitrary strings, are always inherited, and are \
never validated. All of the commands that operate on properties ("zfs list", "zfs \
get", "zfs set", etc.) can be used to manipulate both native properties and user \
properties.
-Use the "\fBzfs inherit\fR" command to clear a user property . If the property is \
not defined in any parent dataset, it is removed entirely. Property values are \
limited to 1024 characters.
-.SS "Volumes as Swap or Dump Devices"
+When making programmatic use of user properties, it is strongly suggested to use a \
reversed \fBDNS\fR domain name for the \fImodule\fR component of property names to \
reduce the chance that two independently-developed packages use the same property \
name for different purposes. Property names beginning with "com.sun." are reserved \
for use by Sun Microsystems.
.sp
.LP
-To set up a swap area, create a \fBZFS\fR volume of a specific size and then enable \
swap on that device. For more information, see the EXAMPLES section. +The values of \
user properties are arbitrary strings, are always inherited, and are never validated. \
All of the commands that operate on properties ("zfs list", "zfs get", "zfs set", \
etc.) can be used to manipulate both native properties and user properties. Use the \
"\fBzfs inherit\fR" command to clear a user property . If the property is not defined \
in any parent dataset, it is removed entirely. Property values are limited to 1024 \
characters. +.SS "ZFS Volumes as Swap or Dump Devices"
.sp
.LP
-Do not swap to a file on a \fBZFS\fR file system. A \fBZFS\fR swap file \
configuration is not supported. +During an initial installation or a live upgrade \
from a \fBUFS\fR file system, a swap device and dump device are created on \fBZFS\fR \
volumes in the \fBZFS\fR root pool. By default, the swap area size is based on 1/2 \
the size of physical memory up to 2 Gbytes. The size of the dump device depends on \
the kernel's requirements at installation time. Separate \fBZFS\fR volumes must be \
used for the swap area and dump devices. Do not swap to a file on a \fBZFS\fR file \
system. A \fBZFS\fR swap file configuration is not supported.
.sp
.LP
-Using a \fBZFS\fR volume as a dump device is not supported.
+If you need to change your swap area or dump device after the system is installed \
or upgraded, use the \fBswap\fR(1M) and \fBdumpadm\fR(1M) commands. If you need to \
change the size of your swap area or dump device, see the \fISolaris ZFS \
Administration Guide\fR.
.SH SUBCOMMANDS
.sp
.LP
@@ -974,10 +962,9 @@ Creates a new \fBZFS\fR file system. The
.na
\fB\fB-p\fR\fR
.ad
-.RS 21n
-.rt
-Creates all the non-existing parent datasets. Datasets created in this manner are \
automatically mounted according to the "mountpoint" property inherited from their \
parent. Any property specified on the command line using the \fB-o\fR option is \
ignored. If
-the target filesystem already exists, the operation completes successfully.
+.sp .6
+.RS 4n
+Creates all the non-existing parent datasets. Datasets created in this manner are \
automatically mounted according to the "mountpoint" property inherited from their \
parent. Any property specified on the command line using the \fB-o\fR option is \
ignored. If the target filesystem already exists, the operation completes \
successfully.
.RE
.sp
@@ -986,10 +973,9 @@ the target filesystem already exists, th
.na
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
.ad
-.RS 21n
-.rt
-Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the \
same time the dataset was created. Any editable \fBZFS\fR property can also be set at \
creation time. Multiple \fB-o\fR options can be specified. An
-error results if the same property is specified in multiple \fB-o\fR options.
+.sp .6
+.RS 4n
+Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the \
same time the dataset was created. Any editable \fBZFS\fR property can also be set at \
creation time. Multiple \fB-o\fR options can be specified. An error results if the \
same property is specified in multiple \fB-o\fR options.
.RE
.RE
@@ -1002,8 +988,7 @@ error results if the same property is sp
.ad
.sp .6
.RS 4n
-Creates a volume of the given size. The volume is exported as a block device in \
\fB/dev/zvol/{dsk,rdsk}/\fIpath\fR\fR, where \fIpath\fR is the name of the volume in \
the \fBZFS\fR namespace. The size represents
-the logical size as exported by the device. By default, a reservation of equal size \
is created. +Creates a volume of the given size. The volume is exported as a block \
device in \fB/dev/zvol/{dsk,rdsk}/\fIpath\fR\fR, where \fIpath\fR is the name of the \
volume in the \fBZFS\fR namespace. The size represents the logical size as exported \
by the device. By default, a reservation of equal size is created.
.sp
\fIsize\fR is automatically rounded up to the nearest 128 Kbytes to ensure that the \
volume has an integral number of blocks regardless of \
\fIblocksize\fR.
.sp
@@ -1012,10 +997,9 @@ the logical size as exported by the devi
.na
\fB\fB-p\fR\fR
.ad
-.RS 21n
-.rt
-Creates all the non-existing parent datasets. Datasets created in this manner are \
automatically mounted according to the "mountpoint" property inherited from their \
parent. Any property specified on the command line using the \fB-o\fR option is \
ignored. If
-the target filesystem already exists, the operation completes successfully.
+.sp .6
+.RS 4n
+Creates all the non-existing parent datasets. Datasets created in this manner are \
automatically mounted according to the "mountpoint" property inherited from their \
parent. Any property specified on the command line using the \fB-o\fR option is \
ignored. If the target filesystem already exists, the operation completes \
successfully.
.RE
.sp
@@ -1024,8 +1008,8 @@ the target filesystem already exists, th
.na
\fB\fB-s\fR\fR
.ad
-.RS 21n
-.rt
+.sp .6
+.RS 4n
Creates a sparse volume with no reservation. See "volsize" in the Native Properties \
section for more information about sparse volumes.
.RE
@@ -1035,10 +1019,9 @@ Creates a sparse volume with no reservat
.na
\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
.ad
-.RS 21n
-.rt
-Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the \
same time the dataset was created. Any editable \fBZFS\fR property can also be set at \
creation time. Multiple \fB-o\fR options can be specified. An
-error results if the same property is specified in multiple \fB-o\fR options.
+.sp .6
+.RS 4n
+Sets the specified property as if "\fBzfs set property=value\fR" was invoked at the \
same time the dataset was created. Any editable \fBZFS\fR property can also be set at \
creation time. Multiple \fB-o\fR options can be specified. An error results if the \
same property is specified in multiple \fB-o\fR options.
.RE
.sp
@@ -1047,10 +1030,9 @@ error results if the same property is sp
.na
\fB\fB-b\fR \fIblocksize\fR\fR
.ad
-.RS 21n
-.rt
-Equivalent to "\fB\fR\fB-o\fR \fBvolblocksize=\fIblocksize\fR\fR". If this option \
is specified in conjunction with "\fB\fR\fB-o\fR \fBvolblocksize\fR", \
the resulting
-behavior is undefined.
+.sp .6
+.RS 4n
+Equivalent to "\fB\fR\fB-o\fR \fBvolblocksize=\fIblocksize\fR\fR". If this option \
is specified in conjunction with "\fB\fR\fB-o\fR \fBvolblocksize\fR", the resulting \
behavior is undefined.
.RE
.RE
@@ -1070,8 +1052,8 @@ Destroys the given dataset. By default,
.na
\fB\fB-r\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Recursively destroy all children. If a snapshot is specified, destroy all snapshots \
with this name in descendent file systems.
.RE
@@ -1081,8 +1063,8 @@ Recursively destroy all children. If a s
.na
\fB\fB-R\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Recursively destroy all dependents, including cloned file systems outside the \
target hierarchy. If a snapshot is specified, destroy all snapshots with this name in \
descendent file systems.
.RE
@@ -1092,8 +1074,8 @@ Recursively destroy all dependents, incl
.na
\fB\fB-f\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Force an unmount of any file systems using the "\fBunmount -f\fR" command. This \
option has no effect on non-file systems or unmounted file systems.
.RE
@@ -1104,7 +1086,7 @@ Extreme care should be taken when applyi
.ne 2
.mk
.na
-\fB\fBzfs snapshot\fR [\fB-r\fR] \fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
+\fB\fBzfs snapshot\fR [\fB-r\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \
\fIfilesystem@snapname\fR|\fIvolume@snapname\fR\fR
.ad
.sp .6
.RS 4n
@@ -1115,11 +1097,22 @@ Creates a snapshot with the given name.
.na
\fB\fB-r\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Recursively create snapshots of all descendent datasets. Snapshots are taken \
atomically, so that all recursive snapshots correspond to the same \
moment in time.
.RE
+.sp
+.ne 2
+.mk
+.na
+\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
+.ad
+.sp .6
+.RS 4n
+Sets the specified property; see "\fBzfs create\fR" for details.
+.RE
+
.RE
.sp
@@ -1130,16 +1123,15 @@ Recursively create snapshots of all desc
.ad
.sp .6
.RS 4n
-Roll back the given dataset to a previous snapshot. When a dataset is rolled back, \
all data that has changed since the snapshot is discarded, and the dataset reverts to \
the state at the time of the snapshot. By default, the command refuses to roll back \
to a snapshot other than
-the most recent one. In order to do so, all intermediate snapshots must be \
destroyed by specifying the \fB-r\fR option. +Roll back the given dataset to a \
previous snapshot. When a dataset is rolled back, all data that has changed since the \
snapshot is discarded, and the dataset reverts to the state at the time of the \
snapshot. By default, the command refuses to roll back to a snapshot other than the \
most recent one. In order to do so, all intermediate snapshots must be destroyed by \
specifying the \fB-r\fR option.
.sp
.ne 2
.mk
.na
\fB\fB-r\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Recursively destroy any snapshots more recent than the one specified.
.RE
@@ -1149,8 +1141,8 @@ Recursively destroy any snapshots more r
.na
\fB\fB-R\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Recursively destroy any more recent snapshots, as well as any clones of those \
snapshots.
.RE
@@ -1160,8 +1152,8 @@ Recursively destroy any more recent snap
.na
\fB\fB-f\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Used with the \fB-R\fR option to force an unmount of any clone file systems that \
are to be destroyed.
.RE
@@ -1171,7 +1163,7 @@ Used with the \fB-R\fR option to force a
.ne 2
.mk
.na
-\fB\fBzfs clone\fR [\fB-p\fR] \fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
+\fB\fBzfs clone\fR [\fB-p\fR] [\fB-o\fR \fIproperty\fR=\fIvalue\fR] ... \
\fIsnapshot\fR \fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp .6
.RS 4n
@@ -1182,11 +1174,22 @@ Creates a clone of the given snapshot. S
.na
\fB\fB-p\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Creates all the non-existing parent datasets. Datasets created in this manner are \
automatically mounted according to the "mountpoint" property inherited from their \
parent. If the target filesystem or volume already exists, the operation completes \
successfully.
.RE
+.sp
+.ne 2
+.mk
+.na
+\fB\fB-o\fR \fIproperty\fR=\fIvalue\fR\fR
+.ad
+.sp .6
+.RS 4n
+Sets the specified property; see "\fBzfs create\fR" for details.
+.RE
+
.RE
.sp
@@ -1197,11 +1200,9 @@ Creates all the non-existing parent data
.ad
.sp .6
.RS 4n
-Promotes a clone file system to no longer be dependent on its "origin" snapshot. \
This makes it possible to destroy the file system that the clone was created from. \
The clone parent-child dependency relationship is reversed, so that the "origin" file \
system
-becomes a clone of the specified file system.
+Promotes a clone file system to no longer be dependent on its "origin" snapshot. \
This makes it possible to destroy the file system that the clone was created from. \
The clone parent-child dependency relationship is reversed, so that the "origin" file \
system becomes a clone of the specified file system.
.sp
-The snapshot that was cloned, and any snapshots previous to this snapshot, are now \
owned by the promoted clone. The space they use moves from the "origin" file system \
to the promoted clone, so enough space must be available to accommodate these \
snapshots. No new space is consumed
-by this operation, but the space accounting is adjusted. The promoted clone must \
not have any conflicting snapshot names of its own. The "\fBrename\fR" subcommand can \
be used to rename any conflicting snapshots. +The snapshot that was cloned, and any \
snapshots previous to this snapshot, are now owned by the promoted clone. The space \
they use moves from the "origin" file system to the promoted clone, so enough space \
must be available to accommodate these snapshots. No new space is consumed by this \
operation, but the space accounting is adjusted. The promoted clone must not have any \
conflicting snapshot names of its own. The "\fBrename\fR" subcommand can be used to \
rename any conflicting snapshots.
.RE
.sp
@@ -1216,21 +1217,19 @@ by this operation, but the space account
.ad
.br
.na
-\fB\fBzfs
-rename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \fIfilesystem\fR|\fIvolume\fR\fR
+\fB\fBzfs rename\fR [\fB-p\fR] \fIfilesystem\fR|\fIvolume\fR \
\fIfilesystem\fR|\fIvolume\fR\fR
.ad
.sp .6
.RS 4n
-Renames the given dataset. The new target can be located anywhere in the \fBZFS\fR \
hierarchy, with the exception of snapshots. Snapshots can only be renamed within the \
parent file system or volume. When renaming a snapshot, the parent file system of the \
snapshot does
-not need to be specified as part of the second argument. Renamed file systems can \
inherit new mount points, in which case they are unmounted and remounted at the new \
mount point. +Renames the given dataset. The new target can be located anywhere in \
the \fBZFS\fR hierarchy, with the exception of snapshots. Snapshots can only be \
renamed within the parent file system or volume. When renaming a snapshot, the parent \
file system of the snapshot does not need to be specified as part of the second \
argument. Renamed file systems can inherit new mount points, in which case they are \
unmounted and remounted at the new mount point.
.sp
.ne 2
.mk
.na
\fB\fB-p\fR\fR
.ad
-.RS 6n
-.rt
+.sp .6
+.RS 4n
Creates all the non-existing parent datasets. Datasets created in this manner are \
automatically mounted according to the "mountpoint" property inherited from their \
parent.
.RE
@@ -1259,7 +1258,7 @@ Recursively rename the snapshots of all
.ad
.sp .6
.RS 4n
-Lists the property information for the given datasets in tabular form. If \
specified, you can list property information by the absolute pathname or the relative \
pathname. By default, all datasets are displayed and contain the following fields: \
+Lists the property information for the given datasets in tabular form. If specified, \
you can list property information by the absolute pathname or the relative pathname. \
By default, all file systems and volumes are displayed. Snapshots are displayed if \
the "listsnaps" property is "on" (the default is "off") . The following fields are \
displayed:
*** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
_______________________________________________
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org"
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic