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
.It Sy need
ARC reclaim needed
.It Sy free
-The ARC's idea of how much free memory there is, which includes evictable memory in the page cache.
+The ARC's idea of how much free memory there is, which includes evictable memory
+in the page cache.
Since the ARC tries to keep
.Sy avail
above zero,
is usually more instructive to observe than
.Sy free .
.It Sy avail
-The ARC's idea of how much free memory is available to it, which is a bit less than
+The ARC's idea of how much free memory is available to it, which is a bit less
+than
.Sy free .
May temporarily be negative, in which case the ARC will reduce the target size
.Sy c .
The options specified on the command line or in a
.Ar runfile
apply to individual tests in the group.
-The exception is options pertaining to pre and post scripts, which act on all tests as a group.
+The exception is options pertaining to pre and post scripts, which act on all
+tests as a group.
Rather than running before and after each test,
these scripts are run only once each at the start and end of the test group.
.Ss Test Execution
.
.Sh EXAMPLES
.Bl -tag -width "-h"
-.It Sy Example 1 : No Running ad-hoc tests.
+.It Sy Example 1 : No Running ad-hoc tests .
This example demonstrates the simplest invocation of
.Nm .
.Bd -literal
Percent passed: 100.0%
Log directory: /var/tmp/test_results/20120923T180654
.Ed
-.It Sy Example 2 : No Creating a Ar runfile No for future use.
+.It Sy Example 2 : No Creating a Ar runfile No for future use .
This example demonstrates creating a
.Ar runfile
with non-default options.
.Cm label repair
.Ar device
.Xc
-Repair corrupted labels by rewriting the checksum using the presumed valid contents of the label.
+Repair corrupted labels by rewriting the checksum using the presumed valid
+contents of the label.
.El
.
.Sh GLOBAL OPTIONS
Number of vdevs.
.It Fl s , -vdev-size Ns = (default: Sy 64M )
Size of each vdev.
-.It Fl a , -alignment-shift Ns = (default: Sy 9 ) No (use Sy 0 No for random)
+.It Fl a , -alignment-shift Ns = (default: Sy 9 ) No (use Sy 0 No for random )
Alignment shift used in test.
.It Fl m , -mirror-copies Ns = (default: Sy 2 )
Number of mirror copies.
-.It Fl r , -raid-disks Ns = (default: Sy 4 No for raidz/ Ns Sy 16 No for draid)
+.It Fl r , -raid-disks Ns = (default: Sy 4 No for raidz/ Ns Sy 16 No for draid )
Number of raidz/draid disks.
.It Fl R , -raid-parity Ns = (default: Sy 1 )
Raid parity (raidz & draid).
-.It Fl K , -raid-kind Ns = Ns Sy raidz Ns | Ns Sy draid Ns | Ns Sy random No (default: Sy random )
+.It Fl K , -raid-kind Ns = Ns Sy raidz Ns | Ns Sy draid Ns | Ns Sy random No (default : Sy random )
The kind of RAID config to use.
With
.Sy random
.It Fl B , -alt-ztest Ns =
Path to alternate ("older")
.Nm ztest
-to drive, which will be used to initialise the pool, and, a stochastic half the time, to run the tests.
+to drive, which will be used to initialise the pool, and, a stochastic half the
+time, to run the tests.
The parallel
.Pa lib
directory is prepended to
.Fl B Pa ./chroots/lenny/usr/bin/ Ns Nm ,
.Pa ./chroots/lenny/usr/lib
will be loaded.
-.It Fl C , -vdev-class-state Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy random No (default: Sy random )
+.It Fl C , -vdev-class-state Ns = Ns Sy on Ns | Ns Sy off Ns | Ns Sy random No (default : Sy random )
The vdev allocation class state.
.It Fl o , -option Ns = Ns Ar variable Ns = Ns Ar value
Set global
how quickly taskqs ramp up the number of threads processing the queue.
Because Linux thread creation and destruction are relatively inexpensive a
small default value has been selected.
-This means that normally threads will be created aggressively which is desirable.
+This means that normally threads will be created aggressively which is
+desirable.
Increasing this value will
result in a slower thread creation rate which may be preferable for some
configurations.
Default limit for metaslab size.
.
.It Sy zfs_vdev_max_auto_ashift Ns = Ns Sy 14 Pq uint
-Maximum ashift used when optimizing for logical \[->] physical sector size on new
+Maximum ashift used when optimizing for logical \[->] physical sector size on
+new
top-level vdevs.
May be increased up to
.Sy ASHIFT_MAX Po 16 Pc ,
TXGs must pass before unloading will occur.
.
.It Sy reference_history Ns = Ns Sy 3 Pq uint
-Maximum reference holders being tracked when reference_tracking_enable is active.
+Maximum reference holders being tracked when reference_tracking_enable is
+active.
.
.It Sy reference_tracking_enable Ns = Ns Sy 0 Ns | Ns 1 Pq int
Track reference holders to
particularly if they operate close to quota or capacity limits.
.
.It Sy spa_load_print_vdev_tree Ns = Ns Sy 0 Ns | Ns 1 Pq int
-Whether to print the vdev tree in the debugging message buffer during pool import.
+Whether to print the vdev tree in the debugging message buffer during pool
+import.
.
.It Sy spa_load_verify_data Ns = Ns Sy 1 Ns | Ns 0 Pq int
Whether to traverse data blocks during an "extreme rewind"
.Sy zfs_arc_meta_limit_percent
of the ARC may be used for metadata.
.Pp
-This value my be changed dynamically, except that must be set to an explicit value
+This value my be changed dynamically, except that must be set to an explicit
+value
.Pq cannot be set back to Sy 0 .
.
.It Sy zfs_arc_meta_limit_percent Ns = Ns Sy 75 Ns % Pq u64
with the new value.
.Sy arc_p_min_shift No is used as a shift of Sy arc_c
when calculating the minumum
-.Sy arc_p No size.
+.Sy arc_p No size .
.
.It Sy zfs_arc_p_dampener_disable Ns = Ns Sy 1 Ns | Ns 0 Pq int
Disable
Intended for use with the test suite to throttle vdev removal speed.
.
.It Sy zfs_condense_indirect_obsolete_pct Ns = Ns Sy 25 Ns % Pq uint
-Minimum percent of obsolete bytes in vdev mapping required to attempt to condense
+Minimum percent of obsolete bytes in vdev mapping required to attempt to
+condense
.Pq see Sy zfs_condense_indirect_vdevs_enable .
Intended for use with the test suite
to facilitate triggering condensing as needed.
bytes of memory and if the obsolete space map object uses more than
.Sy zfs_condense_max_obsolete_bytes
bytes on-disk.
-The condensing process is an attempt to save memory by removing obsolete mappings.
+The condensing process is an attempt to save memory by removing obsolete
+mappings.
.
.It Sy zfs_condense_max_obsolete_bytes Ns = Ns Sy 1073741824 Ns B Po 1 GiB Pc Pq u64
Only attempt to condense indirect vdev mappings if the on-disk size
same object.
.
.It Sy zfs_slow_io_events_per_second Ns = Ns Sy 20 Ns /s Pq int
-Rate limit delay and deadman zevents (which report slow I/O operations) to this many per
+Rate limit delay and deadman zevents (which report slow I/O operations) to this
+many per
second.
.
.It Sy zfs_unflushed_max_mem_amt Ns = Ns Sy 1073741824 Ns B Po 1 GiB Pc Pq u64
will be deleted asynchronously, while smaller files are deleted synchronously.
Decreasing this value will reduce the time spent in an
.Xr unlink 2
-system call, at the expense of a longer delay before the freed space is available.
+system call, at the expense of a longer delay before the freed space is
+available.
This only applies on Linux.
.
.It Sy zfs_dirty_data_max Ns = Pq int
cleared out after transaction group sync.
Because of some overhead, it should be set at least 2 times the size of
.Sy zfs_dirty_data_max
-.No to prevent harming normal write throughput.
+.No to prevent harming normal write throughput .
It also should be smaller than the size of the slog device if slog is present.
.Pp
Defaults to
4096 ZFS_DEBUG_LOG_SPACEMAP Verify that the log summary is consistent with the spacemap log
and enable \fBzfs_dbgmsgs\fP for metaslab loading and flushing.
.TE
-.Sy \& * No Requires debug build.
+.Sy \& * No Requires debug build .
.
.It Sy zfs_btree_verify_intensity Ns = Ns Sy 0 Pq uint
Enables btree verification.
4 Verify element order. (expensive)
* 5 Verify unused memory is poisoned. (expensive)
.TE
-.Sy \& * No Requires debug build.
+.Sy \& * No Requires debug build .
.
.It Sy zfs_free_leak_on_eio Ns = Ns Sy 0 Ns | Ns 1 Pq int
If destroy encounters an
allocations.
The default value of
.Sy 0
-disables the feature and causes all metaslab groups to be eligible for allocations.
+disables the feature and causes all metaslab groups to be eligible for
+allocations.
.Pp
This parameter allows one to deal with pools having heavily imbalanced
vdevs such as would be the case when a new vdev has been added.
into the special allocation class.
.
.It Sy zfs_multihost_history Ns = Ns Sy 0 Pq uint
-Historical statistics for this many latest multihost updates will be available in
+Historical statistics for this many latest multihost updates will be available
+in
.Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /multihost .
.
.It Sy zfs_multihost_interval Ns = Ns Sy 1000 Ns ms Po 1 s Pc Pq u64
.It Sy zfs_per_txg_dirty_frees_percent Ns = Ns Sy 30 Ns % Pq u64
Control percentage of dirtied indirect blocks from frees allowed into one TXG.
After this threshold is crossed, additional frees will wait until the next TXG.
-.Sy 0 No disables this throttle.
+.Sy 0 No disables this throttle .
.
.It Sy zfs_prefetch_disable Ns = Ns Sy 0 Ns | Ns 1 Pq int
Disable predictive prefetch.
while a lower number indicates we care more about the size of the extent without
considering the gaps within a segment.
This value is only tunable upon module insertion.
-Changing the value afterwards will have no effect on scrub or resilver performance.
+Changing the value afterwards will have no effect on scrub or resilver
+performance.
.
.It Sy zfs_scan_issue_strategy Ns = Ns Sy 0 Pq uint
Determines the order that data will be verified while scrubbing or resilvering:
to coalesce and increase the segment size.
.It Sy 0
.No Use strategy Sy 1 No during normal verification
-.No and strategy Sy 2 No while taking a checkpoint.
+.No and strategy Sy 2 No while taking a checkpoint .
.El
.
.It Sy zfs_scan_legacy Ns = Ns Sy 0 Ns | Ns 1 Pq int
The fraction of the hard limit used to determined the soft limit for I/O sorting
by the sequential scan algorithm.
When we cross this limit from below no action is taken.
-When we cross this limit from above it is because we are issuing verification I/O.
+When we cross this limit from above it is because we are issuing verification
+I/O.
In this case (unless the metadata scan is done) we stop issuing verification I/O
and start scanning metadata again until we get to the hard limit.
.
.
.It Sy zfs_special_class_metadata_reserve_pct Ns = Ns Sy 25 Ns % Pq uint
Only allow small data blocks to be allocated on the special and dedup vdev
-types when the available free space percentage on these vdevs exceeds this value.
+types when the available free space percentage on these vdevs exceeds this
+value.
This ensures reserved space is available for pool metadata as the
special vdevs approach capacity.
.
The
.Em 128 KiB
allocations are especially detrimental to performance
-on highly fragmented systems, which may have very few free segments of this size,
+on highly fragmented systems, which may have very few free segments of this
+size,
and may need to load new metaslabs to satisfy these allocations.
.
.It Sy zfs_sync_pass_rewrite Ns = Ns Sy 2 Pq uint
.
.It Sy zfs_trim_extent_bytes_max Ns = Ns Sy 134217728 Ns B Po 128 MiB Pc Pq uint
Maximum size of TRIM command.
-Larger ranges will be split into chunks no larger than this value before issuing.
+Larger ranges will be split into chunks no larger than this value before
+issuing.
.
.It Sy zfs_trim_extent_bytes_min Ns = Ns Sy 32768 Ns B Po 32 KiB Pc Pq uint
Minimum size of TRIM commands.
.
.It Sy zfs_trim_metaslab_skip Ns = Ns Sy 0 Ns | Ns 1 Pq uint
Skip uninitialized metaslabs during the TRIM process.
-This option is useful for pools constructed from large thinly-provisioned devices
+This option is useful for pools constructed from large thinly-provisioned
+devices
where TRIM operations are slow.
As a pool ages, an increasing fraction of the pool's metaslabs
will be initialized, progressively degrading the usefulness of this option.
before the recently trimmed space is available for use by the device.
.Pp
Increasing this value will allow frees to be aggregated for a longer time.
-This will result is larger TRIM operations and potentially increased memory usage.
+This will result is larger TRIM operations and potentially increased memory
+usage.
Decreasing this value will have the opposite effect.
The default of
.Sy 32
.Pa /proc/spl/kstat/zfs/ Ns Ao Ar pool Ac Ns Pa /TXGs .
.
.It Sy zfs_txg_timeout Ns = Ns Sy 5 Ns s Pq uint
-Flush dirty data to disk at least every this many seconds (maximum TXG duration).
+Flush dirty data to disk at least every this many seconds (maximum TXG
+duration).
.
.It Sy zfs_vdev_aggregate_trim Ns = Ns Sy 0 Ns | Ns 1 Pq uint
Allow TRIM I/O operations to be aggregated.
.
.It Sy zfs_vdev_mirror_non_rotating_seek_inc Ns = Ns Sy 1 Pq int
A number by which the balancing algorithm increments the load calculation for
-the purpose of selecting the least busy mirror member when an I/O operation lacks
+the purpose of selecting the least busy mirror member when an I/O operation
+lacks
locality as defined by the
.Sy zfs_vdev_mirror_rotating_seek_offset .
Operations within this that are not immediately following the previous operation
However, if there are fewer than
.Sy zfs_embedded_slog_min_ms
metaslabs in the vdev, this functionality is disabled.
-This ensures that we don't set aside an unreasonable amount of space for the ZIL.
+This ensures that we don't set aside an unreasonable amount of space for the
+ZIL.
.
.It Sy zstd_earlyabort_pass Ns = Ns Sy 1 Pq uint
Whether heuristic for detection of incompressible data with zstd levels >= 3
Iteration through the I/O classes is done in the order specified above.
No further operations are issued
if the aggregate maximum number of concurrent operations has been hit,
-or if there are no operations queued for an I/O class that has not hit its maximum.
+or if there are no operations queued for an I/O class that has not hit its
+maximum.
Every time an I/O operation is queued or an operation completes,
the scheduler looks for new operations to issue.
.Pp
according to the amount of dirty data in the pool.
Since both throughput and latency typically increase with the number of
concurrent operations issued to physical devices, reducing the
-burstiness in the number of concurrent operations also stabilizes the
-response time of operations from other – and in particular synchronous – queues.
+burstiness in the number of simultaneous operations also stabilizes the
+response time of operations from other queues, in particular synchronous ones.
In broad strokes, the I/O scheduler will issue more concurrent operations
-from the async write queue as there's more dirty data in the pool.
+from the async write queue as there is more dirty data in the pool.
.
.Ss Async Writes
The number of concurrent operations issued for the async write I/O class
has failed to keep up with the incoming write rate.
The scale of the curve is defined by
.Sy zfs_delay_scale .
-Roughly speaking, this variable determines the amount of delay at the midpoint of the curve.
+Roughly speaking, this variable determines the amount of delay at the midpoint
+of the curve.
.Bd -literal
delay
10ms +-------------------------------------------------------------*+
.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=
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
.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,
.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
.
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,
.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.
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.
.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,
.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
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
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
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 .
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
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
.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.
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.
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 …
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
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
.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.
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
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
.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.
.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 .
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
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.
.
.Sh DESCRIPTION
.Nm
-is a thin shell wrapper that at most checks the status of a dataset's container pool.
+is a thin shell wrapper that at most checks the status of a dataset's container
+pool.
It is installed by OpenZFS because some Linux
distributions expect a fsck helper for all filesystems.
.Pp
to map a physical path in a storage topology to a channel name.
The channel name is combined with a disk enclosure slot number to create
an alias that reflects the physical location of the drive.
-This is particularly helpful when it comes to tasks like replacing failed drives.
-Slot numbers may also be remapped in case the default numbering is unsatisfactory.
+This is particularly helpful when it comes to tasks like replacing failed
+drives.
+Slot numbers may also be remapped in case the default numbering is
+unsatisfactory.
The drive aliases will be created as symbolic links in
.Pa /dev/disk/by-vdev .
.Pp
preceded by the
.Ar A
flag.
-For example, the range 0:-1:A-d will dump all object types except for directories.
+For example, the range 0:-1:A-d will dump all object types except for
+directories.
.Pp
.Bl -tag -compact -width Ds
.It Sy A
.It Fl mmmm
Display every spacemap record.
.It Fl M , -metaslab-groups
-Display all "normal" vdev metaslab group information - per-vdev metaslab count, fragmentation,
+Display all "normal" vdev metaslab group information - per-vdev metaslab count,
+fragmentation,
and free space histogram, as well as overall pool fragmentation and histogram.
.It Fl MM
"Special" vdevs are added to -M's normal output.
This may help the daemon remain responsive when the system is under heavy
memory pressure.
.It Fl I
-Request that the daemon idle rather than exit when the kernel modules are not loaded.
-Processing of events will start, or resume, when the kernel modules are (re)loaded.
+Request that the daemon idle rather than exit when the kernel modules are not
+loaded.
+Processing of events will start, or resume, when the kernel modules are
+(re)loaded.
Under Linux the kernel modules cannot be unloaded while the daemon is running.
.It Fl Z
Zero the daemon's state, thereby allowing zevents still within the kernel
Custom
.Ev $PATH
for zedlets to use.
-Normally zedlets run in a locked-down environment, with hardcoded paths to the ZFS commands
+Normally zedlets run in a locked-down environment, with hardcoded paths to the
+ZFS commands
.Pq Ev $ZFS , $ZPOOL , $ZED , … ,
and a hard-coded
.Ev $PATH .
This is done for security reasons.
-However, the ZFS test suite uses a custom PATH for its ZFS commands, and passes it to
+However, the ZFS test suite uses a custom PATH for its ZFS commands, and passes
+it to
.Nm
with
.Fl P .
.El
.Sh ZEVENTS
A zevent is comprised of a list of nvpairs (name/value pairs).
-Each zevent contains an EID (Event IDentifier) that uniquely identifies it throughout
+Each zevent contains an EID (Event IDentifier) that uniquely identifies it
+throughout
the lifetime of the loaded ZFS kernel module; this EID is a monotonically
increasing integer that resets to 1 each time the kernel module is loaded.
Each zevent also contains a class string that identifies the type of event.
.El
.Pp
ZEDLETs may need to call other ZFS commands.
-The installation paths of the following executables are defined as environment variables:
+The installation paths of the following executables are defined as environment
+variables:
.Sy ZDB ,
.Sy ZED ,
.Sy ZFS ,
will be unable to mount file systems under
.Ar tank/cindys .
Add an ACE similar to the following syntax to provide mount point access:
-.Dl # Cm chmod No A+user: Ns Ar cindys Ns :add_subdirectory:allow Ar /tank/cindys
+.Dl # Cm chmod No A+user : Ns Ar cindys Ns :add_subdirectory:allow Ar /tank/cindys
.
.Ss Example 2 : No Delegating Create Time Permissions on a ZFS Dataset
The following example shows how to grant anyone in the group
After a dataset is attached to a jail and the
.Sy 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.
+since the jail administrator might have set the mount point to an unacceptable
+value.
.Pp
See
.Xr jail 8
Changing the user's key (e.g. a passphrase)
does not require re-encrypting the entire dataset.
Datasets can be scrubbed,
-resilvered, renamed, and deleted without the encryption keys being loaded (see the
+resilvered, renamed, and deleted without the encryption keys being loaded (see
+the
.Cm load-key
subcommand for more info on key loading).
.Pp
since the implementation stores some encryption metadata where the third copy
would normally be.
Since compression is applied before encryption, datasets may
-be vulnerable to a CRIME-like attack if applications accessing the data allow for it.
+be vulnerable to a CRIME-like attack if applications accessing the data allow
+for it.
Deduplication with encryption will leak information about which blocks
-are equivalent in a dataset and will incur an extra CPU cost for each block written.
+are equivalent in a dataset and will incur an extra CPU cost for each block
+written.
.
.Sh SEE ALSO
.Xr zfsprops 7 ,
.No Skipped if Sy off .
.No Skipped if only Sy noauto
datasets exist for a given mountpoint and there's more than one.
-.No Datasets with Sy yes No take precedence over ones with Sy noauto No for the same mountpoint.
+.No Datasets with Sy yes No take precedence over ones with Sy noauto No for the same mountpoint .
.No Sets logical Em noauto No flag if Sy noauto .
Encryption roots always generate
.Sy zfs-load-key@ Ns Ar root Ns Sy .service ,
.No Sets Sy After Ns = for the mount unit.
.
.It Sy org.openzfs.systemd:wanted-by Ns = Ns Pa unit Ns Oo " " Ns Pa unit Oc Ns …
-.No Sets logical Em noauto No flag (see below).
+.No Sets logical Em noauto No flag (see below) .
.No If not Sy none , No sets Sy WantedBy Ns = for the mount unit.
.It Sy org.openzfs.systemd:required-by Ns = Ns Pa unit Ns Oo " " Ns Pa unit Oc Ns …
-.No Sets logical Em noauto No flag (see below).
+.No Sets logical Em noauto No flag (see below) .
.No If not Sy none , No sets Sy RequiredBy Ns = for the mount unit.
.
.It Sy org.openzfs.systemd:nofail Ns = Ns (unset) Ns | Ns Sy on Ns | Ns Sy off
-Waxes or wanes strength of default reverse dependencies of the mount unit, see below.
+Waxes or wanes strength of default reverse dependencies of the mount unit, see
+below.
.
.It Sy org.openzfs.systemd:ignore Ns = Ns Sy on Ns | Ns Sy off
.No Skip if Sy on .
.It Fl v
Report mount progress.
.It Fl f
-Attempt to force mounting of all filesystems, even those that couldn't normally be mounted (e.g. redacted datasets).
+Attempt to force mounting of all filesystems, even those that couldn't normally
+be mounted (e.g. redacted datasets).
.El
.It Xo
.Nm zfs
.Ar file Ns | Ns Ar directory Ns …
.Xc
Check project ID and inherit flag on the files and directories:
-report entries without the project inherit flag, or with project IDs different from the
+report entries without the project inherit flag, or with project IDs different
+from the
target directory's project ID or the one specified with
.Fl p .
.Bl -tag -width "-p id"
.Sh DESCRIPTION
The
.Nm zfs Cm promote
-command makes it possible to destroy the dataset that the clone was created from.
+command makes it possible to destroy the dataset that the clone was created
+from.
The clone parent-child dependency relationship is reversed, so that the origin
dataset becomes a clone of the specified dataset.
.Pp
.Fl o Sy compress Ns = Em off .
.It Fl w , -raw
For encrypted datasets, send data exactly as it exists on disk.
-This allows backups to be taken even if encryption keys are not currently loaded.
+This allows backups to be taken even if encryption keys are not currently
+loaded.
The backup may then be received on an untrusted machine since that machine will
not have the encryption keys to read the protected data or alter it without
being detected.
Allows sending a replication stream even when there are snapshots missing in the
hierarchy.
When a snapshot is missing, instead of throwing an error and aborting the send,
-a warning is printed to the standard error stream and the dataset to which it belongs
+a warning is printed to the standard error stream and the dataset to which it
+belongs
and its descendents are skipped.
This flag can only be used in conjunction with
.Fl R .
smaller block sizes.
.It Fl w , -raw
For encrypted datasets, send data exactly as it exists on disk.
-This allows backups to be taken even if encryption keys are not currently loaded.
+This allows backups to be taken even if encryption keys are not currently
+loaded.
The backup may then be received on an untrusted machine since that machine will
not have the encryption keys to read the protected data or alter it without
being detected.
.Sy lz4_compress
feature is active on the sending system, then the receiving system must have
that feature enabled as well.
-Datasets that are sent with this flag may not be received as an encrypted dataset,
+Datasets that are sent with this flag may not be received as an encrypted
+dataset,
since encrypted datasets cannot use the
.Sy embedded_data
feature.
flag.
The resulting send stream is said to be redacted with respect to the snapshots
the bookmark specified by the
-.Fl -redact No flag was created with.
+.Fl -redact No flag was created with .
The bookmark must have been created by running
.Nm zfs Cm redact
on the snapshot being sent.
In order to make the purpose of the feature more clear, an example is provided.
Consider a zfs filesystem containing four files.
These files represent information for an online shopping service.
-One file contains a list of usernames and passwords, another contains purchase histories,
+One file contains a list of usernames and passwords, another contains purchase
+histories,
a third contains click tracking data, and a fourth contains user preferences.
The owner of this data wants to make it available for their development teams to
test against, and their market research teams to do analysis on.
it must all be sent and received together.
In addition, the owner of the data
wants to take advantage of features like compression, checksumming, and
-snapshots, so they do want to continue to use ZFS to store and transmit their data.
+snapshots, so they do want to continue to use ZFS to store and transmit their
+data.
Redaction can help them do so.
First, they would make two clones of a snapshot of the data on the source.
In one clone, they create the setup they want their market research team to see;
using snapshots on the two clones as redaction snapshots.
The parent can then be sent, redacted, to the target
server where the research and development teams have access.
-Finally, incremental sends from the parent snapshot to each of the clones can be sent
+Finally, incremental sends from the parent snapshot to each of the clones can be
+sent
to and received on the target server; these snapshots are identical to the
ones on the source, and are ready to be used, while the parent snapshot on the
target contains none of the username and password data present on the source,
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc
.Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path
.Xc
-Displays space consumed by, and quotas on, each user in the specified filesystem,
+Displays space consumed by, and quotas on, each user in the specified
+filesystem,
snapshot, or path.
If a path is given, the filesystem that contains that path will be used.
This corresponds to the
.It Fl C Ar dvas
Inject the given error only into specific DVAs.
The mask should be specified as a list of 0-indexed DVAs separated by commas
-.No (e.g. Ar 0,2 Ns No ).
+.No (e.g . Ar 0,2 Ns No ).
This option is not applicable to logical data errors such as
.Sy decompress
and
However this check is not robust enough
to detect simultaneous attempts to use a new device in different pools, even if
.Sy multihost Ns = Sy enabled .
-The administrator must ensure, that simultaneous invocations of any combination of
+The administrator must ensure, that simultaneous invocations of any combination
+of
.Nm zpool Cm replace ,
.Nm zpool Cm create ,
.Nm zpool Cm add ,
.It Sy zpool.import
Issued when a pool is imported.
.It Sy zpool.reguid
-Issued when a REGUID (new unique identifier for the pool have been regenerated) have been detected.
+Issued when a REGUID (new unique identifier for the pool have been regenerated)
+have been detected.
.It Sy vdev.unknown
Issued when the vdev is unknown.
Such as trying to clear device errors on a vdev that have failed/been kicked
.It Sy vdev_fru
Physical FRU location.
.It Sy vdev_state
-State of vdev (0=uninitialized, 1=closed, 2=offline, 3=removed, 4=failed to open, 5=faulted, 6=degraded, 7=healthy).
+State of vdev (0=uninitialized, 1=closed, 2=offline, 3=removed, 4=failed to
+open, 5=faulted, 6=degraded, 7=healthy).
.It Sy vdev_ashift
The ashift value of the vdev.
.It Sy vdev_complete_ts
Each entry counts bit clears in a particular bit of a big-endian uint64 type.
The first entry counts bits
clears of the high-order bit of the first byte, the 9th byte, etc, and the
-last entry counts clears of the low-order bit of the 8th byte, the 16th byte, etc.
+last entry counts clears of the low-order bit of the 8th byte, the 16th byte,
+etc.
This information is useful for observing a stuck bit in a parallel data
path, such as IDE or parallel SCSI.
.El
.It Fl a
Exports all pools imported on the system.
.It Fl f
-Forcefully unmount all datasets, and allow export of pools with active shared spares.
+Forcefully unmount all datasets, and allow export of pools with active shared
+spares.
.Pp
This command will forcefully export the pool even if it has a shared spare that
is currently being used.
is specified, the command exits after
.Ar count
reports are printed.
-The first report printed is always the statistics since boot regardless of whether
+The first report printed is always the statistics since boot regardless of
+whether
.Ar interval
and
.Ar count
is passed without a script name, it prints a list of all scripts.
.Fl c
also sets verbose mode
-.No \&( Ns Fl v Ns No \&).
+.No \&( Ns Fl v Ns No \&) .
.Pp
Script output should be in the form of "name=value".
The column name is set to "name" and the value is set to "value".
feature flag must be enabled to remove a top-level vdev, see
.Xr zpool-features 7 .
.Pp
-A mirrored top-level device (log or data) can be removed by specifying the top-level mirror for the
+A mirrored top-level device (log or data) can be removed by specifying the top-
+level mirror for the
same.
-Non-log devices or data devices that are part of a mirrored configuration can be removed using
+Non-log devices or data devices that are part of a mirrored configuration can be
+removed using
the
.Nm zpool Cm detach
command.
.Ed
.Pp
The command to remove the mirrored log
-.Ar mirror-2 No is:
+.Ar mirror-2 No is :
.Dl # Nm zpool Cm remove Ar tank mirror-2
.Pp
The command to remove the mirrored data
-.Ar mirror-1 No is:
+.Ar mirror-1 No is :
.Dl # Nm zpool Cm remove Ar tank mirror-1
.
.Sh SEE ALSO
.
.Sh DESCRIPTION
Starts a resilver of the specified pools.
-If an existing resilver is already running it will be restarted from the beginning.
+If an existing resilver is already running it will be restarted from the
+beginning.
Any drives that were scheduled for a deferred
resilver will be added to the new one.
This requires the
Wait until scrub has completed before returning.
.El
.Sh EXAMPLES
-.Ss Example 1 : No Status of pool with ongoing scrub:
+.Ss Example 1
+Status of pool with ongoing scrub:
+.sp
.Bd -literal -compact
.No # Nm zpool Cm status
...
Note that if any datasets have
.Sy keylocation Ns = Ns Sy prompt ,
this command will block waiting for the keys to be entered.
-Without this flag, encrypted datasets will be left unavailable until the keys are loaded.
+Without this flag, encrypted datasets will be left unavailable until the keys
+are loaded.
.It Fl n
Do a dry-run
.Pq Qq No-op
.Sy zio_slow_io_ms
milliseconds
.Pq Sy 30000 No by default .
-This does not necessarily mean the I/O operations failed to complete, just took an
+This does not necessarily mean the I/O operations failed to complete, just took
+an
unreasonably long amount of time.
This may indicate a problem with the underlying storage.
.It Fl t
support all features enabled on the pool.
.Bl -tag -width Ds
.It Fl a
-Enables all supported features (from specified compatibility sets, if any) on all
+Enables all supported features (from specified compatibility sets, if any) on
+all
pools.
.It Fl V Ar version
Upgrade to the specified legacy version.
.It Xr zpool-replace 8
Replaces an existing device (which may be faulted) with a new one.
.It Xr zpool-split 8
-Creates a new pool by splitting all mirrors in an existing pool (which decreases its redundancy).
+Creates a new pool by splitting all mirrors in an existing pool (which decreases
+its redundancy).
.El
.
.Ss Properties
which can be later restored by
.Nm zpool Cm import Fl -rewind-to-checkpoint .
.It Xr zpool-trim 8
-Initiates an immediate on-demand TRIM operation for all of the free space in a pool.
+Initiates an immediate on-demand TRIM operation for all of the free space in a
+pool.
This operation informs the underlying storage devices of all blocks
in the pool which are no longer allocated and allows thinly provisioned
devices to reclaim the space.
Takes the specified physical device offline or brings it online.
.It Xr zpool-resilver 8
Starts a resilver.
-If an existing resilver is already running it will be restarted from the beginning.
+If an existing resilver is already running it will be restarted from the
+beginning.
.It Xr zpool-reopen 8
Reopen all the vdevs associated with the pool.
.It Xr zpool-clear 8
.Ed
.Pp
The command to remove the mirrored log
-.Ar mirror-2 No is:
+.Ar mirror-2 No is :
.Dl # Nm zpool Cm remove Ar tank mirror-2
.Pp
The command to remove the mirrored data
-.Ar mirror-1 No is:
+.Ar mirror-1 No is :
.Dl # Nm zpool Cm remove Ar tank mirror-1
.
.Ss Example 15 : No Displaying expanded space on a device
projects / mirror_zfs.git / commitdiff