1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
|
.\" $OpenBSD: top.1,v 1.44 2007/02/14 08:29:28 jmc Exp $
.\"
.\" Copyright (c) 1997, Jason Downs. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd August 14, 1997
.Dt TOP 1
.Os
.Sh NAME
.Nm top
.Nd display and update information about the top CPU processes
.Sh SYNOPSIS
.Nm top
.Op Fl bCIinqSTu
.Op Fl d Ar count
.Op Fl g Ar command
.Op Fl o Ar field
.Op Fl p Ar pid
.Op Fl s Ar time
.Op Fl U Ar username
.Op Ar number
.Sh DESCRIPTION
.Nm
displays the top processes on the system and periodically updates this
information.
If standard output is an intelligent terminal (see below) then
as many processes as will fit on the terminal screen are displayed
by default.
Otherwise, a good number of them are shown (around 20).
Raw CPU percentage is used to rank the processes.
If
.Ar number
is given, then the top
.Ar number
processes will be displayed instead of the default.
.Pp
.Nm
makes a distinction between terminals that support advanced capabilities
and those that do not.
This distinction affects the choice of defaults for certain options.
In the remainder of this document, an
.Em intelligent
terminal is one that supports cursor addressing, clear screen, and clear
to end of line.
Conversely, a
.Em dumb
terminal is one that does not support such features.
If the output of
.Nm
is redirected to a file, it acts as if it were being run on a dumb
terminal.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl b
Use
.Em batch
mode.
In this mode, all input from the terminal is ignored.
Interrupt characters (such as
.Ql ^C
and
.Ql ^\e )
still have an effect.
This is the default on a dumb terminal, or when the output is not a terminal.
.It Fl C
Show command line arguments
as well as the process itself.
.It Fl d Ar count
Show only
.Ar count
displays, then exit.
A display is considered to be one update of the screen.
This option allows the user to select the number of displays
to be shown before
.Nm
automatically exits.
For intelligent terminals, no upper limit is set.
The default is 1 for dumb terminals.
.It Fl g Ar command
Show only processes that contain the string
.Ar command
in their command name.
.It Fl I
Do not display idle processes.
By default,
.Nm
displays both active and idle processes.
.It Fl i
Use
.Em interactive
mode.
In this mode, any input is immediately read for processing.
See the section on
.Sx INTERACTIVE MODE
for an explanation of which keys perform what functions.
After the command
is processed, the screen will immediately be updated, even if the command was
not understood.
This mode is the default when standard output is an intelligent terminal.
.It Fl n
Use
.Em non-interactive
mode.
This is identical to
.Em batch
mode.
.It Fl o Ar field
Sort the process display area using the specified field as the primary key.
The field name is the name of the column as seen in the output,
but in lower case.
The
.Ox
version of
.Nm
supports
.Ar cpu ,
.Ar size ,
.Ar res ,
.Ar time ,
and
.Ar pri .
.It Fl p Ar pid
Show only the process
.Ar pid .
.It Fl q
Renice
.Nm
to \-20 so that it will run faster.
This can be used when the system is
being very sluggish to improve the possibility of discovering the problem.
This option can only be used by root.
.It Fl S
Show system processes in the display.
Normally, system processes such as the pager and the swapper are not shown.
This option makes them visible.
.It Fl s Ar time
Set the delay between screen updates to
.Ar time
seconds.
The value may be fractional, to permit delays of less than 1 second.
The default delay between updates is 5 seconds.
.It Fl T
Show process threads in the display.
Normally, only the main process is shown.
This option makes all threads visible.
.It Fl U Ar username
Show only those processes owned by
.Ar username .
This option currently only accepts usernames and will not understand
UID numbers.
.It Fl u
Do not take the time to map UID numbers to usernames.
Normally,
.Nm
will read as much of the password database as is necessary to map
all the user ID numbers it encounters into login names.
This option
disables all that, while possibly decreasing execution time.
The UID numbers are displayed instead of the names.
.El
.Pp
Both
.Ar count
and
.Ar number
fields can be specified as
.Li infinite ,
indicating that they can stretch as far as possible.
This is accomplished by using any proper prefix of the keywords
.Li infinity ,
.Li maximum ,
or
.Li all .
The default for
.Ar count
on an intelligent terminal is, in fact,
.Li infinity .
.Pp
The environment variable
.Ev TOP
is examined for options before the command line is scanned.
This enables a user to set his or her own defaults.
The number of processes to display
can also be specified in the environment variable
.Ev TOP .
.Pp
The options
.Fl I ,
.Fl S ,
and
.Fl u
are actually toggles.
A second specification of any of these options
will negate the first.
Thus a user who has the environment variable
.Ev TOP
set to
.Dq -I
may use the command
.Dq top -I
to see idle processes.
.Sh INTERACTIVE MODE
When
.Nm
is running in
.Em interactive mode ,
it reads commands from the terminal and acts upon them accordingly.
In this mode, the terminal is put in
.Dv CBREAK ,
so that a character will be processed as soon as it is typed.
Almost always, a key will be pressed when
.Nm
is between displays; that is, while it is waiting for
.Ar time
seconds to elapse.
If this is the case, the command will be
processed and the display will be updated immediately thereafter
(reflecting any changes that the command may have specified).
This happens even if the command was incorrect.
If a key is pressed while
.Nm
is in the middle of updating the display, it will finish the update and
then process the command.
Some commands require additional information,
and the user will be prompted accordingly.
While typing this information
in, the user's erase and kill keys (as set up by the command
.Xr stty 1 )
are recognized, and a newline terminates the input.
.Pp
These commands are currently recognized (^L refers to control-L):
.Bl -tag -width XxXXXX
.It h \*(Ba \&?
Display a summary of the commands (help screen).
.It ^L
Redraw the screen.
.It q
Quit
.Nm .
.El
.Pp
The following commands may not be available with overstrike terminals:
.Bl -tag -width XxXXXX
.It +
Reset any filters put in place by the
.Sq g ,
.Sq p ,
and
.Sq u
interactive commands,
or their command line equivalents.
.It C
Toggle the display of process command line arguments.
.It d Ar count
Show only
.Ar count
displays,
then exit.
.It e
Display a list of system errors (if any) generated by the last
.Li kill
or
.Li renice
command.
.It g Ar string
Display only processes that contain
.Ar string
in their command name.
.Sq g+
shows all processes.
.It I \*(Ba i
Toggle the display of idle processes.
.It Xo k
.Op - Ns Ar sig
.Ar pid
.Xc
Send signal
.No - Ns Ar sig
.Pf ( Dv TERM
by default) to process
.Ar pid .
This acts similarly to the command
.Xr kill 1 .
.It n\*(Ba# Ar count
Show
.Ar count
processes.
.It o Ar field
Change the sorting order of the processes, selected by
.Ar field .
Values are the same as for the
.Fl o
flag, as detailed above.
.It p Ar pid
Display a specific process, selected by
.Ar pid .
.Sq p+
shows all processes.
.It r Ar count pid
Change the priority (the
.Em nice )
of a list of processes to
.Ar count
for process
.Ar pid .
This acts similarly to the command
.Xr renice 8 .
.It S
Toggle the display of system processes.
.It s Ar time
Set the delay between screen updates to
.Ar time
seconds.
.It T
Toggle the display of process threads.
.It u Ar user
Display only processes owned by a specific
.Ar user .
.Sq u+
shows processes belonging to all users.
.El
.Sh THE DISPLAY
.\" The actual display varies depending on the specific variant of Unix
.\" that the machine is running. This description may not exactly match
.\" what is seen by top running on this particular machine. Differences
.\" are listed at the end of this manual entry.
.\" .Pp
The top few lines of the display show general information
about the state of the system, including
.\" the last process ID assigned to a process,
.\" (on most systems),
the three load average numbers,
the current time,
the number of existing processes,
the number of processes in each state
(starting, running, idle, stopped, zombie, dead, and on processor),
and a percentage of time spent in each of the processor states
(user, nice, system, interrupt, and idle).
It also includes information about physical and virtual memory allocation.
The load average numbers give the number of jobs in the run queue averaged
over 1, 5, and 15 minutes.
.Pp
The remainder of the screen displays information about individual
processes.
This display is similar in spirit to
.Xr ps 1
but it is not exactly the same.
The following fields are displayed:
.Bl -tag -width USERNAME -offset indent
.It PID
The process ID.
.It USERNAME
The name of the process's owner.
.It UID
Used instead of USERNAME if
.Fl u
is specified.
.It PRI
The current priority of the process.
.It NICE
The nice amount (in the range \-20 to 20).
.It SIZE
The total size of the process (the text, data, and stack segments).
.It RES
The current amount of resident memory.
.It STATE
The current state (one of
.Li start ,
.Li run ,
.Li sleep ,
.Li stop ,
.Li idle ,
.Li zomb ,
.Li dead ,
or
.Li onproc ) .
On multi-processor systems, this is followed by a slash and the CPU
number on which the process is bound.
.It WAIT
A description of the wait channel the process is sleeping on if it's
asleep.
.It TIME
The number of system and user CPU seconds that the process has used.
.It CPU
The raw percentage of CPU usage and the default field on which the
display is sorted.
.It COMMAND
The name of the command that the process is currently running.
(If the process is swapped out, this column is enclosed by angle
brackets.)
.El
.Sh ENVIRONMENT
.Bl -tag -width Ev
.It Ev TOP
User-configurable defaults for options.
.El
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /dev/kmem
kernel memory
.It Pa /dev/mem
physical memory
.It Pa /etc/passwd
used to map user ID to name
.It Pa /bsd
kernel image
.El
.Sh SEE ALSO
.Xr fstat 1 ,
.Xr kill 1 ,
.Xr netstat 1 ,
.Xr ps 1 ,
.Xr stty 1 ,
.Xr systat 1 ,
.Xr mem 4 ,
.Xr iostat 8 ,
.Xr pstat 8 ,
.Xr renice 8 ,
.Xr vmstat 8
.Sh AUTHORS
William LeFebvre, EECS Department, Northwestern University
.Sh BUGS
As with
.Xr ps 1 ,
things can change while
.Nm
is collecting information for an update.
The picture it gives is only a
close approximation to reality.
|