Annotation of src/usr.bin/systat/systat.1, Revision 1.51
1.51 ! jmc 1: .\" $OpenBSD: systat.1,v 1.50 2007/02/23 23:03:18 jmc 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 ,
1.49 deraadt 101: .Ic sensors ,
1.1 deraadt 102: .Ic mbufs ,
1.35 markus 103: .Ic vmstat ,
104: .Ic ifstat
1.1 deraadt 105: or
106: .Ic netstat .
1.2 deraadt 107: These displays can also be requested interactively and are described in
1.1 deraadt 108: full detail below.
1.50 jmc 109: Commands to switch between displays may be abbreviated to the
110: minimum unambiguous prefix; for example,
111: .Dq io
112: for
113: .Dq iostat .
1.1 deraadt 114: .It Ar refresh-interval
115: The
1.2 deraadt 116: .Ar refresh-interval
1.16 aaron 117: specifies the screen refresh time interval in seconds.
118: This is provided for backwards compatibility, and overrides the
1.31 jmc 119: .Ar wait
120: interval specified with the
1.2 deraadt 121: .Fl w
122: flag.
1.31 jmc 123: The default interval is 5 seconds.
1.1 deraadt 124: .El
125: .Pp
126: Certain characters cause immediate action by
1.13 aaron 127: .Nm systat .
1.1 deraadt 128: These are
129: .Bl -tag -width Fl
130: .It Ic \&^L
131: Refresh the screen.
132: .It Ic \&^G
1.13 aaron 133: Print the name of the current
134: .Dq display
135: being shown in
1.1 deraadt 136: the lower window and the refresh interval.
137: .It Ic \&^Z
1.27 jmc 138: Suspend
1.13 aaron 139: .Nm systat .
1.1 deraadt 140: .It Ic \&:
141: Move the cursor to the command line and interpret the input
1.16 aaron 142: line typed as a command.
143: While entering a command the
1.1 deraadt 144: current character erase, word erase, and line kill characters
145: may be used.
146: .El
147: .Pp
1.13 aaron 148: The following commands are interpreted by the
149: .Dq global
1.1 deraadt 150: command interpreter.
151: .Bl -tag -width Fl
152: .It Ic help
153: Print the names of the available displays on the command line.
154: .It Ic load
155: Print the load average over the past 1, 5, and 15 minutes
156: on the command line.
157: .It Ic stop
158: Stop refreshing the screen.
159: .It Xo
160: .Op Ic start
161: .Op Ar number
162: .Xc
1.16 aaron 163: Start (continue) refreshing the screen.
164: If a second, numeric,
1.1 deraadt 165: argument is provided it is interpreted as a refresh interval
166: (in seconds).
167: Supplying only a number will set the refresh interval to this
168: value.
169: .It Ic quit
170: Exit
1.13 aaron 171: .Nm systat .
1.1 deraadt 172: (This may be abbreviated to
1.13 aaron 173: .Ic q . )
1.1 deraadt 174: .El
175: .Pp
176: The available displays are:
177: .Bl -tag -width Ic
178: .It Ic pigs
179: Display, in the lower window, those processes resident in main
180: memory and getting the
181: largest portion of the processor (the default display).
182: When less than 100% of the
183: processor is scheduled to user processes, the remaining time
1.13 aaron 184: is accounted to the
185: .Dq idle
186: process.
1.1 deraadt 187: .It Ic iostat
1.44 jmc 188: Display, in the lower window, statistics about disk throughput.
1.16 aaron 189: Statistics
1.45 dlg 190: on disk throughput show, for each drive, data transferred in kilobytes,
1.2 deraadt 191: number of disk transactions performed, and time spent in disk accesses
1.16 aaron 192: (in milliseconds).
1.1 deraadt 193: .It Ic swap
1.12 aaron 194: Show information about swap space usage on all the
1.1 deraadt 195: swap areas compiled into the kernel.
196: The first column is the device name of the partition.
197: The next column is the total space available in the partition.
1.12 aaron 198: The
1.1 deraadt 199: .Ar Used
200: column indicates the total blocks used so far;
201: the graph shows the percentage of space in use on each partition.
1.8 aaron 202: If there is more than one swap partition in use,
1.1 deraadt 203: a total line is also shown.
1.8 aaron 204: Areas known to the kernel but not in use are shown as not available.
1.1 deraadt 205: .It Ic mbufs
206: Display, in the lower window, the number of mbufs allocated
1.16 aaron 207: for particular uses, i.e., data, socket structures, etc.
1.48 deanna 208: .It Ic sensors
1.51 ! jmc 209: Display, in the lower window,
! 210: the current values of available hardware sensors,
1.48 deanna 211: in a format similar to that of
212: .Xr sysctl 8 .
1.1 deraadt 213: .It Ic vmstat
214: Take over the entire display and show a (rather crowded) compendium
215: of statistics related to virtual memory usage, process scheduling,
1.14 alex 216: device interrupts, system name translation caching, disk
1.1 deraadt 217: .Tn I/O
218: etc.
219: .Pp
220: The upper left quadrant of the screen shows the number
1.8 aaron 221: of users logged in and the load average over the last 1, 5,
222: and 15 minute intervals.
1.1 deraadt 223: Below this line are statistics on memory utilization.
224: The first row of the table reports memory usage only among
1.8 aaron 225: active processes, that is, processes that have run in the previous
1.1 deraadt 226: twenty seconds.
227: The second row reports on memory usage of all processes.
1.47 millert 228: The first column reports on the amount of physical memory
1.1 deraadt 229: claimed by processes.
1.29 jmc 230: The second column reports the same figure for
1.47 millert 231: virtual memory, that is, the amount of memory that would be
232: needed if all processes were resident at the same time.
233: Finally, the last column shows the amount of physical memory
1.1 deraadt 234: on the free list.
235: .Pp
1.5 flipk 236: Below the memory display is a list of the average number of processes
1.13 aaron 237: (over the last refresh interval) that are runnable
238: .Pq Sq r ,
239: in disk wait other than paging
240: .Pq Sq d ,
241: sleeping
242: .Pq Sq s ,
243: and swapped out but desiring to run
244: .Pq Sq w .
1.1 deraadt 245: Below the queue length listing is a numerical listing and
246: a bar graph showing the amount of
1.40 dlg 247: interrupt (shown as
248: .Ql | ) ,
1.16 aaron 249: system (shown as
250: .Ql = ) ,
251: user (shown as
1.43 jmc 252: .Ql \*(Gt ) ,
1.16 aaron 253: nice (shown as
254: .Ql - ) ,
255: and idle time (shown as
1.29 jmc 256: .Ql \ \& ) .
1.1 deraadt 257: .Pp
1.12 aaron 258: To the right of the Proc display are statistics about
1.16 aaron 259: Context switches
260: .Pq Dq Csw ,
261: Traps
262: .Pq Dq Trp ,
263: Syscalls
264: .Pq Dq Sys ,
265: Interrupts
266: .Pq Dq Int ,
267: Soft interrupts
268: .Pq Dq Sof ,
269: and Faults
270: .Pq Dq Flt
1.7 deraadt 271: which have occurred during the last refresh interval.
1.5 flipk 272: .Pp
273: Below the CPU Usage graph are statistics on name translations.
1.1 deraadt 274: It lists the number of names translated in the previous interval,
275: the number and percentage of the translations that were
276: handled by the system wide name translation cache, and
277: the number and percentage of the translations that were
278: handled by the per process name translation cache.
279: .Pp
1.5 flipk 280: At the bottom left is the disk usage display.
281: It reports the number of seeks, transfers, number
282: of kilobyte blocks transferred per second averaged over the
283: refresh period of the display (by default, five seconds), and
284: the time spent in disk accesses.
285: .Pp
1.1 deraadt 286: Under the date in the upper right hand quadrant are statistics
287: on paging and swapping activity.
288: The first two columns report the average number of pages
289: brought in and out per second over the last refresh interval
290: due to page faults and the paging daemon.
291: The third and fourth columns report the average number of pages
292: brought in and out per second over the last refresh interval
293: due to swap requests initiated by the scheduler.
294: The first row of the display shows the average
1.8 aaron 295: number of disk transfers per second over the last refresh interval.
296: The second row of the display shows the average
1.1 deraadt 297: number of pages transferred per second over the last refresh interval.
298: .Pp
299: Running down the right hand side of the display is a breakdown
300: of the interrupts being handled by the system.
301: At the top of the list is the total interrupts per second
302: over the time interval.
303: The rest of the column breaks down the total on a device
304: by device basis.
305: Only devices that have interrupted at least once since boot time are shown.
1.5 flipk 306: .Pp
307: Below the SWAPPING display and slightly to the left of the Interrupts
1.18 aaron 308: display is a list of virtual memory statistics.
309: The abbreviations are:
1.36 jmc 310: .Pp
1.38 niallo 311: .Bl -tag -compact -width "kmapentXX" -offset indent
1.21 deraadt 312: .It forks
313: process forks
314: .It fkppw
315: forks where parent waits
316: .It fksvm
317: forks where vmspace is shared
318: .It pwait
319: fault had to wait on a page
320: .It relck
321: fault relock called
322: .It rlkok
323: fault relock is successful
324: .It noram
325: faults out of ram
326: .It ndcpy
327: number of times fault clears "need copy"
328: .It fltcp
329: number of times fault promotes with copy
330: .It zfod
331: fault promotes with zerofill
1.5 flipk 332: .It cow
1.21 deraadt 333: number of times fault anon cow
334: .It fmin
335: min number of free pages
336: .It ftarg
337: target number of free pages
338: .It itarg
339: target number of inactive pages
340: .It wired
341: wired pages
1.25 deraadt 342: .It pdfre
1.21 deraadt 343: pages daemon freed since boot
344: .It pdscn
345: pages daemon scanned since boot
1.38 niallo 346: .It pzidle
347: number of zeroed pages
348: .It kmapent
349: number of kernel map entries
1.5 flipk 350: .El
351: .Pp
1.13 aaron 352: The
353: .Ql %zfod
354: value is more interesting when observed over a long
1.5 flipk 355: period, such as from boot time (see the
356: .Cm boot
357: option below).
1.35 markus 358: .It Ic ifstat
359: Display, in the lower window, interface statistics.
1.42 jmc 360: The
361: .Dq State
362: column has the format
363: .Sm off
364: .Xo
365: .Cm up \*(Ba dn
366: .Bq : Cm U \*(Ba D .
367: .Xc
368: .Sm on
369: .Sq up
370: and
371: .Sq dn
372: represent whether the interface is up or down.
373: .Sq U
374: and
375: .Sq D
376: represent whether the interface is connected or not;
377: in the case of
378: .Xr carp 4
379: interfaces, whether the interface is in master or backup state, respectively.
1.35 markus 380: See below for more options.
1.1 deraadt 381: .It Ic netstat
1.16 aaron 382: Display, in the lower window, network connections.
383: By default, network servers awaiting requests are not displayed.
384: Each address
385: is displayed in the format
386: .Dq host.port ,
387: with each shown symbolically, when possible.
388: It is possible to have addresses displayed numerically,
1.1 deraadt 389: limit the display to a set of ports, hosts, and/or protocols
390: (the minimum unambiguous prefix may be supplied):
1.16 aaron 391: .Bl -tag -width Ar
1.1 deraadt 392: .It Cm all
393: Toggle the displaying of server processes awaiting requests (this
394: is the equivalent of the
395: .Fl a
396: flag to
1.13 aaron 397: .Xr netstat 1 ) .
1.1 deraadt 398: .It Cm numbers
399: Display network addresses numerically.
400: .It Cm names
401: Display network addresses symbolically.
1.16 aaron 402: .It Cm protocol
1.1 deraadt 403: Display only network connections using the indicated protocol
1.13 aaron 404: (currently either
405: .Dq tcp
406: or
407: .Dq udp ) .
1.1 deraadt 408: .It Cm ignore Op Ar items
409: Do not display information about connections associated with
1.16 aaron 410: the specified hosts or ports.
411: Hosts and ports may be specified
412: by name
413: .Pf ( Dq vangogh ,
414: .Dq ftp ) ,
415: or numerically.
416: Host addresses
417: use the Internet dot notation
418: .Pq Dq 128.32.0.9 .
419: Multiple items
1.1 deraadt 420: may be specified with a single command by separating them with
421: spaces.
422: .It Cm display Op Ar items
423: Display information about the connections associated with the
1.16 aaron 424: specified hosts or ports.
425: As for
1.13 aaron 426: .Ar ignore ,
1.8 aaron 427: .Ar items
1.1 deraadt 428: may be names or numbers.
429: .It Cm show Op Ar ports\&|hosts
430: Show, on the command line, the currently selected protocols,
1.16 aaron 431: hosts, and ports.
432: Hosts and ports which are being ignored are prefixed with a
1.30 jmc 433: .Ql \&! .
1.16 aaron 434: If
1.1 deraadt 435: .Ar ports
436: or
437: .Ar hosts
438: is supplied as an argument to
1.13 aaron 439: .Cm show ,
1.1 deraadt 440: then only the requested information will be displayed.
441: .It Cm reset
442: Reset the port, host, and protocol matching mechanisms to the default
443: (any protocol, port, or host).
444: .El
1.35 markus 445: .El
446: .Pp
447: The following commands are specific to the
448: .Ic vmstat
449: and
450: .Ic ifstat
451: displays; the minimum unambiguous prefix may be supplied.
452: .Pp
453: .Bl -tag -width Ds -compact
454: .It Cm boot
455: Display cumulative statistics since the system was booted.
456: .It Cm run
457: Display statistics as a running total from the point this
458: command is given.
459: .It Cm time
460: Display statistics averaged over the refresh interval (the default).
461: .It Cm zero
462: Reset running statistics to zero.
1.1 deraadt 463: .El
464: .Pp
465: Certain information may be discarded when the screen size is
1.16 aaron 466: insufficient for display.
467: For example, on a machine with 10 drives the
1.1 deraadt 468: .Ic iostat
1.16 aaron 469: bar graph displays only 3 drives on a 24 line terminal.
470: When a bar graph would overflow the allotted screen space it is
471: truncated and the actual value is printed
472: .Dq over top
473: of the bar.
1.1 deraadt 474: .Pp
475: The following commands are common to each display which shows
1.16 aaron 476: information about disk drives.
477: These commands are used to
1.1 deraadt 478: select a set of drives to report on, should your system have
479: more drives configured than can normally be displayed on the
480: screen.
481: .Pp
482: .Bl -tag -width Tx -compact
483: .It Cm ignore Op Ar drives
1.16 aaron 484: Do not display information about the drives indicated.
485: Multiple drives may be specified, separated by spaces.
1.1 deraadt 486: .It Cm display Op Ar drives
1.16 aaron 487: Display information about the drives indicated.
488: Multiple drives may be specified, separated by spaces.
1.1 deraadt 489: .El
490: .Sh FILES
491: .Bl -tag -width /etc/networks -compact
492: .It Pa /etc/hosts
1.22 miod 493: host names
1.1 deraadt 494: .It Pa /etc/networks
1.22 miod 495: network names
1.1 deraadt 496: .It Pa /etc/services
1.22 miod 497: port names
1.1 deraadt 498: .El
1.15 aaron 499: .Sh SEE ALSO
1.37 jmc 500: .Xt fstat 1 ,
1.15 aaron 501: .Xr kill 1 ,
1.37 jmc 502: .Xr netstat 1 ,
1.15 aaron 503: .Xr ps 1 ,
504: .Xr top 1 ,
1.37 jmc 505: .Xr iostat 8 ,
506: .Xr pstat 8 ,
507: .Xr renice 8 ,
1.48 deanna 508: .Xr sysctl 8 ,
1.37 jmc 509: .Xr vmstat 8
1.1 deraadt 510: .Sh HISTORY
511: The
1.13 aaron 512: .Nm
1.1 deraadt 513: program appeared in
514: .Bx 4.3 .
515: .Sh BUGS
1.10 aaron 516: Takes 2-10 percent of the CPU.
1.1 deraadt 517: Certain displays presume a minimum of 80 characters per line.
518: The
519: .Ic vmstat
520: display looks out of place because it is (it was added in as
521: 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