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