aboutsummaryrefslogtreecommitdiff
path: root/sys/contrib/openzfs/man/man7/zfsprops.7
diff options
context:
space:
mode:
Diffstat (limited to 'sys/contrib/openzfs/man/man7/zfsprops.7')
-rw-r--r--sys/contrib/openzfs/man/man7/zfsprops.734
1 files changed, 20 insertions, 14 deletions
diff --git a/sys/contrib/openzfs/man/man7/zfsprops.7 b/sys/contrib/openzfs/man/man7/zfsprops.7
index c6aa8daa964f..0976e80d7309 100644
--- a/sys/contrib/openzfs/man/man7/zfsprops.7
+++ b/sys/contrib/openzfs/man/man7/zfsprops.7
@@ -784,9 +784,9 @@ Changing this property affects only newly-written data.
.Xc
Controls the compression algorithm used for this dataset.
.Pp
-Setting compression to
+When set to
.Sy on
-indicates that the current default compression algorithm should be used.
+(the default), indicates that the current default compression algorithm should be used.
The default balances compression and decompression speed, with compression ratio
and is expected to work well on a wide variety of workloads.
Unlike all other settings for this property,
@@ -1610,8 +1610,11 @@ the file systems are unshared.
.Pp
The share is created with the ACL (Access Control List) "Everyone:F" ("F"
stands for "full permissions", i.e. read and write permissions) and no guest
-access (which means Samba must be able to authenticate a real user, system
-passwd/shadow, LDAP or smbpasswd based) by default.
+access (which means Samba must be able to authenticate a real user \(em
+.Xr passwd 5 Ns / Ns Xr shadow 5 Ns - ,
+LDAP- or
+.Xr smbpasswd 5 Ns -based )
+by default.
This means that any additional access control
(disallow specific user specific access etc) must be done on the underlying file system.
.It Sy sharenfs Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Ar opts
@@ -1816,31 +1819,34 @@ The default value is
This property is not used by OpenZFS.
.It Sy xattr Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy sa
Controls whether extended attributes are enabled for this file system.
-Two styles of extended attributes are supported: either directory based
-or system attribute based.
+Two styles of extended attributes are supported: either directory-based
+or system-attribute-based.
.Pp
The default value of
.Sy on
-enables directory based extended attributes.
+enables directory-based extended attributes.
This style of extended attribute imposes no practical limit
on either the size or number of attributes which can be set on a file.
Although under Linux the
.Xr getxattr 2
and
.Xr setxattr 2
-system calls limit the maximum size to 64K.
+system calls limit the maximum size to
+.Sy 64K .
This is the most compatible
style of extended attribute and is supported by all ZFS implementations.
.Pp
-System attribute based xattrs can be enabled by setting the value to
+System-attribute-based xattrs can be enabled by setting the value to
.Sy sa .
The key advantage of this type of xattr is improved performance.
Storing extended attributes as system attributes
-significantly decreases the amount of disk IO required.
-Up to 64K of data may be stored per-file in the space reserved for system attributes.
+significantly decreases the amount of disk I/O required.
+Up to
+.Sy 64K
+of data may be stored per-file in the space reserved for system attributes.
If there is not enough space available for an extended attribute
-then it will be automatically written as a directory based xattr.
-System attribute based extended attributes are not accessible
+then it will be automatically written as a directory-based xattr.
+System-attribute-based extended attributes are not accessible
on platforms which do not support the
.Sy xattr Ns = Ns Sy sa
feature.
@@ -1850,7 +1856,7 @@ on both
.Fx
and Linux.
.Pp
-The use of system attribute based xattrs is strongly encouraged for users of
+The use of system-attribute-based xattrs is strongly encouraged for users of
SELinux or POSIX ACLs.
Both of these features heavily rely on extended
attributes and benefit significantly from the reduced access time.