mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2026-05-24 19:28:53 +03:00
Ubuntu 22.04 integration: mancheck
Correct new mandoc errors. ``` STYLE: input text line longer than 80 bytes STYLE: no blank before trailing delimiter ``` Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Richard Yao <richard.yao@alumni.stonybrook.edu> Reviewed-by: George Melikov <mail@gmelikov.ru> Signed-off-by: szubersk <szuberskidamian@gmail.com> Closes #14148
This commit is contained in:
committed by
Brian Behlendorf
parent
a5087965fe
commit
b46be903fb
@@ -71,7 +71,8 @@ module.
|
||||
.Pp
|
||||
Booting into a ZFS dataset requires
|
||||
.Sy mountpoint Ns = Ns Pa /
|
||||
to be set on the dataset containing the root filesystem (henceforth "the boot dataset") and at the very least either the
|
||||
to be set on the dataset containing the root filesystem (henceforth "the boot
|
||||
dataset") and at the very least either the
|
||||
.Sy bootfs
|
||||
property to be set to that dataset, or the
|
||||
.Sy root=
|
||||
@@ -86,7 +87,8 @@ matching
|
||||
globs are deemed essential and will be mounted as well.
|
||||
.Pp
|
||||
.Xr zfs-mount-generator 8
|
||||
is recommended for proper functioning of the system afterward (correct mount properties, remounting, &c.).
|
||||
is recommended for proper functioning of the system afterward (correct mount
|
||||
properties, remounting, &c.).
|
||||
.
|
||||
.Sh CMDLINE
|
||||
.Ss Standard
|
||||
@@ -122,7 +124,8 @@ cf.\&
|
||||
.Sx Temporary Mount Point Properties
|
||||
in
|
||||
.Xr zfsprops 7 .
|
||||
These properties will not last, since all filesystems will be re-mounted from the real root.
|
||||
These properties will not last, since all filesystems will be re-mounted from
|
||||
the real root.
|
||||
.
|
||||
.It Sy debug
|
||||
If specified,
|
||||
@@ -263,7 +266,8 @@ Does nothing on
|
||||
.Nm systemd
|
||||
systems
|
||||
.Pq if Pa dracut-zfs-generator No succeeded .
|
||||
Otherwise, loads encryption key for the boot dataset from the console or via plymouth.
|
||||
Otherwise, loads encryption key for the boot dataset from the console or via
|
||||
plymouth.
|
||||
It may not work at all!
|
||||
.El
|
||||
.
|
||||
|
||||
@@ -81,7 +81,8 @@ Bookmarks can be created extremely quickly, compared to snapshots, and they
|
||||
consume no additional space within the pool.
|
||||
Bookmarks can also have arbitrary names, much like snapshots.
|
||||
.Pp
|
||||
Unlike snapshots, bookmarks can not be accessed through the filesystem in any way.
|
||||
Unlike snapshots, bookmarks can not be accessed through the filesystem in any
|
||||
way.
|
||||
From a storage standpoint a bookmark just provides a way to reference
|
||||
when a snapshot was created as a distinct object.
|
||||
Bookmarks are initially tied to a snapshot, not the filesystem or volume,
|
||||
|
||||
+20
-11
@@ -192,7 +192,8 @@ and
|
||||
.It Sy guid
|
||||
The 64 bit GUID of this dataset or bookmark which does not change over its
|
||||
entire lifetime.
|
||||
When a snapshot is sent to another pool, the received snapshot has the same GUID.
|
||||
When a snapshot is sent to another pool, the received snapshot has the same
|
||||
GUID.
|
||||
Thus, the
|
||||
.Sy guid
|
||||
is suitable to identify a snapshot across pools.
|
||||
@@ -259,7 +260,8 @@ this opaque token can be provided to
|
||||
to resume and complete the
|
||||
.Nm zfs Cm receive .
|
||||
.It Sy redact_snaps
|
||||
For bookmarks, this is the list of snapshot guids the bookmark contains a redaction
|
||||
For bookmarks, this is the list of snapshot guids the bookmark contains a
|
||||
redaction
|
||||
list for.
|
||||
For snapshots, this is the list of snapshot guids the snapshot is redacted with
|
||||
respect to.
|
||||
@@ -798,7 +800,8 @@ Controls the compression algorithm used for this dataset.
|
||||
.Pp
|
||||
When set to
|
||||
.Sy on
|
||||
(the default), 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,
|
||||
@@ -861,7 +864,8 @@ is equivalent to
|
||||
.Pp
|
||||
The
|
||||
.Sy zstd
|
||||
compression algorithm provides both high compression ratios and good performance.
|
||||
compression algorithm provides both high compression ratios and good
|
||||
performance.
|
||||
You can specify the
|
||||
.Sy zstd
|
||||
level by using the value
|
||||
@@ -916,7 +920,8 @@ after compression, otherwise the compression will not be considered worthwhile
|
||||
and the block saved uncompressed.
|
||||
Note that when the logical block is less than
|
||||
8 times the disk sector size this effectively reduces the necessary compression
|
||||
ratio; for example, 8 KiB blocks on disks with 4 KiB disk sectors must compress to 1/2
|
||||
ratio; for example, 8 KiB blocks on disks with 4 KiB disk sectors must compress
|
||||
to 1/2
|
||||
or less of their original size.
|
||||
.It Xo
|
||||
.Sy context Ns = Ns Sy none Ns | Ns
|
||||
@@ -1040,7 +1045,7 @@ file system.
|
||||
The default value is
|
||||
.Sy legacy .
|
||||
Setting this property to a value other than
|
||||
.Sy legacy No requires the Sy large_dnode No pool feature to be enabled.
|
||||
.Sy legacy No requires the Sy large_dnode No pool feature to be enabled .
|
||||
.Pp
|
||||
Consider setting
|
||||
.Sy dnodesize
|
||||
@@ -1063,7 +1068,7 @@ if you need to receive a send stream of this dataset on a pool that doesn't
|
||||
enable the
|
||||
.Sy large_dnode
|
||||
feature, or if you need to import this pool on a system that doesn't support the
|
||||
.Sy large_dnode No feature.
|
||||
.Sy large_dnode No feature .
|
||||
.Pp
|
||||
This property can also be referred to by its shortened column name,
|
||||
.Sy dnsize .
|
||||
@@ -1132,14 +1137,16 @@ is selected ZFS will ask for the key at the command prompt when it is required
|
||||
to access the encrypted data (see
|
||||
.Nm zfs Cm load-key
|
||||
for details).
|
||||
This setting will also allow the key to be passed in via the standard input stream,
|
||||
This setting will also allow the key to be passed in via the standard input
|
||||
stream,
|
||||
but users should be careful not to place keys which should be kept secret on
|
||||
the command line.
|
||||
If a file URI is selected, the key will be loaded from the
|
||||
specified absolute file path.
|
||||
If an HTTPS or HTTP URL is selected, it will be GETted using
|
||||
.Xr fetch 3 ,
|
||||
libcurl, or nothing, depending on compile-time configuration and run-time availability.
|
||||
libcurl, or nothing, depending on compile-time configuration and run-time
|
||||
availability.
|
||||
The
|
||||
.Sy SSL_CA_CERT_FILE
|
||||
environment variable can be set to set the location
|
||||
@@ -1499,7 +1506,8 @@ future releases.
|
||||
When set to
|
||||
.Sy some ,
|
||||
ZFS stores an extra copy of only critical metadata.
|
||||
This can improve file create performance since less metadata needs to be written.
|
||||
This can improve file create performance since less metadata
|
||||
needs to be written.
|
||||
If a single on-disk block is corrupt, at worst a single user file can be lost.
|
||||
.Pp
|
||||
When set to
|
||||
@@ -1642,7 +1650,8 @@ 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.
|
||||
(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
|
||||
Controls whether the file system is shared via NFS, and what options are to be
|
||||
used.
|
||||
|
||||
@@ -62,7 +62,8 @@ Refer to the documentation for the ZFS
|
||||
implementation that created the pool for information about those features.
|
||||
.Pp
|
||||
Each supported feature also has a short name.
|
||||
By convention a feature's short name is the portion of its GUID which follows the
|
||||
By convention a feature's short name is the portion of its GUID which follows
|
||||
the
|
||||
.Sq \&:
|
||||
.Po
|
||||
i.e.
|
||||
@@ -167,7 +168,8 @@ separated by whitespace and/or commas.
|
||||
Only features present in all files are enabled.
|
||||
.Pp
|
||||
Simple sanity checks are applied to the files:
|
||||
they must be between 1 B and 16 KiB in size, and must end with a newline character.
|
||||
they must be between 1 B and 16 KiB in size, and must end with a newline
|
||||
character.
|
||||
.Pp
|
||||
The requested features are applied when a pool is created using
|
||||
.Nm zpool Cm create Fl o Sy compatibility Ns = Ns Ar …
|
||||
@@ -268,7 +270,7 @@ or when a new file is created under that filesystem. \
|
||||
The upgrade can also be triggered on filesystems via \
|
||||
Nm zfs Cm set Sy version Ns = Ns Sy current Ar fs . \
|
||||
No The upgrade process runs in the background and may take a while to complete \
|
||||
for filesystems containing large amounts of files.
|
||||
for filesystems containing large amounts of files .
|
||||
.
|
||||
.de checksum-spiel
|
||||
When the
|
||||
@@ -339,7 +341,8 @@ while
|
||||
is non-zero.
|
||||
.
|
||||
.feature org.openzfs blake3 no extensible_dataset
|
||||
This feature enables the use of the BLAKE3 hash algorithm for checksum and dedup.
|
||||
This feature enables the use of the BLAKE3 hash algorithm for checksum and
|
||||
dedup.
|
||||
BLAKE3 is a secure hash algorithm focused on high performance.
|
||||
.Pp
|
||||
.checksum-spiel blake3
|
||||
|
||||
@@ -91,7 +91,7 @@ vdev type is an alias for
|
||||
.Pp
|
||||
A raidz group with
|
||||
.Em N No disks of size Em X No with Em P No parity disks can hold approximately
|
||||
.Em (N-P)*X No bytes and can withstand Em P No devices failing without losing data.
|
||||
.Em (N-P)*X No bytes and can withstand Em P No devices failing without losing data .
|
||||
The minimum number of devices in a raidz group is one more than the number of
|
||||
parity disks.
|
||||
The recommended number is between 3 and 9 to help increase performance.
|
||||
@@ -99,7 +99,7 @@ The recommended number is between 3 and 9 to help increase performance.
|
||||
A variant of raidz that provides integrated distributed hot spares which
|
||||
allows for faster resilvering while retaining the benefits of raidz.
|
||||
A dRAID vdev is constructed from multiple internal raidz groups, each with
|
||||
.Em D No data devices and Em P No parity devices.
|
||||
.Em D No data devices and Em P No parity devices .
|
||||
These groups are distributed over all of the children in order to fully
|
||||
utilize the available disk performance.
|
||||
.Pp
|
||||
@@ -119,7 +119,7 @@ recommended to also add a mirrored
|
||||
vdev to store those blocks.
|
||||
.Pp
|
||||
In regards to I/O, performance is similar to raidz since for any read all
|
||||
.Em D No data disks must be accessed.
|
||||
.Em D No data disks must be accessed .
|
||||
Delivered random IOPS can be reasonably approximated as
|
||||
.Sy floor((N-S)/(D+P))*single_drive_IOPS .
|
||||
.Pp
|
||||
@@ -136,7 +136,7 @@ vdev type is an alias for
|
||||
.Sy draid1 .
|
||||
.Pp
|
||||
A dRAID with
|
||||
.Em N No disks of size Em X , D No data disks per redundancy group, Em P
|
||||
.Em N No disks of size Em X , D No data disks per redundancy group , Em P
|
||||
.No parity level, and Em S No distributed hot spares can hold approximately
|
||||
.Em (N-S)*(D/(D+P))*X No bytes and can withstand Em P
|
||||
devices failing without losing data.
|
||||
@@ -151,7 +151,7 @@ The parity level (1-3).
|
||||
.It Ar data
|
||||
The number of data devices per redundancy group.
|
||||
In general, a smaller value of
|
||||
.Em D No will increase IOPS, improve the compression ratio,
|
||||
.Em D No will increase IOPS, improve the compression ratio ,
|
||||
and speed up resilvering at the expense of total usable capacity.
|
||||
Defaults to
|
||||
.Em 8 , No unless Em N-P-S No is less than Em 8 .
|
||||
|
||||
@@ -82,11 +82,13 @@ By contrast, the
|
||||
property describes how much new data can be written to ZFS filesystems/volumes.
|
||||
The zpool
|
||||
.Sy free
|
||||
property is not generally useful for this purpose, and can be substantially more than the zfs
|
||||
property is not generally useful for this purpose, and can be substantially more
|
||||
than the zfs
|
||||
.Sy available
|
||||
space.
|
||||
This discrepancy is due to several factors, including raidz parity;
|
||||
zfs reservation, quota, refreservation, and refquota properties; and space set aside by
|
||||
zfs reservation, quota, refreservation, and refquota properties; and space set
|
||||
aside by
|
||||
.Sy spa_slop_shift
|
||||
(see
|
||||
.Xr zfs 4
|
||||
@@ -272,7 +274,8 @@ using the
|
||||
command.
|
||||
.It Sy bootfs Ns = Ns Sy (unset) Ns | Ns Ar pool Ns Op / Ns Ar dataset
|
||||
Identifies the default bootable dataset for the root pool.
|
||||
This property is expected to be set mainly by the installation and upgrade programs.
|
||||
This property is expected to be set mainly by the installation and upgrade
|
||||
programs.
|
||||
Not all Linux distribution boot processes use the bootfs property.
|
||||
.It Sy cachefile Ns = Ns Ar path Ns | Ns Sy none
|
||||
Controls the location of where the pool configuration is cached.
|
||||
|
||||
Reference in New Issue
Block a user