[apple/system_cmds.git] / zprint.tproj / zprint.1

.TH ZPRINT 1 02/12/09
.CM 4
.SH NAME
zprint \- show information about kernel zones
.SH SYNOPSIS
\fBzprint\fP [\fB-w\fP] [\fB-s\fP] [\fB-c\fP] [\fB-h\fP] [\fB-t\fP] [\fB-d\fP] [\fB-p <pid>\fP][name]
.SH DESCRIPTION
\fIzprint(1)\fR displays data about Mach zones.  By default,
\fIzprint\fR will print out information about all Mach zones.  If the
optional \fIname\fR is specified, \fIzprint\fR will print information
about each zone for which \fIname\fR is a substring of the zone's
name.
.PP
\fIzprint\fR interprets the following options:
.\" ==========
.TP 8
.B \-c
(Default)
\fIzprint\fR prints zone info in columns. Long zone names are truncated
with '$', and spaces are replaced with '.', to allow for sorting by column.
Pageable and collectible zones are shown with 'P' and 'C'
on the far right. Zones with preposterously large maximum
sizes are shown with '----' in the max size and max num elts fields.
.\" ==========
.TP 8
.B \-h
(Default)
Shows headings for the columns printed with the -c option.
It may be useful to override this option when sorting by column.
.\" ==========
.TP 8
.B \-s
\fIzprint\fR sorts the zones, showing the zone wasting the most memory first.
.\" ==========
.TP 8
.B \-w
For each zone, \fIzprint\fR calculates how much space is allocated but
not currently in use, the space wasted by the zone.
.TP 8
.B \-t
For each zone, \fIzprint\fR calculates the total size of allocations from
the zone over the life of the zone.
.TP 8
.B \-d
Display deltas over time, showing any zones that have achieved a new maximum
current allocation size during the interval.  If the total allocation sizes are
being displayed for the zones in question, it will also display the deltas if the
total allocations have doubled.
.B \-p <pid>
Display zone usage related to the specified process id.  Each zone will display
standard columns and the amount of memory from that zone associated with a given
process.  The letter "A" in the flags column indicates that this total is being
accounted to the process.  Otherwise, the total is an indication of the influence
the process has on the kernel, but the memory is being accounted to the kernel proper.
.PP
Any option (including default options) can be overridden
by specifying the option in upper-case; for example, -C overrides
the (default) option -c.
Commit	Line	Data
8459d725	1	.TH ZPRINT 1 02/12/09
c3a08f59 A	2	.CM 4
	3	.SH NAME
	4	zprint \- show information about kernel zones
	5	.SH SYNOPSIS
8459d725	6	\fBzprint\fP [\fB-w\fP] [\fB-s\fP] [\fB-c\fP] [\fB-h\fP] [\fB-t\fP] [\fB-d\fP] [\fB-p <pid>\fP][name]
c3a08f59 A	7	.SH DESCRIPTION
	8	\fIzprint(1)\fR displays data about Mach zones. By default,
	9	\fIzprint\fR will print out information about all Mach zones. If the
	10	optional \fIname\fR is specified, \fIzprint\fR will print information
	11	about each zone for which \fIname\fR is a substring of the zone's
	12	name.
	13	.PP
	14	\fIzprint\fR interprets the following options:
34d340d7	15	.\" ==========
c3a08f59 A	16	.TP 8
	17	.B \-c
	18	(Default)
	19	\fIzprint\fR prints zone info in columns. Long zone names are truncated
	20	with '$', and spaces are replaced with '.', to allow for sorting by column.
	21	Pageable and collectible zones are shown with 'P' and 'C'
	22	on the far right. Zones with preposterously large maximum
	23	sizes are shown with '----' in the max size and max num elts fields.
34d340d7	24	.\" ==========
c3a08f59 A	25	.TP 8
	26	.B \-h
	27	(Default)
	28	Shows headings for the columns printed with the -c option.
	29	It may be useful to override this option when sorting by column.
34d340d7 A	30	.\" ==========
	31	.TP 8
	32	.B \-s
8459d725	33	\fIzprint\fR sorts the zones, showing the zone wasting the most memory first.
34d340d7 A	34	.\" ==========
	35	.TP 8
	36	.B \-w
	37	For each zone, \fIzprint\fR calculates how much space is allocated but
	38	not currently in use, the space wasted by the zone.
8459d725 A	39	.TP 8
	40	.B \-t
	41	For each zone, \fIzprint\fR calculates the total size of allocations from
	42	the zone over the life of the zone.
	43	.TP 8
	44	.B \-d
	45	Display deltas over time, showing any zones that have achieved a new maximum
	46	current allocation size during the interval. If the total allocation sizes are
	47	being displayed for the zones in question, it will also display the deltas if the
	48	total allocations have doubled.
	49	.B \-p <pid>
	50	Display zone usage related to the specified process id. Each zone will display
	51	standard columns and the amount of memory from that zone associated with a given
	52	process. The letter "A" in the flags column indicates that this total is being
	53	accounted to the process. Otherwise, the total is an indication of the influence
	54	the process has on the kernel, but the memory is being accounted to the kernel proper.
c3a08f59 A	55	.PP
	56	Any option (including default options) can be overridden
	57	by specifying the option in upper-case; for example, -C overrides
	58	the (default) option -c.