Skip to content

Commit

Permalink
Lint most manpages
Browse files Browse the repository at this point in the history 
Reviewed-by: Richard Laager <rlaager@wiktel.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Tony Nguyen <tony.nguyen@delphix.com>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes openzfs#12129
  • Loading branch information
@nabijaczleweli @behlendorf
nabijaczleweli authored and behlendorf committed Jun 4, 2021
1 parent 4a98300 commit f84fe3f
Show file tree
Hide file tree
Showing 58 changed files with 2,718 additions and 2,700 deletions.
37 changes: 24 additions & 13 deletions man/man1/zvol_wait.1
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,32 @@
.Dd July 5, 2019
.Dt ZVOL_WAIT 1 SMM
.\"
.\" This file and its contents are supplied under the terms of the
.\" Common Development and Distribution License ("CDDL"), version 1.0.
.\" You may only use this file in accordance with the terms of version
.\" 1.0 of the CDDL.
.\"
.\" A full copy of the text of the CDDL should have accompanied this
.\" source. A copy of the CDDL is also available via the Internet at
.\" http://www.illumos.org/license/CDDL.
.\"
.Dd May 27, 2021
.Dt ZVOL_WAIT 1
.Os
.
.Sh NAME
.Nm zvol_wait
.Nd Wait for ZFS volume links in
.Em /dev
to be created.
.Nd wait for ZFS volume links to appear in /dev
.Sh SYNOPSIS
.Nm
.
.Sh DESCRIPTION
When a ZFS pool is imported, ZFS will register each ZFS volume
(zvol) as a disk device with the system. As the disks are registered,
.Xr \fBudev 7\fR
will asynchronously create symlinks under
.Em /dev/zvol
using the zvol's name.
When a ZFS pool is imported, the volumes within it will appear as block devices.
As they're registered,
.Xr udev 7
asynchronously creates symlinks under
.Pa /dev/zvol
using the volumes' names.
.Nm
will wait for all those symlinks to be created before returning.
will wait for all those symlinks to be created before exiting.
.
.Sh SEE ALSO
.Xr \fBudev 7\fR
.Xr udev 7
4 changes: 2 additions & 2 deletions man/man8/mount.zfs.8
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
.
.Sh NAME
.Nm mount.zfs
.Nd mount a ZFS filesystem
.Nd mount ZFS filesystem
.Sh SYNOPSIS
.Nm
.Op Fl sfnvh
Expand All @@ -44,7 +44,7 @@ to mount filesystem snapshots and
ZFS filesystems, as well as by
.Xr zfs 8
when the
.Ev Em $ZFS_MOUNT_HELPER
.Sy ZFS_MOUNT_HELPER
environment variable is not set.
Users should should invoke either
.Xr mount 8
Expand Down
126 changes: 69 additions & 57 deletions man/man8/zdb.8
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,54 +8,55 @@
.\" source. A copy of the CDDL is also available via the Internet at
.\" http://www.illumos.org/license/CDDL.
.\"
.\"
.\" Copyright 2012, Richard Lowe.
.\" Copyright (c) 2012, 2019 by Delphix. All rights reserved.
.\" Copyright 2017 Nexenta Systems, Inc.
.\" Copyright (c) 2017 Lawrence Livermore National Security, LLC.
.\" Copyright (c) 2017 Intel Corporation.
.\"
.Dd October 7, 2020
.Dt ZDB 8 SMM
.Dt ZDB 8
.Os
.
.Sh NAME
.Nm zdb
.Nd display zpool debugging and consistency information
.Nd display ZFS storage pool debugging and consistency information
.Sh SYNOPSIS
.Nm
.Op Fl AbcdDFGhikLMPsvXYy
.Op Fl e Oo Fl V Oc Op Fl p Ar path ...
.Op Fl e Oo Fl V Oc Oo Fl p Ar path Oc Ns …
.Op Fl I Ar inflight I/Os
.Oo Fl o Ar var Ns = Ns Ar value Oc Ns ...
.Oo Fl o Ar var Ns = Ns Ar value Oc Ns …
.Op Fl t Ar txg
.Op Fl U Ar cache
.Op Fl x Ar dumpdir
.Op Ar poolname[/dataset | objset ID]
.Op Ar object | range ...
.Op Ar poolname Ns Op / Ns Ar dataset | objset ID
.Op Ar object Ns | Ns Ar range Ns …
.Nm
.Op Fl AdiPv
.Op Fl e Oo Fl V Oc Op Fl p Ar path ...
.Op Fl e Oo Fl V Oc Oo Fl p Ar path Oc Ns …
.Op Fl U Ar cache
.Ar poolname[/dataset | objset ID] Op Ar object | range ...
.Ar poolname Ns Op Ar / Ns Ar dataset | objset ID
.Op Ar object Ns | Ns Ar range Ns …
.Nm
.Fl C
.Op Fl A
.Op Fl U Ar cache
.Nm
.Fl E
.Op Fl A
.Ar word0 Ns \&: Ns Ar word1 Ns :...: Ns Ar word15
.Ar word0 : Ns Ar word1 Ns :…: Ns Ar word15
.Nm
.Fl l
.Op Fl Aqu
.Ar device
.Nm
.Fl m
.Op Fl AFLPXY
.Op Fl e Oo Fl V Oc Op Fl p Ar path ...
.Op Fl e Oo Fl V Oc Oo Fl p Ar path Oc Ns …
.Op Fl t Ar txg
.Op Fl U Ar cache
.Ar poolname Op Ar vdev Op Ar metaslab ...
.Ar poolname Op Ar vdev Oo Ar metaslab Oc Ns …
.Nm
.Fl O
.Ar dataset path
Expand All @@ -65,15 +66,16 @@
.Nm
.Fl R
.Op Fl A
.Op Fl e Oo Fl V Oc Op Fl p Ar path ...
.Op Fl e Oo Fl V Oc Oo Fl p Ar path Oc Ns …
.Op Fl U Ar cache
.Ar poolname vdev Ns \&: Ns Ar offset Ns \&: Ns Ar [<lsize>/]<psize> Ns Op : Ns Ar flags
.Ar poolname vdev : Ns Ar offset : Ns Oo Ar lsize Ns / Oc Ns Ar psize Ns Op : Ns Ar flags
.Nm
.Fl S
.Op Fl AP
.Op Fl e Oo Fl V Oc Op Fl p Ar path ...
.Op Fl e Oo Fl V Oc Oo Fl p Ar path Oc Ns …
.Op Fl U Ar cache
.Ar poolname
.
.Sh DESCRIPTION
The
.Nm
Expand All @@ -99,11 +101,11 @@ or
.Qq Sy @
characters, it is interpreted as a pool name.
The root dataset can be specified as
.Ar pool Ns /
.Pq pool name followed by a slash .
.Qq Ar pool Ns / .
.Pp
When operating on an imported and active pool it is possible, though unlikely,
that zdb may interpret inconsistent pool data and behave erratically.
.
.Sh OPTIONS
Display options:
.Bl -tag -width Ds
Expand Down Expand Up @@ -143,27 +145,30 @@ those specific objects or ranges only.
.Pp
An object ID range is specified in terms of a colon-separated tuple of
the form
.Ao start Ac Ns : Ns Ao end Ac Ns Op Ns : Ns Ao flags Ac Ns .
.Ao start Ac : Ns Ao end Ac Ns Op : Ns Ao flags Ac .
The fields
.Ar start
and
.Ar end
are integer object identifiers that denote the upper and lower bounds
of the range. An
of the range.
An
.Ar end
value of -1 specifies a range with no upper bound. The
value of -1 specifies a range with no upper bound.
The
.Ar flags
field optionally specifies a set of flags, described below, that control
which object types are dumped. By default, all object types are dumped. A minus
sign
which object types are dumped.
By default, all object types are dumped.
A minus sign
.Pq -
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.
flag.
For example, the range 0:-1:A-d will dump all object types except for directories.
.Pp
.Bl -tag -compact
.Bl -tag -compact -width Ds
.It Sy A
Dump all objects (this is the default)
.It Sy d
Expand Down Expand Up @@ -198,7 +203,7 @@ Display the statistics independently for each deduplication table.
Dump the contents of the deduplication tables describing duplicate blocks.
.It Fl DDDDD
Also dump the contents of the deduplication tables describing unique blocks.
.It Fl E Ar word0 Ns \&: Ns Ar word1 Ns :...: Ns Ar word15
.It Fl E Ar word0 : Ns Ar word1 Ns :…: Ns Ar word15
Decode and display block from an embedded block pointer specified by the
.Ar word
arguments.
Expand All @@ -218,18 +223,21 @@ Note, the on disk format of the pool is not reverted to the checkpointed state.
Read the vdev labels and L2ARC header from the specified device.
.Nm Fl l
will return 0 if valid label was found, 1 if error occurred, and 2 if no valid
labels were found. The presence of L2ARC header is indicated by a specific
sequence (L2ARC_DEV_HDR_MAGIC). If there is an accounting error in the size
or the number of L2ARC log blocks
labels were found.
The presence of L2ARC header is indicated by a specific
sequence (L2ARC_DEV_HDR_MAGIC).
If there is an accounting error in the size or the number of L2ARC log blocks
.Nm Fl l
will return 1. Each unique configuration is displayed only
once.
will return 1.
Each unique configuration is displayed only once.
.It Fl ll Ar device
In addition display label space usage stats. If a valid L2ARC header was found
In addition display label space usage stats.
If a valid L2ARC header was found
also display the properties of log blocks used for restoring L2ARC contents
(persistent L2ARC).
.It Fl lll Ar device
Display every configuration, unique or not. If a valid L2ARC header was found
Display every configuration, unique or not.
If a valid L2ARC header was found
also display the properties of log entries in log blocks used for restoring
L2ARC contents (persistent L2ARC).
.Pp
Expand All @@ -239,8 +247,8 @@ option is also specified, don't print the labels or the L2ARC header.
.Pp
If the
.Fl u
option is also specified, also display the uberblocks on this device. Specify
multiple times to increase verbosity.
option is also specified, also display the uberblocks on this device.
Specify multiple times to increase verbosity.
.It Fl L
Disable leak detection and the loading of space maps.
By default,
Expand Down Expand Up @@ -291,7 +299,7 @@ This option can be combined with
.Fl v
for increasing verbosity.
.It Xo
.Fl R Ar poolname vdev Ns \&: Ns Ar offset Ns \&: Ns Ar [<lsize>/]<psize> Ns Op : Ns Ar flags
.Fl R Ar poolname vdev : Ns Ar offset : Ns Oo Ar lsize Ns / Oc Ns Ar psize Ns Op : Ns Ar flags
.Xc
Read and display a block from the specified device.
By default the block is displayed as a hex dump, but see the description of the
Expand All @@ -315,7 +323,8 @@ Print block pointer at hex offset
.It Sy c
Calculate and display checksums
.It Sy d
Decompress the block. Set environment variable
Decompress the block.
Set environment variable
.Nm ZDB_NO_ZLE
to skip zle when guessing.
.It Sy e
Expand Down Expand Up @@ -352,7 +361,7 @@ Enable panic recovery, certain errors which would otherwise be fatal are
demoted to warnings.
.It Fl AAA
Do not abort if asserts fail and also enable panic recovery.
.It Fl e Op Fl p Ar path ...
.It Fl e Oo Fl p Ar path Oc Ns …
Operate on an exported pool, not present in
.Pa /etc/zfs/zpool.cache .
The
Expand Down Expand Up @@ -382,14 +391,16 @@ The default value is 200.
This option affects the performance of the
.Fl c
option.
.It Fl o Ar var Ns = Ns Ar value ...
.It Fl o Ar var Ns = Ns Ar value …
Set the given global libzpool variable to the provided value.
The value must be an unsigned 32-bit integer.
Currently only little-endian systems are supported to avoid accidentally setting
the high 32 bits of 64-bit variables.
.It Fl P
Print numbers in an unscaled form more amenable to parsing, eg. 1000000 rather
than 1M.
Print numbers in an unscaled form more amenable to parsing, e.g.\&
.Sy 1000000
rather than
.Sy 1M .
.It Fl t Ar transaction
Specify the highest transaction to use when searching for uberblocks.
See also the
Expand Down Expand Up @@ -432,51 +443,51 @@ option, with more occurrences enabling more verbosity.
.Pp
If no options are specified, all information about the named pool will be
displayed at default verbosity.
.
.Sh EXAMPLES
.Bl -tag -width Ds
.It Xo
.Sy Example 1
.Sy Example 1 :
Display the configuration of imported pool
.Pa rpool
.Ar rpool
.Xc
.Bd -literal
# zdb -C rpool

.No # Nm zdb Fl C Ar rpool
MOS Configuration:
version: 28
name: 'rpool'
...
…
.Ed
.It Xo
.Sy Example 2
.Sy Example 2 :
Display basic dataset information about
.Pa rpool
.Ar rpool
.Xc
.Bd -literal
# zdb -d rpool
.No # Nm zdb Fl d Ar rpool
Dataset mos [META], ID 0, cr_txg 4, 26.9M, 1051 objects
Dataset rpool/swap [ZVOL], ID 59, cr_txg 356, 486M, 2 objects
...
…
.Ed
.It Xo
.Sy Example 3
.Sy Example 3 :
Display basic information about object 0 in
.Pa rpool/export/home
.Ar rpool/export/home
.Xc
.Bd -literal
# zdb -d rpool/export/home 0
.No # Nm zdb Fl d Ar rpool/export/home 0
Dataset rpool/export/home [ZPL], ID 137, cr_txg 1546, 32K, 8 objects

Object lvl iblk dblk dsize lsize %full type
0 7 16K 16K 15.0K 16K 25.00 DMU dnode
.Ed
.It Xo
.Sy Example 4
.Sy Example 4 :
Display the predicted effect of enabling deduplication on
.Pa rpool
.Ar rpool
.Xc
.Bd -literal
# zdb -S rpool
.No # Nm zdb Fl S Ar rpool
Simulated DDT histogram:

bucket allocated referenced
Expand All @@ -485,10 +496,11 @@ refcnt blocks LSIZE PSIZE DSIZE blocks LSIZE PSIZE DSIZE
------ ------ ----- ----- ----- ------ ----- ----- -----
1 694K 27.1G 15.0G 15.0G 694K 27.1G 15.0G 15.0G
2 35.0K 1.33G 699M 699M 74.7K 2.79G 1.45G 1.45G
...
…
dedup = 1.11, compress = 1.80, copies = 1.00, dedup * compress / copies = 2.00
.Ed
.El
.
.Sh SEE ALSO
.Xr zfs 8 ,
.Xr zpool 8
Loading

0 comments on commit f84fe3f

Please sign in to comment.