1.\" Copyright (c) 1985, 1990, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)systat.1 8.2 (Berkeley) 12/30/93 29.\" $FreeBSD: src/usr.bin/systat/systat.1,v 1.23.2.9 2002/12/29 16:35:40 schweikh Exp $ 30.\" $DragonFly: src/usr.bin/systat/systat.1,v 1.8 2008/09/02 11:50:46 matthias Exp $ 31.\" 32.Dd September 28, 2009 33.Dt SYSTAT 1 34.Os 35.Sh NAME 36.Nm systat 37.Nd display system statistics on a crt 38.Sh SYNOPSIS 39.Nm 40.Op Fl Ar display 41.Op Ar refresh-interval 42.Sh DESCRIPTION 43The 44.Nm 45utility displays various system statistics in a screen oriented fashion 46using the curses screen display library, 47.Xr ncurses 3 . 48.Pp 49While 50.Nm 51is running the screen is usually divided into two windows (an exception 52is the vmstat and pvmmeter displays which uses the entire screen). 53The upper window depicts the current system load average. 54The information displayed in the lower window may vary, depending on 55user commands. 56The last line on the screen is reserved for user input and error messages. 57.Pp 58By default 59.Nm 60displays the processes getting the largest percentage of the processor 61in the lower window. 62Other displays show swap space usage, disk 63.Tn I/O 64statistics (a la 65.Xr iostat 8 ) , 66virtual memory statistics (a la 67.Xr vmstat 8 ) , 68network ``mbuf'' utilization, 69.Tn TCP/IP 70statistics, 71and network connections (a la 72.Xr netstat 1 ) . 73.Pp 74Input is interpreted at two different levels. 75A ``global'' command interpreter processes all keyboard input. 76If this command interpreter fails to recognize a command, the 77input line is passed to a per-display command interpreter. 78This allows each display to have certain display-specific commands. 79.Pp 80Command line options: 81.Bl -tag -width "refresh_interval" 82.It Fl Ns Ar display 83The 84.Fl 85flag expects 86.Ar display 87to be one of: 88.Ic altq , 89.Ic icmp , 90.Ic icmp6 , 91.Ic ifstat , 92.Ic iostat , 93.Ic ip , 94.Ic ip6 , 95.Ic mbufs , 96.Ic netstat , 97.Ic netbw , 98.Ic pftop , 99.Ic pigs , 100.Ic pvmmeter , 101.Ic sensors , 102.Ic swap , 103.Ic tcp , 104or 105.Ic vmstat . 106These displays can also be requested interactively (without the 107.Dq Fl ) 108and are described in 109full detail below. 110.It Ar refresh-interval 111The 112.Ar refresh-value 113specifies the screen refresh time interval in seconds. 114.El 115.Pp 116Certain characters cause immediate action by 117.Nm . 118These are 119.Bl -tag -width Fl 120.It Ic \&^L 121Refresh the screen. 122.It Ic \&^G 123Print the name of the current ``display'' being shown in 124the lower window and the refresh interval. 125.It Ic \&: 126Move the cursor to the command line and interpret the input 127line typed as a command. 128While entering a command the current character erase, word erase, 129and line kill characters may be used. 130.El 131.Pp 132The following commands are interpreted by the ``global'' command interpreter. 133.Bl -tag -width Fl 134.It Ic help 135Print the names of the available displays on the command line. 136.It Ic load 137Print the load average over the past 1, 5, and 15 minutes on the command line. 138.It Ic stop 139Stop refreshing the screen. 140.It Oo Ic start Oc Op Ar number 141Start (continue) refreshing the screen. 142If a second, numeric, argument is provided it is interpreted as a 143refresh interval (in seconds). 144Supplying only a number will set the refresh interval to this value. 145.It Ic quit 146Exit 147.Nm . 148(This may be abbreviated to 149.Ic q . ) 150.El 151.Pp 152The available displays are: 153.Bl -tag -width Ic 154.It Ic pigs 155Display, in the lower window, those processes resident in main 156memory and getting the 157largest portion of the processor (the default display). 158When less than 100% of the 159processor is scheduled to user processes, the remaining time 160is accounted to the ``idle'' process. 161.It Ic icmp 162Display, in the lower window, statistics about messages received and 163transmitted by the Internet Control Message Protocol 164.Pq Dq Tn ICMP . 165The left half of the screen displays information about received packets, 166and the right half displays information regarding transmitted packets. 167.Pp 168The 169.Ic icmp 170display understands two commands: 171.Ic mode 172and 173.Ic reset . 174The 175.Ic mode 176command is used to select one of four display modes, given as its argument: 177.Pp 178.Bl -tag -width absoluteXX -compact 179.It Ic rate 180Show the rate of change of each value in packets per second (the default). 181.It Ic delta 182Show the rate of change of each value in packets per refresh interval. 183.It Ic since 184Show the total change of each value since the display was last reset. 185.It Ic absolute 186Show the absolute value of each statistic. 187.El 188.Pp 189The 190.Ic reset 191command resets the baseline for 192.Ic since 193mode. 194The 195.Ic mode 196command with no argument will display the current mode in the command line. 197.It Ic icmp6 198This display is like the 199.Ic icmp 200display, but displays statistics for 201.Tn IPv6 ICMP . 202.It Ic ip 203Otherwise identical to the 204.Ic icmp 205display, except that it displays 206.Tn IP 207and 208.Tn UDP 209statistics. 210.It Ic ip6 211Like the 212.Ic ip 213display, 214except that it displays 215.Tn IPv6 216statistics. 217.It Ic tcp 218Like 219.Ic icmp , 220but with 221.Tn TCP 222statistics. 223.It Ic ifstat 224Display, in the lower window, statistics about network throughput on 225a per-interface basis. 226.It Ic iostat 227Display, in the lower window, statistics about processor use 228and disk throughput. 229Statistics on processor use appear as 230bar graphs of the amount of time executing in user mode (`user'), 231in user mode running low priority processes (`nice'), in 232system mode (`system'), in interrupt mode (`interrupt'), 233and idle (`idle'). 234Statistics on disk throughput show, for each drive, megabytes per second, 235average number of disk transactions per second, and 236average kilobytes of data per transaction. 237This information may be 238displayed as bar graphs or as rows of numbers which scroll downward. 239Bar graphs are shown by default. 240.Pp 241The following commands are specific to the 242.Ic iostat 243display; the minimum unambiguous prefix may be supplied. 244.Pp 245.Bl -tag -width Fl -compact 246.It Ic numbers 247Show the disk 248.Tn I/O 249statistics in numeric form. 250Values are displayed in numeric columns which scroll downward. 251.It Ic bars 252Show the disk 253.Tn I/O 254statistics in bar graph form (default). 255.It Ic kbpt 256Toggle the display of kilobytes per transaction. 257(the default is to not display kilobytes per transaction). 258.El 259.It Ic sensors 260Display, in the lower window, 261the current values of available hardware sensors, 262in a format similar to that of 263.Xr sysctl 8 . 264.It Ic swap 265Show information about swap space usage on all the 266swap areas compiled into the kernel. 267The first column is the device name of the partition. 268The next column is the total space available in the partition. 269The ``Used'' column indicates the total blocks used so far; 270the graph shows the percentage of space in use on each partition. 271If there are more than one swap partition in use, 272a total line is also shown. 273Areas known to the kernel, but not in use are shown as not available. 274.It Ic mbufs 275Display, in the lower window, the number of mbufs allocated 276for particular uses, i.e.\& data, socket structures, etc. 277.It Ic vmstat 278Take over the entire display and show a (rather crowded) compendium 279of statistics related to virtual memory usage, process scheduling, 280device interrupts, system name translation cacheing, disk 281.Tn I/O 282etc. 283.Pp 284The upper left quadrant of the screen shows the number 285of users logged in and the load average over the last one, five, 286and fifteen minute intervals. 287.Pp 288Below this line are statistics on memory utilization. 289The first row (`Act') reports memory usage only among active processes, 290that is processes that have run in the previous twenty seconds. 291The second row (`All') reports on memory usage of all processes. 292Two groups of columns are shown, `REAL' and `VIRTUAL'. 293The first column (`Tot') reports on the number of 294physical pages claimed by processes. 295The second column (`Share') reports the number of 296physical pages that are devoted to read only text pages. 297The third and fourth columns report the same two figures for 298virtual pages, that is the number of pages that would be 299needed if all processes had all of their pages. 300Finally the last column (`Free') shows the number of 301physical pages on the free list. 302.Pp 303Below the memory display is a list of the 304average number of processes (over the last refresh interval) 305that are runnable (`r'), in page wait (`p'), 306in disk wait other than paging (`d'), 307sleeping (`s'), and swapped out but desiring to run (`w'). 308The row also shows the average number of context switches (`Csw'), 309traps (`Trp'; includes page faults), system calls (`Sys'), interrupts (`Int'), 310network software interrupts (`Sof'), and page faults (`Flt'). 311.Pp 312Below the process queue length listing is a listing of 313.Tn CPU 314usage, a numerical listing and a bar graph showing the amount of 315system (`='), interrupt (`+'), user (`>'), nice (`-'), and idle time (` '). 316.Pp 317Below the 318.Tn CPU 319usage display are statistics on name translations. 320It lists the number of path names translated 321in the previous interval (`Path-lookups'), 322the number and percentage of the path lookups that were 323handled by the name translation cache, and 324the average number of path components in path lookups (`Components'). 325.Pp 326At the bottom left is the disk usage display. 327It reports the number of 328kilobytes per transaction (`KB/t'), 329read transactions per second (`tpr/s'), 330megabytes per second in read transaction (`MBr/s'), 331write transactions per second (`tpw/s'), 332megabytes per second in write transaction (`MBw/s') and 333the percentage of the time the disk was busy (`% busy') averaged 334over the refresh period of the display (by default, five seconds). 335The system keeps statistics on most every storage device. 336In general, up to seven devices are displayed. 337The devices displayed by default are the 338first devices in the kernel's device list. 339See 340.Xr devstat 3 341and 342.Xr devstat 9 343for details on the devstat system. 344.Pp 345If at most 4 disk devices are shown, 346extended virtual memory statistics are shown right to disk usage: 347pages zero filled on demand (`zfod'), 348pages optimized zero filled on demand (`ozfod'), 349slow (i.e.\& non-optimized) zero fills percentage (`%sloz'), 350total pages freed (`tfree'). 351.Pp 352Under the date in the upper right hand quadrant are statistics 353on paging and swapping activity. 354The first two columns (`VN PAGER') report the average number of pages 355brought in and out per second over the last refresh interval 356due to page faults and the paging daemon. 357The third and fourth columns (`SWAP PAGER') report the average number of pages 358brought in and out per second over the last refresh interval 359due to swap requests initiated by the scheduler. 360The first row (`count') of the display shows the average 361number of disk transfers per second over the last refresh interval; 362the second row (`pages') of the display shows the average 363number of pages transferred per second over the last refresh interval. 364.Pp 365Below the paging statistics is a column of lines regarding the virtual 366memory system which list the average number of 367pages zero filled on demand (`zfod') 368(shown with extended virtual memory statistics if screen space permits), 369pages copied on write (`cow'), 370pages wired down (`wire'), 371active pages (`act'), 372inactive pages (`inact'), 373pages on the buffer cache queue (`cache'), 374number of free pages (`free'), 375pages freed by the page daemon (`daefr'), 376pages freed by exiting processes (`prcfr'), 377pages reactivated from the free list (`react'), 378times the page daemon was awakened (`pdwak'), 379pages analyzed by the page daemon (`pdpgs'), 380and 381intransit blocking page faults (`intrn') 382per second over the refresh interval. 383.Pp 384At the bottom of this column are lines showing the 385amount of memory, in kilobytes, used for the buffer cache (`buf'), 386the number of dirty buffers in the buffer cache (`dirtybuf'), 387desired maximum size of vnode cache (`desiredvnodes') 388(mostly unused, except to size the name cache), 389number of vnodes actually allocated (`numvnodes'), 390and 391number of allocated vnodes that are free (`freevnodes'). 392.Pp 393Running down the right hand side of the display is a breakdown 394of the interrupts being handled by the system (`Interrupts'). 395At the top of the list is the total interrupts per second 396over the time interval (`total'). 397The rest of the column breaks down the total on a device by device basis. 398Only devices that have interrupted at least once since boot time are shown. 399.Pp 400The following commands are specific to the 401.Ic vmstat 402display; the minimum unambiguous prefix may be supplied. 403.Pp 404.Bl -tag -width Ar -compact 405.It Ic boot 406Display cumulative statistics since the system was booted. 407.It Ic run 408Display statistics as a running total from the point this command is given. 409.It Ic time 410Display statistics averaged over the refresh interval (the default). 411.It Ic want_fd 412Toggle the display of fd devices in the disk usage display. 413.It Ic zero 414Reset running statistics to zero. 415.El 416.It Ic pvmmeter 417Display per 418.Tn CPU 419statistics, including 420.Tn LAPIC 421timer interrupts (`timer'), 422.Tn IPIs 423(Inter-Processor Interrupts) (`ipi'), 424external interrupts (i.e.\& not timer or ipi) (`extint'), and 425.Tn CPU 426time breakdown (`user%', `nice%', `sys%', `intr%', and `idle%'). 427.It Ic netstat 428Display, in the lower window, network connections. 429By default, network servers awaiting requests are not displayed. 430Each address is displayed in the format ``host.port'', 431with each shown symbolically, when possible. 432It is possible to have addresses displayed numerically, 433limit the display to a set of ports, hosts, and/or protocols 434(the minimum unambiguous prefix may be supplied): 435.Pp 436.Bl -tag -width Ar -compact 437.It Ic all 438Toggle the displaying of server processes awaiting requests (this 439is the equivalent of the 440.Fl a 441flag to 442.Xr netstat 1 ) . 443.It Ic numbers 444Display network addresses numerically. 445.It Ic names 446Display network addresses symbolically. 447.It Ic proto Ar protocol 448Display only network connections using the indicated 449.Ar protocol . 450Supported protocols are 451.Cm tcp , 452.Cm udp , 453and 454.Cm all . 455.It Ic ignore Op Ar items 456Do not display information about connections associated with 457the specified hosts or ports. 458Hosts and ports may be specified 459by name (``vangogh'', ``ftp''), or numerically. 460Host addresses use the Internet dot notation (``128.32.0.9''). 461Multiple items 462may be specified with a single command by separating them with spaces. 463.It Ic display Op Ar items 464Display information about the connections associated with the 465specified hosts or ports. 466As for 467.Ic ignore , 468.Ar items 469may be names or numbers. 470.It Ic show Op Cm ports | hosts 471Show, on the command line, the currently selected protocols, hosts, and ports. 472Hosts and ports which are being ignored are prefixed with a `!'. 473If 474.Cm ports 475or 476.Cm hosts 477is supplied as an argument to 478.Ic show , 479then only the requested information will be displayed. 480.It Ic reset 481Reset the port, host, and protocol matching mechanisms to the default 482(any protocol, port, or host). 483.El 484.It Ic netbw 485Display aggregate and per-connection tcp receive and transmit rates. 486Only active tcp connections originated or terminated by the host 487are shown. 488.It Ic pftop 489Display packet filter (pf) state information for states which are 490actively passing data. This requires pf to be active to be meaningful 491but is capable of displaying connection state for all packet traffic 492passing through the machine, even for connections that do not originate 493or terminate on the machine. 494.It Ic altq 495Display packet filter altq statistics. 496The ALTQ operates in conjuction with the packet filter (pf) on the 497interface's transmit path. 498Packet rate, data rate in bytes per interval, drop rate, and queue 499length is displayed in three separate sections in a convenient 500INTERFACE-by-ALTQLABEL matrix. 501.Pp 502To save space drops 503and queue length are combined in the third section. 504If packet drops are present, drops 505will be displayed, otherwise the packet queue length with a 'Q' suffix 506will be displayed. 507.El 508.Pp 509Commands to switch between displays may be abbreviated to the 510minimum unambiguous prefix; for example, ``io'' for ``iostat''. 511Certain information may be discarded when the screen size is 512insufficient for display. 513For example, on a machine with 10 drives the 514.Ic iostat 515bar graph displays only 3 drives on a 24 line terminal. 516When a bar graph would overflow the allotted screen space it is 517truncated and the actual value is printed ``over top'' of the bar. 518.Pp 519The following commands are common to each display which shows 520information about disk drives. 521These commands are used to 522select a set of drives to report on, should your system have 523more drives configured than can normally be displayed on the screen. 524.Pp 525.Bl -tag -width Ar -compact 526.It Ic ignore Op Ar drives 527Do not display information about the drives indicated. 528Multiple drives may be specified, separated by spaces. 529.It Ic display Op Ar drives 530Display information about the drives indicated. 531Multiple drives may be specified, separated by spaces. 532.It Ic only Op Ar drives 533Display only the specified drives. 534Multiple drives may be specified, separated by spaces. 535.It Ic drives 536Display a list of available devices. 537.It Ic match Ar type , Ns Ar if , Ns Ar pass Op | Ar ... 538Display devices matching the given pattern. 539The basic matching expressions are the same as those used in 540.Xr iostat 8 541with one difference. 542Instead of specifying multiple 543.Fl t 544arguments which are then ORed together, the user instead specifies multiple 545matching expressions joined by the pipe 546.Pq Ql \&| 547character. 548The comma separated arguments within each matching expression are ANDed 549together, and then the pipe separated matching expressions are ORed together. 550Any device matching the combined expression will be displayed, 551if there is room to display it. 552For example: 553.Pp 554.Dl match da,scsi | cd,ide 555.Pp 556This will display all 557.Tn SCSI 558Direct Access devices and all 559.Tn IDE CDROM 560devices. 561.Pp 562.Dl match da | sa | cd,pass 563.Pp 564This will display all Direct Access devices, all Sequential Access devices, 565and all passthrough devices that provide access to 566.Tn CDROM 567drives. 568.El 569.Sh FILES 570.Bl -tag -width /etc/networks -compact 571.It Pa /boot/kernel 572For the namelist. 573.It Pa /dev/kmem 574For information in main memory. 575.It Pa /etc/hosts 576For host names. 577.It Pa /etc/networks 578For network names. 579.It Pa /etc/services 580For port names. 581.El 582.Sh SEE ALSO 583.Xr netstat 1 , 584.Xr kvm 3 , 585.Xr icmp 4 , 586.Xr icmp6 4 , 587.Xr ip 4 , 588.Xr ip6 4 , 589.Xr tcp 4 , 590.Xr udp 4 , 591.Xr iostat 8 , 592.Xr sysctl 8 , 593.Xr vmstat 8 594.Sh HISTORY 595The 596.Nm 597program appeared in 598.Bx 4.3 . 599The 600.Ic icmp , 601.Ic ip , 602and 603.Ic tcp 604displays appeared in 605.Fx 3.0 ; 606the notion of having different display modes for the 607.Tn ICMP , 608.Tn IP , 609.Tn TCP , 610and 611.Tn UDP 612statistics was stolen from the 613.Fl C 614option to 615.Xr netstat 1 616in Silicon Graphics' 617.Tn IRIX 618system. 619.Sh BUGS 620Certain displays presume a minimum of 80 characters per line. 621The 622.Ic vmstat 623display looks out of place because it is (it was added in as 624a separate display rather than created as a new program). 625