enhanced libproc cgroup/cmdline support, exploited by top
[procps:crrodriguezs-procps.git] / slabtop.1
1 .\" slabtop.1 - manpage for the slabtop(1) utility, part of procps
2 .\"
3 .\" Copyright (C) 2003 Chris Rivera
4 .\" Licensed under the terms of the GNU Library General Public License, v2
5 .TH SLABTOP 1 "13 Sep 2003" "Linux" "Linux User's Manual"
6 .SH NAME
7 slabtop \- display kernel slab cache information in real time
8
9 .SH SYNOPSIS
10 .B slabtop
11 .RI [ options ]
12
13 .SH DESCRIPTION
14 .B slabtop
15 displays detailed kernel slab cache information in real time.  It displays a
16 listing of the top caches sorted by one of the listed sort criteria.  It also
17 displays a statistics header filled with slab layer information.
18
19 .SH OPTIONS
20 Normal invocation of 
21 .B slabtop
22 does not require any options.  The behavior, however, can be fine-tuned by
23 specifying one or more of the following flags:
24 .TP
25 .B \-\-delay=\fIn\fR, \fB\-d \fIn
26 Refresh the display every
27 .I n
28 in seconds.  By default,
29 .B slabtop
30 refreshes the display every three seconds.  To exit the program, hit
31 .BR q.
32 .TP
33 .B \-\-sort=\fIS\fR, \fB\-s\fR \fIS
34 Sort by \fIS\fR, where \fIS\fR is one of the sort criteria.
35 .TP
36 .B \-\-once\fR, \fB\-o
37 Display the output once and then exit.
38 .TP
39 .B \-\-version\fR, \fB\-V
40 Display version information and exit.
41 .TP
42 .B \-\-help
43 Display usage information and exit.
44
45 .SH SORT CRITERIA
46 The following are valid sort criteria used to sort the individual slab caches
47 and thereby determine what are the "top" slab caches to display.  The default
48 sort criteria is to sort by the number of objects ("o").
49
50 The sort criteria can also be changed while slabtop is running by pressing
51 the associated character.
52 .TP
53 .BR a: 
54 sort by number of active objects
55 .TP
56 .BR b: 
57 sort by objects per slab
58 .TP
59 .BR c: 
60 sort by cache size
61 .TP
62 .BR l: 
63 sort by number of slabs
64 .TP
65 .BR v
66 sort by number of active slabs
67 .TP
68 .BR n: 
69 sort by name
70 .TP
71 .BR o: 
72 sort by number of objects
73 .TP
74 .BR p: 
75 sort by pages per slab
76 .TP
77 .BR s: 
78 sort by object size
79 .TP
80 .BR u: 
81 sort by cache utilization
82
83 .SH COMMANDS
84 .B slabtop
85 accepts keyboard commands from the user during use.  The following are
86 supported.  In the case of letters, both cases are accepted.
87
88 Each of the valid sort characters are also accepted, to change the sort
89 routine. See the section
90 .IR "SORT CRITERIA" .
91
92 .TP
93 .BR <SPACEBAR>
94 Refresh the screen.
95 .TP
96 .BR Q
97 Quit the program.
98
99 .SH FILES
100 .TP
101 .I /proc/slabinfo
102 slab information
103
104 .SH "SEE ALSO"
105 .BR free (1),
106 .BR ps (1),
107 .BR top (1),
108 .BR vmstat (8)
109
110 .SH NOTES
111 Currently,
112 .B slabtop
113 requires a 2.4 or later kernel (specifically, a version 1.1 or later
114 .IR /proc/slabinfo ).
115 Kernel 2.2 should be supported in the future.
116
117 The slabtop statistic header is tracking how many bytes of slabs are being used
118 and it not a measure of physical memory. The 'Slab' field in the /proc/meminfo
119 file is tracking information about used slab physical memory.
120
121 .SH AUTHORS
122 Written by Chris Rivera and Robert Love.
123
124 .B slabtop
125 was inspired by Martin Bligh's perl script,
126 .BR vmtop .
127 The procps package is maintained by Albert Cahalan <albert@users.sf.net>.
128
129 Please send bug reports to <procps-feedback@lists.sf.net>.