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