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

.\" Copyright (c) 2012, Apple Inc.  All rights reserved.
.\"
.Dd June 28, 2012
.Dt LTOP 1
.Os "Mac OS X"
.Sh NAME
.Nm ltop
.Nd Display ledger information for processes on the system
.Sh SYNOPSIS
.Nm ltop
.Bk -words
.Fl h
.Pp
.Nm ltop
.Op Fl dL
.Op Fl g Ar group
.Op Fl p Ar pid
.Op Fl r Ar resource
.Op Ar interval
.Ek
.Sh DESCRIPTION
.Nm ltop
displays the contents of system ledgers maintained by the kernel for each process in the system. Ledgers are a general accounting mechanism that the kernel uses to track and limit things like CPU time and memory usage.
.Pp
If the optional
.Ar interval
is specified, then
.Nm
will display the ledger contents every interval seconds.
.Pp
The options are as follows:
.Bl -tag -width indent
.\" ==========
.It Fl d
In conjunction with
.Ar interval ,
display the rate of change for each value, as compared to the previous sample displayed.
.\" ==========
.It Fl L
Display template info. Shows which resources are tracked, and lists the associated units.
.\" ==========
.It Fl g Ar group
Only display info for the ledgers associated with
.Ar group .
Group topology can be seen via the
.Fl L
option.
.\" ==========
.It Fl p Ar pid
Only display info for process
.Ar pid .
.\" ==========
.It Fl r Ar resource
Only display info for resource
.Ar resource .
.\" ==========
.El
.Sh SEE ALSO
.Xr top 1
Commit	Line	Data
fc6d9e4b A	1	.\" Copyright (c) 2012, Apple Inc. All rights reserved.
	2	.\"
	3	.Dd June 28, 2012
	4	.Dt LTOP 1
	5	.Os "Mac OS X"
	6	.Sh NAME
	7	.Nm ltop
	8	.Nd Display ledger information for processes on the system
	9	.Sh SYNOPSIS
	10	.Nm ltop
1a7e3f61	11	.Bk -words
fc6d9e4b A	12	.Fl h
	13	.Pp
	14	.Nm ltop
1a7e3f61 A	15	.Op Fl dL
	16	.Op Fl g Ar group
	17	.Op Fl p Ar pid
	18	.Op Fl r Ar resource
	19	.Op Ar interval
	20	.Ek
fc6d9e4b	21	.Sh DESCRIPTION
fc6d9e4b	22	.Nm ltop
1a7e3f61 A	23	displays the contents of system ledgers maintained by the kernel for each process in the system. Ledgers are a general accounting mechanism that the kernel uses to track and limit things like CPU time and memory usage.
	24	.Pp
	25	If the optional
	26	.Ar interval
	27	is specified, then
	28	.Nm
	29	will display the ledger contents every interval seconds.
	30	.Pp
	31	The options are as follows:
	32	.Bl -tag -width indent
	33	.\" ==========
	34	.It Fl d
	35	In conjunction with
	36	.Ar interval ,
	37	display the rate of change for each value, as compared to the previous sample displayed.
	38	.\" ==========
	39	.It Fl L
	40	Display template info. Shows which resources are tracked, and lists the associated units.
	41	.\" ==========
	42	.It Fl g Ar group
	43	Only display info for the ledgers associated with
	44	.Ar group .
	45	Group topology can be seen via the
	46	.Fl L
	47	option.
	48	.\" ==========
	49	.It Fl p Ar pid
	50	Only display info for process
	51	.Ar pid .
	52	.\" ==========
	53	.It Fl r Ar resource
	54	Only display info for resource
	55	.Ar resource .
	56	.\" ==========
	57	.El
fc6d9e4b A	58	.Sh SEE ALSO
fc6d9e4b A	59	.Xr top 1