c/mirror_zfs
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2025-04-30 14:08:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

Dedup-related documentation additions for zpool and zdb.

Browse Source 
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 <behlendorf1@llnl.gov>
Closes #1786
This commit is contained in:
Tim Chase 2013-10-13 11:36:15 -05:00 committed by Brian Behlendorf
parent fbcb768c8f
commit 2e2ddc30b4
3 changed files with 40 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/zpool/zpool_main.c
View File

@ -256,7 +256,7 @@ get_usage(zpool_help_t idx) {
case HELP_SCRUB: case HELP_SCRUB:
return (gettext("\tscrub [-s] <pool> ...\n")); return (gettext("\tscrub [-s] <pool> ...\n"));
case HELP_STATUS: case HELP_STATUS:
return (gettext("\tstatus [-vx] [-T d|u] [pool] ... [interval " return (gettext("\tstatus [-vxD] [-T d|u] [pool] ... [interval "
"[count]]\n")); "[count]]\n"));
case HELP_UPGRADE: case HELP_UPGRADE:
return (gettext("\tupgrade\n" return (gettext("\tupgrade\n"

6
man/man8/zdb.8
View File

@ -133,6 +133,12 @@ compression ratio (compress), inflation due to the zfs copies property
If specified twice, display a histogram of deduplication statistics, showing If specified twice, display a histogram of deduplication statistics, showing
the allocated (physically present on disk) and referenced (logically the allocated (physically present on disk) and referenced (logically
referenced in the pool) block counts and sizes by reference count. 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 .RE
.sp .sp

42
man/man8/zpool.8
View File

@ -89,7 +89,7 @@ zpool \- configures ZFS storage pools
.LP .LP
.nf .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 .fi
.LP .LP
@ -99,7 +99,8 @@ zpool \- configures ZFS storage pools
.LP .LP
.nf .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 .fi
.LP .LP
@ -149,7 +150,7 @@ zpool \- configures ZFS storage pools
.LP .LP
.nf .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 .fi
.LP .LP
@ -1400,7 +1401,7 @@ Allows a pool to import when there is a missing log device.
.ne 2 .ne 2
.mk .mk
.na .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 .ad
.sp .6 .sp .6
.RS 4n .RS 4n
@ -1457,7 +1458,7 @@ Treat exported or foreign devices as inactive.
.ne 2 .ne 2
.mk .mk
.na .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 .ad
.sp .6 .sp .6
.RS 4n .RS 4n
@ -1476,7 +1477,7 @@ Scripted mode. Do not display headers, and separate fields by a single tab inste
.ne 2 .ne 2
.mk .mk
.na .na
\fB\fB-T\fR \fBu\fR | \fBd\fR\fR \fB\fB-T\fR \fBd\fR | \fBu\fR\fR
.ad .ad
.RS 12n .RS 12n
.rt .rt
@ -1701,7 +1702,7 @@ Sets the specified property for \fInewpool\fR. See the “Properties” section
.ne 2 .ne 2
.mk .mk
.na .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 .ad
.sp .6 .sp .6
.RS 4n .RS 4n
@ -1714,7 +1715,7 @@ If a scrub or resilver is in progress, this command reports the percentage done
.na .na
\fB\fB-x\fR\fR \fB\fB-x\fR\fR
.ad .ad
.RS 6n .RS 12n
.rt .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. 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 .RE
@ -1725,11 +1726,34 @@ Only display status for pools that are exhibiting errors or are otherwise unavai
.na .na
\fB\fB-v\fR\fR \fB\fB-v\fR\fR
.ad .ad
.RS 6n .RS 12n
.rt .rt
Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub. Displays verbose data error information, printing out a complete list of all data errors since the last complete pool scrub.
.RE .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 .RE
.sp .sp