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:
szubersk
2022-11-12 22:23:30 +10:00
committed by Brian Behlendorf
parent a5087965fe
commit b46be903fb
37 changed files with 217 additions and 125 deletions
+2 -1
View File
@@ -34,7 +34,8 @@
.
.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
+4 -2
View File
@@ -30,8 +30,10 @@ is an udev helper which parses
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
+4 -2
View File
@@ -174,7 +174,8 @@ negates the effect of the flag that follows it and has no effect unless
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
@@ -274,7 +275,8 @@ the percentage of free space in each space map.
.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.
+12 -6
View File
@@ -61,8 +61,10 @@ Lock all current and future pages in the virtual memory address space.
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
@@ -75,12 +77,14 @@ Write the daemon's process ID to the specified file.
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 .
@@ -111,7 +115,8 @@ Defaults to
.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.
@@ -217,7 +222,8 @@ The ZFS release the daemon is part of.
.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 ,
+1 -1
View File
@@ -411,7 +411,7 @@ mount point permission is set to 755 by default, user
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
+2 -1
View File
@@ -97,7 +97,8 @@ property cannot be changed from within a jail.
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
+6 -3
View File
@@ -236,7 +236,8 @@ Key rotation is managed by ZFS.
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
@@ -291,9 +292,11 @@ Encrypted datasets may not have
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 ,
+5 -4
View File
@@ -49,7 +49,7 @@ units for configured ZFS datasets.
.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 ,
@@ -94,14 +94,15 @@ as the mount unit.
.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 .
+2 -1
View File
@@ -104,7 +104,8 @@ this will cause the terminal to interactively block after asking for the key.
.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
+2 -1
View File
@@ -99,7 +99,8 @@ Clear subdirectories' flags recursively.
.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"
+2 -1
View File
@@ -44,7 +44,8 @@
.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
+15 -8
View File
@@ -215,7 +215,8 @@ compress on the receiver, unless you specify
.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.
@@ -286,7 +287,8 @@ when using this flag.
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 .
@@ -354,7 +356,8 @@ then the data will be decompressed before sending so it can be split into
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.
@@ -386,7 +389,8 @@ If the
.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.
@@ -445,7 +449,7 @@ included in the redaction list contained in the bookmark specified by the
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.
@@ -629,7 +633,8 @@ snapshots themselves.
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.
@@ -641,7 +646,8 @@ However, because all of this data is stored in one ZFS filesystem,
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;
@@ -654,7 +660,8 @@ They would then create a redaction bookmark on the parent snapshot,
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,
+2 -1
View File
@@ -73,7 +73,8 @@
.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
+1 -1
View File
@@ -188,7 +188,7 @@ Each number is in hexadecimal, and only one block can be specified.
.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
+2 -1
View File
@@ -87,7 +87,8 @@ currently in use by another subsystem.
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 ,
+6 -3
View File
@@ -108,7 +108,8 @@ Issued when a pool is exported.
.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
@@ -226,7 +227,8 @@ ID of vdev (if any).
.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
@@ -373,7 +375,8 @@ If this field exists, it is an array of counters.
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
+2 -1
View File
@@ -61,7 +61,8 @@ the disks.
.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.
+3 -2
View File
@@ -66,7 +66,8 @@ If
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
@@ -117,7 +118,7 @@ If
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".
+6 -4
View File
@@ -75,9 +75,11 @@ The
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.
@@ -137,11 +139,11 @@ config:
.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
+2 -1
View File
@@ -40,7 +40,8 @@
.
.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
+3 -1
View File
@@ -97,7 +97,9 @@ again.
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
...
+2 -1
View File
@@ -81,7 +81,8 @@ datasets it attempts to mount as it is bringing the new pool online.
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
+2 -1
View File
@@ -98,7 +98,8 @@ This is the number of I/O operations that didn't complete in
.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
+2 -1
View File
@@ -92,7 +92,8 @@ for details on compatibility with systems that support feature flags, but do not
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.
+8 -5
View File
@@ -121,7 +121,8 @@ or removes the specified device from the pool.
.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
@@ -174,7 +175,8 @@ Checkpoints the current state of
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.
@@ -201,7 +203,8 @@ pool.
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
@@ -384,11 +387,11 @@ config:
.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