Annotation of src/usr.bin/systat/systat.1, Revision 1.48
1.48 ! deanna 1: .\" $OpenBSD: systat.1,v 1.47 2006/10/15 01:45:10 millert Exp $
1.2 deraadt 2: .\" $NetBSD: systat.1,v 1.6 1996/05/10 23:16:39 thorpej Exp $
1.1 deraadt 3: .\"
4: .\" Copyright (c) 1985, 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
1.28 millert 15: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 16: .\" may be used to endorse or promote products derived from this software
17: .\" without specific prior written permission.
18: .\"
19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: .\" SUCH DAMAGE.
30: .\"
31: .\" @(#)systat.1 8.2 (Berkeley) 12/30/93
32: .\"
33: .Dd December 30, 1993
34: .Dt SYSTAT 1
1.12 aaron 35: .Os
1.1 deraadt 36: .Sh NAME
37: .Nm systat
1.41 jmc 38: .Nd display system statistics
1.1 deraadt 39: .Sh SYNOPSIS
40: .Nm systat
1.34 itojun 41: .Op Fl n
1.2 deraadt 42: .Op Fl w Ar wait
43: .Op Ar display
1.1 deraadt 44: .Op Ar refresh-interval
45: .Sh DESCRIPTION
1.13 aaron 46: .Nm
1.1 deraadt 47: displays various system statistics in a screen oriented fashion
48: using the curses screen display library,
49: .Xr curses 3 .
50: .Pp
51: While
1.13 aaron 52: .Nm
1.1 deraadt 53: is running the screen is usually divided into two windows (an exception
1.16 aaron 54: is the vmstat display which uses the entire screen).
55: The upper window depicts the current system load average.
56: The information displayed in the lower window may vary, depending on
57: user commands.
58: The last line on the screen is reserved for user
1.1 deraadt 59: input and error messages.
60: .Pp
61: By default
1.13 aaron 62: .Nm
1.1 deraadt 63: displays the processes getting the largest percentage of the processor
1.16 aaron 64: in the lower window.
65: Other displays show swap space usage, disk
1.1 deraadt 66: .Tn I/O
67: statistics (a la
1.13 aaron 68: .Xr iostat 8 ) ,
1.1 deraadt 69: virtual memory statistics (a la
1.13 aaron 70: .Xr vmstat 8 ) ,
71: network
72: .Dq mbuf
73: utilization, and network connections (a la
74: .Xr netstat 1 ) .
1.1 deraadt 75: .Pp
76: Input is interpreted at two different levels.
1.13 aaron 77: A
78: .Dq global
79: command interpreter processes all keyboard input.
1.1 deraadt 80: If this command interpreter fails to recognize a command, the
1.16 aaron 81: input line is passed to a per-display command interpreter.
82: This allows each display to have certain display-specific commands.
1.1 deraadt 83: .Pp
1.16 aaron 84: The options are as follows:
1.31 jmc 85: .Bl -tag -width "refresh-interval"
1.34 itojun 86: .It Fl n
87: Do not try to reverse-map IP address.
1.31 jmc 88: .It Fl w Ar wait
89: Specifies the screen refresh time interval in seconds.
90: This option is overridden by
91: .Ar refresh-interval ,
92: if given.
93: The default interval is 5 seconds.
1.2 deraadt 94: .It Ar display
1.1 deraadt 95: The
96: .Ar display
1.2 deraadt 97: argument expects to be one of:
1.1 deraadt 98: .Ic pigs ,
99: .Ic iostat ,
100: .Ic swap ,
101: .Ic mbufs ,
1.35 markus 102: .Ic vmstat ,
103: .Ic ifstat
1.1 deraadt 104: or
105: .Ic netstat .
1.2 deraadt 106: These displays can also be requested interactively and are described in
1.1 deraadt 107: full detail below.
108: .It Ar refresh-interval
109: The
1.2 deraadt 110: .Ar refresh-interval
1.16 aaron 111: specifies the screen refresh time interval in seconds.
112: This is provided for backwards compatibility, and overrides the
1.31 jmc 113: .Ar wait
114: interval specified with the
1.2 deraadt 115: .Fl w
116: flag.
1.31 jmc 117: The default interval is 5 seconds.
1.1 deraadt 118: .El
119: .Pp
120: Certain characters cause immediate action by
1.13 aaron 121: .Nm systat .
1.1 deraadt 122: These are
123: .Bl -tag -width Fl
124: .It Ic \&^L
125: Refresh the screen.
126: .It Ic \&^G
1.13 aaron 127: Print the name of the current
128: .Dq display
129: being shown in
1.1 deraadt 130: the lower window and the refresh interval.
131: .It Ic \&^Z
1.27 jmc 132: Suspend
1.13 aaron 133: .Nm systat .
1.1 deraadt 134: .It Ic \&:
135: Move the cursor to the command line and interpret the input
1.16 aaron 136: line typed as a command.
137: While entering a command the
1.1 deraadt 138: current character erase, word erase, and line kill characters
139: may be used.
140: .El
141: .Pp
1.13 aaron 142: The following commands are interpreted by the
143: .Dq global
1.1 deraadt 144: command interpreter.
145: .Bl -tag -width Fl
146: .It Ic help
147: Print the names of the available displays on the command line.
148: .It Ic load
149: Print the load average over the past 1, 5, and 15 minutes
150: on the command line.
151: .It Ic stop
152: Stop refreshing the screen.
153: .It Xo
154: .Op Ic start
155: .Op Ar number
156: .Xc
1.16 aaron 157: Start (continue) refreshing the screen.
158: If a second, numeric,
1.1 deraadt 159: argument is provided it is interpreted as a refresh interval
160: (in seconds).
161: Supplying only a number will set the refresh interval to this
162: value.
163: .It Ic quit
164: Exit
1.13 aaron 165: .Nm systat .
1.1 deraadt 166: (This may be abbreviated to
1.13 aaron 167: .Ic q . )
1.1 deraadt 168: .El
169: .Pp
170: The available displays are:
171: .Bl -tag -width Ic
172: .It Ic pigs
173: Display, in the lower window, those processes resident in main
174: memory and getting the
175: largest portion of the processor (the default display).
176: When less than 100% of the
177: processor is scheduled to user processes, the remaining time
1.13 aaron 178: is accounted to the
179: .Dq idle
180: process.
1.1 deraadt 181: .It Ic iostat
1.44 jmc 182: Display, in the lower window, statistics about disk throughput.
1.16 aaron 183: Statistics
1.45 dlg 184: on disk throughput show, for each drive, data transferred in kilobytes,
1.2 deraadt 185: number of disk transactions performed, and time spent in disk accesses
1.16 aaron 186: (in milliseconds).
1.1 deraadt 187: .It Ic swap
1.12 aaron 188: Show information about swap space usage on all the
1.1 deraadt 189: swap areas compiled into the kernel.
190: The first column is the device name of the partition.
191: The next column is the total space available in the partition.
1.12 aaron 192: The
1.1 deraadt 193: .Ar Used
194: column indicates the total blocks used so far;
195: the graph shows the percentage of space in use on each partition.
1.8 aaron 196: If there is more than one swap partition in use,
1.1 deraadt 197: a total line is also shown.
1.8 aaron 198: Areas known to the kernel but not in use are shown as not available.
1.1 deraadt 199: .It Ic mbufs
200: Display, in the lower window, the number of mbufs allocated
1.16 aaron 201: for particular uses, i.e., data, socket structures, etc.
1.48 ! deanna 202: .It Ic sensors
! 203: Display the current values of available hardware sensors,
! 204: in a format similar to that of
! 205: .Xr sysctl 8 .
1.1 deraadt 206: .It Ic vmstat
207: Take over the entire display and show a (rather crowded) compendium
208: of statistics related to virtual memory usage, process scheduling,
1.14 alex 209: device interrupts, system name translation caching, disk
1.1 deraadt 210: .Tn I/O
211: etc.
212: .Pp
213: The upper left quadrant of the screen shows the number
1.8 aaron 214: of users logged in and the load average over the last 1, 5,
215: and 15 minute intervals.
1.1 deraadt 216: Below this line are statistics on memory utilization.
217: The first row of the table reports memory usage only among
1.8 aaron 218: active processes, that is, processes that have run in the previous
1.1 deraadt 219: twenty seconds.
220: The second row reports on memory usage of all processes.
1.47 millert 221: The first column reports on the amount of physical memory
1.1 deraadt 222: claimed by processes.
1.29 jmc 223: The second column reports the same figure for
1.47 millert 224: virtual memory, that is, the amount of memory that would be
225: needed if all processes were resident at the same time.
226: Finally, the last column shows the amount of physical memory
1.1 deraadt 227: on the free list.
228: .Pp
1.5 flipk 229: Below the memory display is a list of the average number of processes
1.13 aaron 230: (over the last refresh interval) that are runnable
231: .Pq Sq r ,
232: in disk wait other than paging
233: .Pq Sq d ,
234: sleeping
235: .Pq Sq s ,
236: and swapped out but desiring to run
237: .Pq Sq w .
1.1 deraadt 238: Below the queue length listing is a numerical listing and
239: a bar graph showing the amount of
1.40 dlg 240: interrupt (shown as
241: .Ql | ) ,
1.16 aaron 242: system (shown as
243: .Ql = ) ,
244: user (shown as
1.43 jmc 245: .Ql \*(Gt ) ,
1.16 aaron 246: nice (shown as
247: .Ql - ) ,
248: and idle time (shown as
1.29 jmc 249: .Ql \ \& ) .
1.1 deraadt 250: .Pp
1.12 aaron 251: To the right of the Proc display are statistics about
1.16 aaron 252: Context switches
253: .Pq Dq Csw ,
254: Traps
255: .Pq Dq Trp ,
256: Syscalls
257: .Pq Dq Sys ,
258: Interrupts
259: .Pq Dq Int ,
260: Soft interrupts
261: .Pq Dq Sof ,
262: and Faults
263: .Pq Dq Flt
1.7 deraadt 264: which have occurred during the last refresh interval.
1.5 flipk 265: .Pp
266: Below the CPU Usage graph are statistics on name translations.
1.1 deraadt 267: It lists the number of names translated in the previous interval,
268: the number and percentage of the translations that were
269: handled by the system wide name translation cache, and
270: the number and percentage of the translations that were
271: handled by the per process name translation cache.
272: .Pp
1.5 flipk 273: At the bottom left is the disk usage display.
274: It reports the number of seeks, transfers, number
275: of kilobyte blocks transferred per second averaged over the
276: refresh period of the display (by default, five seconds), and
277: the time spent in disk accesses.
278: .Pp
1.1 deraadt 279: Under the date in the upper right hand quadrant are statistics
280: on paging and swapping activity.
281: The first two columns report the average number of pages
282: brought in and out per second over the last refresh interval
283: due to page faults and the paging daemon.
284: The third and fourth columns report the average number of pages
285: brought in and out per second over the last refresh interval
286: due to swap requests initiated by the scheduler.
287: The first row of the display shows the average
1.8 aaron 288: number of disk transfers per second over the last refresh interval.
289: The second row of the display shows the average
1.1 deraadt 290: number of pages transferred per second over the last refresh interval.
291: .Pp
292: Running down the right hand side of the display is a breakdown
293: of the interrupts being handled by the system.
294: At the top of the list is the total interrupts per second
295: over the time interval.
296: The rest of the column breaks down the total on a device
297: by device basis.
298: Only devices that have interrupted at least once since boot time are shown.
1.5 flipk 299: .Pp
300: Below the SWAPPING display and slightly to the left of the Interrupts
1.18 aaron 301: display is a list of virtual memory statistics.
302: The abbreviations are:
1.36 jmc 303: .Pp
1.38 niallo 304: .Bl -tag -compact -width "kmapentXX" -offset indent
1.21 deraadt 305: .It forks
306: process forks
307: .It fkppw
308: forks where parent waits
309: .It fksvm
310: forks where vmspace is shared
311: .It pwait
312: fault had to wait on a page
313: .It relck
314: fault relock called
315: .It rlkok
316: fault relock is successful
317: .It noram
318: faults out of ram
319: .It ndcpy
320: number of times fault clears "need copy"
321: .It fltcp
322: number of times fault promotes with copy
323: .It zfod
324: fault promotes with zerofill
1.5 flipk 325: .It cow
1.21 deraadt 326: number of times fault anon cow
327: .It fmin
328: min number of free pages
329: .It ftarg
330: target number of free pages
331: .It itarg
332: target number of inactive pages
333: .It wired
334: wired pages
1.25 deraadt 335: .It pdfre
1.21 deraadt 336: pages daemon freed since boot
337: .It pdscn
338: pages daemon scanned since boot
1.38 niallo 339: .It pzidle
340: number of zeroed pages
341: .It kmapent
342: number of kernel map entries
1.5 flipk 343: .El
344: .Pp
1.13 aaron 345: The
346: .Ql %zfod
347: value is more interesting when observed over a long
1.5 flipk 348: period, such as from boot time (see the
349: .Cm boot
350: option below).
1.35 markus 351: .It Ic ifstat
352: Display, in the lower window, interface statistics.
1.42 jmc 353: The
354: .Dq State
355: column has the format
356: .Sm off
357: .Xo
358: .Cm up \*(Ba dn
359: .Bq : Cm U \*(Ba D .
360: .Xc
361: .Sm on
362: .Sq up
363: and
364: .Sq dn
365: represent whether the interface is up or down.
366: .Sq U
367: and
368: .Sq D
369: represent whether the interface is connected or not;
370: in the case of
371: .Xr carp 4
372: interfaces, whether the interface is in master or backup state, respectively.
1.35 markus 373: See below for more options.
1.1 deraadt 374: .It Ic netstat
1.16 aaron 375: Display, in the lower window, network connections.
376: By default, network servers awaiting requests are not displayed.
377: Each address
378: is displayed in the format
379: .Dq host.port ,
380: with each shown symbolically, when possible.
381: It is possible to have addresses displayed numerically,
1.1 deraadt 382: limit the display to a set of ports, hosts, and/or protocols
383: (the minimum unambiguous prefix may be supplied):
1.16 aaron 384: .Bl -tag -width Ar
1.1 deraadt 385: .It Cm all
386: Toggle the displaying of server processes awaiting requests (this
387: is the equivalent of the
388: .Fl a
389: flag to
1.13 aaron 390: .Xr netstat 1 ) .
1.1 deraadt 391: .It Cm numbers
392: Display network addresses numerically.
393: .It Cm names
394: Display network addresses symbolically.
1.16 aaron 395: .It Cm protocol
1.1 deraadt 396: Display only network connections using the indicated protocol
1.13 aaron 397: (currently either
398: .Dq tcp
399: or
400: .Dq udp ) .
1.1 deraadt 401: .It Cm ignore Op Ar items
402: Do not display information about connections associated with
1.16 aaron 403: the specified hosts or ports.
404: Hosts and ports may be specified
405: by name
406: .Pf ( Dq vangogh ,
407: .Dq ftp ) ,
408: or numerically.
409: Host addresses
410: use the Internet dot notation
411: .Pq Dq 128.32.0.9 .
412: Multiple items
1.1 deraadt 413: may be specified with a single command by separating them with
414: spaces.
415: .It Cm display Op Ar items
416: Display information about the connections associated with the
1.16 aaron 417: specified hosts or ports.
418: As for
1.13 aaron 419: .Ar ignore ,
1.8 aaron 420: .Ar items
1.1 deraadt 421: may be names or numbers.
422: .It Cm show Op Ar ports\&|hosts
423: Show, on the command line, the currently selected protocols,
1.16 aaron 424: hosts, and ports.
425: Hosts and ports which are being ignored are prefixed with a
1.30 jmc 426: .Ql \&! .
1.16 aaron 427: If
1.1 deraadt 428: .Ar ports
429: or
430: .Ar hosts
431: is supplied as an argument to
1.13 aaron 432: .Cm show ,
1.1 deraadt 433: then only the requested information will be displayed.
434: .It Cm reset
435: Reset the port, host, and protocol matching mechanisms to the default
436: (any protocol, port, or host).
437: .El
1.35 markus 438: .El
439: .Pp
440: The following commands are specific to the
441: .Ic vmstat
442: and
443: .Ic ifstat
444: displays; the minimum unambiguous prefix may be supplied.
445: .Pp
446: .Bl -tag -width Ds -compact
447: .It Cm boot
448: Display cumulative statistics since the system was booted.
449: .It Cm run
450: Display statistics as a running total from the point this
451: command is given.
452: .It Cm time
453: Display statistics averaged over the refresh interval (the default).
454: .It Cm zero
455: Reset running statistics to zero.
1.1 deraadt 456: .El
457: .Pp
458: Commands to switch between displays may be abbreviated to the
1.16 aaron 459: minimum unambiguous prefix; for example,
460: .Dq io
461: for
462: .Dq iostat .
1.1 deraadt 463: Certain information may be discarded when the screen size is
1.16 aaron 464: insufficient for display.
465: For example, on a machine with 10 drives the
1.1 deraadt 466: .Ic iostat
1.16 aaron 467: bar graph displays only 3 drives on a 24 line terminal.
468: When a bar graph would overflow the allotted screen space it is
469: truncated and the actual value is printed
470: .Dq over top
471: of the bar.
1.1 deraadt 472: .Pp
473: The following commands are common to each display which shows
1.16 aaron 474: information about disk drives.
475: These commands are used to
1.1 deraadt 476: select a set of drives to report on, should your system have
477: more drives configured than can normally be displayed on the
478: screen.
479: .Pp
480: .Bl -tag -width Tx -compact
481: .It Cm ignore Op Ar drives
1.16 aaron 482: Do not display information about the drives indicated.
483: Multiple drives may be specified, separated by spaces.
1.1 deraadt 484: .It Cm display Op Ar drives
1.16 aaron 485: Display information about the drives indicated.
486: Multiple drives may be specified, separated by spaces.
1.1 deraadt 487: .El
488: .Sh FILES
489: .Bl -tag -width /etc/networks -compact
490: .It Pa /etc/hosts
1.22 miod 491: host names
1.1 deraadt 492: .It Pa /etc/networks
1.22 miod 493: network names
1.1 deraadt 494: .It Pa /etc/services
1.22 miod 495: port names
1.1 deraadt 496: .El
1.15 aaron 497: .Sh SEE ALSO
1.37 jmc 498: .Xt fstat 1 ,
1.15 aaron 499: .Xr kill 1 ,
1.37 jmc 500: .Xr netstat 1 ,
1.15 aaron 501: .Xr ps 1 ,
502: .Xr top 1 ,
1.37 jmc 503: .Xr iostat 8 ,
504: .Xr pstat 8 ,
505: .Xr renice 8 ,
1.48 ! deanna 506: .Xr sysctl 8 ,
1.37 jmc 507: .Xr vmstat 8
1.1 deraadt 508: .Sh HISTORY
509: The
1.13 aaron 510: .Nm
1.1 deraadt 511: program appeared in
512: .Bx 4.3 .
513: .Sh BUGS
1.10 aaron 514: Takes 2-10 percent of the CPU.
1.1 deraadt 515: Certain displays presume a minimum of 80 characters per line.
516: The
517: .Ic vmstat
518: display looks out of place because it is (it was added in as
519: a separate display rather than created as a new program).
![[BACK]](/icons/back.gif){kind=icon}
Return to systat.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / systat