Annotation of src/usr.bin/top/top.1, Revision 1.72
1.72 ! zhuk 1: .\" $OpenBSD: top.1,v 1.71 2018/11/28 22:00:30 kn 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: .\"
1.72 ! zhuk 26: .Dd $Mdocdate: November 28 2018 $
1.2 downsj 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.45 jmc 34: .Bk -words
1.59 jsing 35: .Op Fl 1bCHIinqSu
1.2 downsj 36: .Op Fl d Ar count
1.45 jmc 37: .Op Fl g Ar string
1.71 kn 38: .Op Fl o Oo - Oc Ns Ar field
1.25 otto 39: .Op Fl p Ar pid
1.2 downsj 40: .Op Fl s Ar time
1.61 jmc 41: .Op Fl U Oo - Oc Ns Ar user
1.2 downsj 42: .Op Ar number
1.45 jmc 43: .Ek
1.2 downsj 44: .Sh DESCRIPTION
45: .Nm
46: displays the top processes on the system and periodically updates this
1.13 aaron 47: information.
48: If standard output is an intelligent terminal (see below) then
1.1 downsj 49: as many processes as will fit on the terminal screen are displayed
1.13 aaron 50: by default.
51: Otherwise, a good number of them are shown (around 20).
52: Raw CPU percentage is used to rank the processes.
53: If
1.2 downsj 54: .Ar number
1.1 downsj 55: is given, then the top
1.2 downsj 56: .Ar number
1.1 downsj 57: processes will be displayed instead of the default.
1.2 downsj 58: .Pp
59: .Nm
1.1 downsj 60: makes a distinction between terminals that support advanced capabilities
1.13 aaron 61: and those that do not.
62: This distinction affects the choice of defaults for certain options.
63: In the remainder of this document, an
1.2 downsj 64: .Em intelligent
65: terminal is one that supports cursor addressing, clear screen, and clear
1.13 aaron 66: to end of line.
67: Conversely, a
1.43 jmc 68: .Em dumb
1.13 aaron 69: terminal is one that does not support such features.
70: If the output of
1.2 downsj 71: .Nm
1.1 downsj 72: is redirected to a file, it acts as if it were being run on a dumb
73: terminal.
1.12 aaron 74: .Pp
75: The options are as follows:
1.15 aaron 76: .Bl -tag -width Ds
1.51 tedu 77: .It Fl 1
1.58 jmc 78: Display combined CPU statistics for all processors on a single line
79: instead of one line per CPU.
1.64 dlg 80: If there are more than 8 CPUs detected in the system this option
81: is automatically enabled.
1.2 downsj 82: .It Fl b
83: Use
84: .Em batch
1.13 aaron 85: mode.
86: In this mode, all input from the terminal is ignored.
87: Interrupt characters (such as
88: .Ql ^C
89: and
90: .Ql ^\e )
91: still have an effect.
1.1 downsj 92: This is the default on a dumb terminal, or when the output is not a terminal.
1.34 otto 93: .It Fl C
1.42 jmc 94: Show command line arguments
95: as well as the process itself.
1.23 jmc 96: .It Fl d Ar count
97: Show only
98: .Ar count
99: displays, then exit.
100: A display is considered to be one update of the screen.
101: This option allows the user to select the number of displays
102: to be shown before
103: .Nm
104: automatically exits.
105: For intelligent terminals, no upper limit is set.
106: The default is 1 for dumb terminals.
1.45 jmc 107: .It Fl g Ar string
108: Display only processes that contain
109: .Ar string
1.35 otto 110: in their command name.
1.67 edd 111: If displaying of arguments is enabled, the arguments are searched too.
1.59 jsing 112: .It Fl H
113: Show process threads in the display.
114: Normally, only the main process is shown.
115: This option makes all threads visible.
1.27 jmc 116: .It Fl I
117: Do not display idle processes.
118: By default,
119: .Nm
120: displays both active and idle processes.
1.2 downsj 121: .It Fl i
122: Use
123: .Em interactive
1.13 aaron 124: mode.
125: In this mode, any input is immediately read for processing.
126: See the section on
1.2 downsj 127: .Sx INTERACTIVE MODE
1.13 aaron 128: for an explanation of which keys perform what functions.
129: After the command
1.2 downsj 130: is processed, the screen will immediately be updated, even if the command was
1.13 aaron 131: not understood.
132: This mode is the default when standard output is an intelligent terminal.
1.2 downsj 133: .It Fl n
1.10 aaron 134: Use
1.2 downsj 135: .Em non-interactive
1.13 aaron 136: mode.
137: This is identical to
1.2 downsj 138: .Em batch
1.1 downsj 139: mode.
1.71 kn 140: .It Fl o Oo - Oc Ns Ar field
1.45 jmc 141: Sort the process display area using the specified
142: .Ar field
143: as the primary key.
1.23 jmc 144: The field name is the name of the column as seen in the output,
145: but in lower case.
146: The
1.71 kn 147: .Sq -
148: prefix reverses the order.
149: The
1.23 jmc 150: .Ox
1.26 jaredy 151: version of
152: .Nm
153: supports
1.23 jmc 154: .Ar cpu ,
155: .Ar size ,
156: .Ar res ,
157: .Ar time ,
1.54 tedu 158: .Ar pri ,
159: .Ar pid ,
1.23 jmc 160: and
1.54 tedu 161: .Ar command .
1.25 otto 162: .It Fl p Ar pid
163: Show only the process
164: .Ar pid .
1.2 downsj 165: .It Fl q
1.1 downsj 166: Renice
1.2 downsj 167: .Nm
1.26 jaredy 168: to \-20 so that it will run faster.
1.13 aaron 169: This can be used when the system is
1.1 downsj 170: being very sluggish to improve the possibility of discovering the problem.
171: This option can only be used by root.
1.27 jmc 172: .It Fl S
173: Show system processes in the display.
174: Normally, system processes such as the pager and the swapper are not shown.
175: This option makes them visible.
1.23 jmc 176: .It Fl s Ar time
177: Set the delay between screen updates to
178: .Ar time
179: seconds.
180: The value may be fractional, to permit delays of less than 1 second.
181: The default delay between updates is 5 seconds.
1.61 jmc 182: .It Fl U Oo - Oc Ns Ar user
1.70 kn 183: Show only those processes owned by username or UID
1.45 jmc 184: .Ar user .
1.61 jmc 185: The prefix
186: .Sq -
187: hides processes owned by that user.
1.2 downsj 188: .It Fl u
1.13 aaron 189: Do not take the time to map UID numbers to usernames.
190: Normally,
1.2 downsj 191: .Nm
192: will read as much of the password database as is necessary to map
1.13 aaron 193: all the user ID numbers it encounters into login names.
194: This option
195: disables all that, while possibly decreasing execution time.
196: The UID numbers are displayed instead of the names.
1.2 downsj 197: .El
198: .Pp
1.1 downsj 199: Both
1.2 downsj 200: .Ar count
1.1 downsj 201: and
1.2 downsj 202: .Ar number
203: fields can be specified as
204: .Li infinite ,
1.13 aaron 205: indicating that they can stretch as far as possible.
206: This is accomplished by using any proper prefix of the keywords
1.2 downsj 207: .Li infinity ,
208: .Li maximum ,
1.1 downsj 209: or
1.2 downsj 210: .Li all .
1.1 downsj 211: The default for
1.2 downsj 212: .Ar count
1.1 downsj 213: on an intelligent terminal is, in fact,
1.2 downsj 214: .Li infinity .
215: .Pp
1.1 downsj 216: The environment variable
1.2 downsj 217: .Ev TOP
1.13 aaron 218: is examined for options before the command line is scanned.
219: This enables a user to set his or her own defaults.
220: The number of processes to display
1.1 downsj 221: can also be specified in the environment variable
1.2 downsj 222: .Ev TOP .
223: .Pp
1.1 downsj 224: The options
1.2 downsj 225: .Fl I ,
226: .Fl S ,
1.1 downsj 227: and
1.2 downsj 228: .Fl u
1.13 aaron 229: are actually toggles.
230: A second specification of any of these options
231: will negate the first.
232: Thus a user who has the environment variable
1.2 downsj 233: .Ev TOP
1.10 aaron 234: set to
1.5 aaron 235: .Dq -I
1.10 aaron 236: may use the command
1.5 aaron 237: .Dq top -I
1.2 downsj 238: to see idle processes.
239: .Sh INTERACTIVE MODE
1.1 downsj 240: When
1.2 downsj 241: .Nm
242: is running in
243: .Em interactive mode ,
1.13 aaron 244: it reads commands from the terminal and acts upon them accordingly.
245: In this mode, the terminal is put in
1.2 downsj 246: .Dv CBREAK ,
1.13 aaron 247: so that a character will be processed as soon as it is typed.
248: Almost always, a key will be pressed when
1.2 downsj 249: .Nm
1.1 downsj 250: is between displays; that is, while it is waiting for
1.2 downsj 251: .Ar time
1.13 aaron 252: seconds to elapse.
253: If this is the case, the command will be
1.1 downsj 254: processed and the display will be updated immediately thereafter
1.13 aaron 255: (reflecting any changes that the command may have specified).
256: This happens even if the command was incorrect.
257: If a key is pressed while
1.2 downsj 258: .Nm
1.1 downsj 259: is in the middle of updating the display, it will finish the update and
1.13 aaron 260: then process the command.
261: Some commands require additional information,
262: and the user will be prompted accordingly.
263: While typing this information
1.1 downsj 264: in, the user's erase and kill keys (as set up by the command
1.2 downsj 265: .Xr stty 1 )
1.1 downsj 266: are recognized, and a newline terminates the input.
1.2 downsj 267: .Pp
1.1 downsj 268: These commands are currently recognized (^L refers to control-L):
1.2 downsj 269: .Bl -tag -width XxXXXX
1.65 bentley 270: .It h | \&?
1.27 jmc 271: Display a summary of the commands (help screen).
1.2 downsj 272: .It ^L
1.1 downsj 273: Redraw the screen.
1.55 lum 274: .It <space>
275: Update the screen.
1.2 downsj 276: .It q
1.1 downsj 277: Quit
1.40 jmc 278: .Nm .
1.23 jmc 279: .El
280: .Bl -tag -width XxXXXX
1.38 otto 281: .It +
1.39 jmc 282: Reset any filters put in place by the
283: .Sq g ,
284: .Sq p ,
285: and
286: .Sq u
287: interactive commands,
1.48 jmc 288: or their command line equivalents,
289: or any process highlighting put in place by the
290: .Sq P
291: interactive command.
1.53 jmc 292: .It 1
1.63 dlg 293: Toggle the display of per CPU or combined CPU statistics.
1.72 ! zhuk 294: .It 9 | 0
! 295: Scroll up/down the process list by one line.
! 296: .It \&( | \&)
! 297: Scroll up/down the process list by screen half.
1.29 markus 298: .It C
299: Toggle the display of process command line arguments.
1.44 jmc 300: .It d Ar count
301: Show only
302: .Ar count
303: displays,
304: then exit.
1.23 jmc 305: .It e
306: Display a list of system errors (if any) generated by the last
307: .Li kill
308: or
309: .Li renice
310: command.
1.40 jmc 311: .It g Ar string
312: Display only processes that contain
313: .Ar string
314: in their command name.
1.67 edd 315: If displaying of arguments is enabled, the arguments are searched too.
1.40 jmc 316: .Sq g+
317: shows all processes.
1.59 jsing 318: .It H
319: Toggle the display of process threads.
1.65 bentley 320: .It I | i
1.23 jmc 321: Toggle the display of idle processes.
1.41 jmc 322: .It Xo k
323: .Op - Ns Ar sig
324: .Ar pid
325: .Xc
326: Send signal
327: .No - Ns Ar sig
1.21 jmc 328: .Pf ( Dv TERM
1.41 jmc 329: by default) to process
330: .Ar pid .
1.13 aaron 331: This acts similarly to the command
1.2 downsj 332: .Xr kill 1 .
1.44 jmc 333: .It n\*(Ba# Ar count
334: Show
335: .Ar count
1.40 jmc 336: processes.
1.71 kn 337: .It o Oo - Oc Ns Ar field
1.45 jmc 338: Sort the process display area using the specified
339: .Ar field
340: as the primary key.
1.71 kn 341: The
342: .Sq -
343: prefix reverses the order.
1.23 jmc 344: Values are the same as for the
345: .Fl o
346: flag, as detailed above.
1.46 otto 347: .It P Ar pid
348: Highlight a specific process, selected by
349: .Ar pid .
1.48 jmc 350: .Sq P+
351: removes process highlighting.
1.40 jmc 352: .It p Ar pid
1.45 jmc 353: Show only the process
1.40 jmc 354: .Ar pid .
355: .Sq p+
356: shows all processes.
1.44 jmc 357: .It r Ar count pid
1.2 downsj 358: Change the priority (the
359: .Em nice )
1.44 jmc 360: of a list of processes to
361: .Ar count
1.40 jmc 362: for process
363: .Ar pid .
1.13 aaron 364: This acts similarly to the command
1.2 downsj 365: .Xr renice 8 .
1.27 jmc 366: .It S
367: Toggle the display of system processes.
1.44 jmc 368: .It s Ar time
369: Set the delay between screen updates to
370: .Ar time
1.40 jmc 371: seconds.
1.61 jmc 372: .It u Oo - Oc Ns Ar user
1.70 kn 373: Show only those processes owned by username or UID
1.40 jmc 374: .Ar user .
375: .Sq u+
376: shows processes belonging to all users.
1.60 brynet 377: The
1.61 jmc 378: .Sq -
1.60 brynet 379: prefix hides processes belonging to a single
380: .Ar user .
1.2 downsj 381: .El
382: .Sh THE DISPLAY
383: .\" The actual display varies depending on the specific variant of Unix
384: .\" that the machine is running. This description may not exactly match
385: .\" what is seen by top running on this particular machine. Differences
386: .\" are listed at the end of this manual entry.
387: .\" .Pp
1.1 downsj 388: The top few lines of the display show general information
389: about the state of the system, including
1.11 millert 390: .\" the last process ID assigned to a process,
1.2 downsj 391: .\" (on most systems),
1.24 millert 392: the three load average numbers,
1.56 otto 393: the hostname,
1.1 downsj 394: the current time,
395: the number of existing processes,
396: the number of processes in each state
1.26 jaredy 397: (starting, running, idle, stopped, zombie, dead, and on processor),
1.1 downsj 398: and a percentage of time spent in each of the processor states
1.69 bluhm 399: (user, nice, system, spinning, interrupt, and idle).
1.17 aaron 400: It also includes information about physical and virtual memory allocation.
1.24 millert 401: The load average numbers give the number of jobs in the run queue averaged
1.26 jaredy 402: over 1, 5, and 15 minutes.
1.2 downsj 403: .Pp
1.1 downsj 404: The remainder of the screen displays information about individual
1.13 aaron 405: processes.
406: This display is similar in spirit to
1.2 downsj 407: .Xr ps 1
1.13 aaron 408: but it is not exactly the same.
1.26 jaredy 409: The following fields are displayed:
410: .Bl -tag -width USERNAME -offset indent
411: .It PID
412: The process ID.
413: .It USERNAME
414: The name of the process's owner.
1.66 mpi 415: .It TID
416: The thread ID, used instead of USERNAME if
417: .Fl H
418: is specified.
1.26 jaredy 419: .It UID
420: Used instead of USERNAME if
1.2 downsj 421: .Fl u
1.26 jaredy 422: is specified.
423: .It PRI
424: The current priority of the process.
425: .It NICE
426: The nice amount (in the range \-20 to 20).
427: .It SIZE
428: The total size of the process (the text, data, and stack segments).
429: .It RES
430: The current amount of resident memory.
431: .It STATE
432: The current state (one of
433: .Li start ,
434: .Li run ,
1.2 downsj 435: .Li sleep ,
1.26 jaredy 436: .Li stop ,
437: .Li idle ,
1.2 downsj 438: .Li zomb ,
1.26 jaredy 439: .Li dead ,
1.2 downsj 440: or
1.26 jaredy 441: .Li onproc ) .
1.57 sobrado 442: On multiprocessor systems, this is followed by a slash and the CPU
1.26 jaredy 443: number on which the process is bound.
444: .It WAIT
445: A description of the wait channel the process is sleeping on if it's
446: asleep.
447: .It TIME
448: The number of system and user CPU seconds that the process has used.
449: .It CPU
450: The raw percentage of CPU usage and the default field on which the
451: display is sorted.
452: .It COMMAND
453: The name of the command that the process is currently running.
454: (If the process is swapped out, this column is enclosed by angle
455: brackets.)
456: .El
1.2 downsj 457: .Sh ENVIRONMENT
1.26 jaredy 458: .Bl -tag -width Ev
1.2 downsj 459: .It Ev TOP
460: User-configurable defaults for options.
461: .El
462: .Sh FILES
1.50 jmc 463: .Bl -tag -width "/etc/passwdXXX" -compact
1.2 downsj 464: .It Pa /dev/kmem
465: kernel memory
466: .It Pa /dev/mem
467: physical memory
1.26 jaredy 468: .It Pa /etc/passwd
1.49 jmc 469: used to map user ID to user
1.2 downsj 470: .It Pa /bsd
471: kernel image
1.14 aaron 472: .El
1.13 aaron 473: .Sh SEE ALSO
1.30 jmc 474: .Xr fstat 1 ,
1.13 aaron 475: .Xr kill 1 ,
1.30 jmc 476: .Xr netstat 1 ,
1.13 aaron 477: .Xr ps 1 ,
478: .Xr stty 1 ,
479: .Xr systat 1 ,
480: .Xr mem 4 ,
1.30 jmc 481: .Xr iostat 8 ,
482: .Xr pstat 8 ,
483: .Xr renice 8 ,
1.31 jmc 484: .Xr vmstat 8
1.16 aaron 485: .Sh AUTHORS
1.62 schwarze 486: .An William LeFebvre ,
487: EECS Department, Northwestern University
1.68 tedu 488: .Sh CAVEATS
1.1 downsj 489: As with
1.2 downsj 490: .Xr ps 1 ,
491: .Nm
1.68 tedu 492: only provides snapshots of a constantly changing system.
![[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