From 2e2ddc30b47c174d95c2eb491452a7587e3e129f Mon Sep 17 00:00:00 2001 From: Tim Chase Date: Sun, 13 Oct 2013 11:36:15 -0500 Subject: Dedup-related documentation additions for zpool and zdb. Document the "-D" and "-T" options and the optional interval and count or "zpool status". Also for zpool's man page, use a consistent order for the various "-T" options to match the program's help output. Document the effect of additional "-D" options for zdb. Signed-off-by: Brian Behlendorf Closes #1786 --- man/man8/zdb.8 | 6 ++++++ man/man8/zpool.8 | 42 +++++++++++++++++++++++++++++++++--------- 2 files changed, 39 insertions(+), 9 deletions(-) (limited to 'man/man8') diff --git a/man/man8/zdb.8 b/man/man8/zdb.8 index 364cf3015..6f4f40d1c 100644 --- a/man/man8/zdb.8 +++ b/man/man8/zdb.8 @@ -133,6 +133,12 @@ compression ratio (compress), inflation due to the zfs copies property If specified twice, display a histogram of deduplication statistics, showing the allocated (physically present on disk) and referenced (logically referenced in the pool) block counts and sizes by reference count. +.sp +If specified a third time, display the statistics independently for each deduplication table. +.sp +If specified a fourth time, dump the contents of the deduplication tables describing duplicate blocks. +.sp +If specified a fifth time, also dump the contents of the deduplication tables describing unique blocks. .RE .sp diff --git a/man/man8/zpool.8 b/man/man8/zpool.8 index b60a2a3f7..e86a6b0d5 100644 --- a/man/man8/zpool.8 +++ b/man/man8/zpool.8 @@ -89,7 +89,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool iostat\fR [\fB-T\fR u | d ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]] +\fBzpool iostat\fR [\fB-T\fR d | u ] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]] .fi .LP @@ -99,7 +99,8 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool list\fR [\fB-T\fR u | d ] [\fB-Hv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]] +\fBzpool list\fR [\fB-T\fR d | u ] [\fB-Hv\fR] [\fB-o\fR \fIproperty\fR[,...]] [\fIpool\fR] ... + [\fIinterval\fR[\fIcount\fR]] .fi .LP @@ -149,7 +150,7 @@ zpool \- configures ZFS storage pools .LP .nf -\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ... +\fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]] .fi .LP @@ -1400,7 +1401,7 @@ Allows a pool to import when there is a missing log device. .ne 2 .mk .na -\fB\fBzpool iostat\fR [\fB-T\fR \fBu\fR | \fBd\fR] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR +\fB\fBzpool iostat\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-v\fR] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR .ad .sp .6 .RS 4n @@ -1457,7 +1458,7 @@ Treat exported or foreign devices as inactive. .ne 2 .mk .na -\fB\fBzpool list\fR [\fB-T\fR \fBu\fR | \fBd\fR] [\fB-Hv\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR +\fB\fBzpool list\fR [\fB-T\fR \fBd\fR | \fBu\fR] [\fB-Hv\fR] [\fB-o\fR \fIprops\fR[,...]] [\fIpool\fR] ... [\fIinterval\fR[\fIcount\fR]]\fR .ad .sp .6 .RS 4n @@ -1476,7 +1477,7 @@ Scripted mode. Do not display headers, and separate fields by a single tab inste .ne 2 .mk .na -\fB\fB-T\fR \fBu\fR | \fBd\fR\fR +\fB\fB-T\fR \fBd\fR | \fBu\fR\fR .ad .RS 12n .rt @@ -1701,7 +1702,7 @@ Sets the specified property for \fInewpool\fR. See the “Properties” section .ne 2 .mk .na -\fB\fBzpool status\fR [\fB-xv\fR] [\fIpool\fR] ...\fR +\fBzpool status\fR [\fB-xvD\fR] [\fB-T\fR d | u] [\fIpool\fR] ... [\fIinterval\fR [\fIcount\fR]] .ad .sp .6 .RS 4n @@ -1714,7 +1715,7 @@ If a scrub or resilver is in progress, this command reports the percentage done .na \fB\fB-x\fR\fR .ad -.RS 6n +.RS 12n .rt Only display status for pools that are exhibiting errors or are otherwise unavailable. Warnings about pools not using the latest on-disk format will not be included. .RE @@ -1725,11 +1726,34 @@ Only display status for pools that are exhibiting errors or are otherwise unavai .na \fB\fB-v\fR\fR .ad -.RS 6n +.RS 12n .rt Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub. .RE +.sp +.ne 2 +.mk +.na +\fB\fB-D\fR\fR +.ad +.RS 12n +.rt +Display a histogram of deduplication statistics, showing the allocated (physically present on disk) and +referenced (logically referenced in the pool) block counts and sizes by reference count. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB-T\fR \fBd\fR | \fBu\fR\fR +.ad +.RS 12n +.rt +Display a time stamp. +.sp +Specify \fBu\fR for a printed representation of the internal representation of time. See \fBtime\fR(2). Specify \fBd\fR for standard date format. See \fBdate\fR(1). .RE .sp -- cgit v1.2.3