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