emo/procps
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

docs: small nroff fixes to man slabtop.1

Browse Source 
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
This commit is contained in:
Sami Kerola 2011-06-06 22:40:58 +02:00
parent 74471cd69c
commit 97b08249c6
1 changed files with 19 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
slabtop.1
View File

@ -2,27 +2,24 @@
.\" .\"
.\" Copyright (C) 2003 Chris Rivera .\" Copyright (C) 2003 Chris Rivera
.\" Licensed under the terms of the GNU Library General Public License, v2 .\" Licensed under the terms of the GNU Library General Public License, v2
.TH SLABTOP 1 "13 Sep 2003" "Linux" "Linux User's Manual" .TH SLABTOP "1" "June 2011" "procps-ng" "User Commands"
.SH NAME .SH NAME
slabtop \- display kernel slab cache information in real time slabtop \- display kernel slab cache information in real time
.SH SYNOPSIS .SH SYNOPSIS
.B slabtop .B slabtop
.RI [ options ] [\fIoptions\fR]
.SH DESCRIPTION .SH DESCRIPTION
.B slabtop .B slabtop
displays detailed kernel slab cache information in real time. It displays a displays detailed kernel slab cache information in real time. It displays a
listing of the top caches sorted by one of the listed sort criteria. It also listing of the top caches sorted by one of the listed sort criteria. It also
displays a statistics header filled with slab layer information. displays a statistics header filled with slab layer information.
.SH OPTIONS .SH OPTIONS
Normal invocation of Normal invocation of
.B slabtop .B slabtop
does not require any options. The behavior, however, can be fine-tuned by does not require any options. The behavior, however, can be fine-tuned by
specifying one or more of the following flags: specifying one or more of the following flags:
.TP .TP
.B \-\-delay=\fIn\fR, \fB\-d \fIn \fB\-d\fR, \fB\-\-delay\fR=\fIN\fR
Refresh the display every Refresh the display every
.I n .I n
in seconds. By default, in seconds. By default,
@ -30,23 +27,22 @@ in seconds. By default,
refreshes the display every three seconds. To exit the program, hit refreshes the display every three seconds. To exit the program, hit
.BR q. .BR q.
.TP .TP
.B \-\-sort=\fIS\fR, \fB\-s\fR \fIS \fB\-s\fR, \fB\-\-sort\fR=\fIS\fR
Sort by \fIS\fR, where \fIS\fR is one of the sort criteria. Sort by \fIS\fR, where \fIS\fR is one of the sort criteria.
.TP .TP
.B \-\-once\fR, \fB\-o \fB\-o\fR, \fB\-\-once\fR
Display the output once and then exit. Display the output once and then exit.
.TP .TP
.B \-\-version\fR, \fB\-V \fB\-V\fR, \fB\-\-version\fR
Display version information and exit. Display version information and exit.
.TP .TP
.B \-\-help \fB\-h\fR, \fB\-\-help\fR
Display usage information and exit. Display usage information and exit.
.SH SORT CRITERIA .SH SORT CRITERIA
The following are valid sort criteria used to sort the individual slab caches The following are valid sort criteria used to sort the individual slab caches
and thereby determine what are the "top" slab caches to display. The default and thereby determine what are the "top" slab caches to display. The default
sort criteria is to sort by the number of objects ("o"). sort criteria is to sort by the number of objects ("o").
.PP
The sort criteria can also be changed while slabtop is running by pressing The sort criteria can also be changed while slabtop is running by pressing
the associated character. the associated character.
.TP .TP
@ -79,49 +75,46 @@ sort by object size
.TP .TP
.BR u: .BR u:
sort by cache utilization sort by cache utilization
.SH COMMANDS .SH COMMANDS
.B slabtop .B slabtop
accepts keyboard commands from the user during use. The following are accepts keyboard commands from the user during use. The following are
supported. In the case of letters, both cases are accepted. supported. In the case of letters, both cases are accepted.
.PP
Each of the valid sort characters are also accepted, to change the sort Each of the valid sort characters are also accepted, to change the sort
routine. See the section routine. See the section
.IR "SORT CRITERIA" . .BR "SORT CRITERIA" .
.TP .TP
.BR <SPACEBAR> .BR <SPACEBAR>
Refresh the screen. Refresh the screen.
.TP .TP
.BR Q .BR Q
Quit the program. Quit the program.
.SH FILES .SH FILES
.TP .TP
.I /proc/slabinfo .I /proc/slabinfo
slab information slab information
.SH "SEE ALSO" .SH "SEE ALSO"
.BR free (1), .BR free (1),
.BR ps (1), .BR ps (1),
.BR top (1), .BR top (1),
.BR vmstat (8) .BR vmstat (8)
.SH NOTES .SH NOTES
Currently, Currently,
.B slabtop .B slabtop
requires a 2.4 or later kernel (specifically, a version 1.1 or later requires a 2.4 or later kernel (specifically, a version 1.1 or later
.IR /proc/slabinfo ). .IR /proc/slabinfo ).
Kernel 2.2 should be supported in the future. Kernel 2.2 should be supported in the future.
.PP
The slabtop statistic header is tracking how many bytes of slabs are being used The slabtop statistic header is tracking how many bytes of slabs are being
and it not a measure of physical memory. The 'Slab' field in the /proc/meminfo used and it not a measure of physical memory. The 'Slab' field in the
file is tracking information about used slab physical memory. /proc/meminfo file is tracking information about used slab physical memory.
.SH AUTHORS .SH AUTHORS
Written by Chris Rivera and Robert Love. Written by Chris Rivera and Robert Love.
.PP
.B slabtop .B slabtop
was inspired by Martin Bligh's perl script, was inspired by Martin Bligh's perl script,
.BR vmtop . .BR vmtop .
Please send bug reports to <procps@freelists.org>. .SH "REPORTING BUGS"
Please send bug reports to
.UR procps\@freelists.org
.UE