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.\" 4. 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$ 30.\" 31.Dd October 14, 2007 32.Dt SYSTAT 1 33.Os 34.Sh NAME 35.Nm systat 36.Nd display system statistics 37.Sh SYNOPSIS 38.Nm 39.Op Fl display 40.Op Ar refresh-interval 41.Sh DESCRIPTION 42The 43.Nm 44utility displays various system statistics in a screen oriented fashion 45using the curses screen display library, 46.Xr ncurses 3 . 47.Pp 48While 49.Nm 50is running the screen is usually divided into two windows (an exception 51is the vmstat display which uses the entire screen). 52The 53upper window depicts the current system load average. 54The 55information displayed in the lower window may vary, depending on 56user commands. 57The last line on the screen is reserved for user 58input and error messages. 59.Pp 60By default 61.Nm 62displays the processes getting the largest percentage of the processor 63in the lower window. 64Other displays show swap space usage, disk 65.Tn I/O 66statistics (a la 67.Xr iostat 8 ) , 68virtual memory statistics (a la 69.Xr vmstat 8 ) , 70network ``mbuf'' utilization, 71.Tn TCP/IP 72statistics, 73and network connections (a la 74.Xr netstat 1 ) . 75.Pp 76Input is interpreted at two different levels. 77A ``global'' command interpreter processes all keyboard input. 78If this command interpreter fails to recognize a command, the 79input line is passed to a per-display command interpreter. 80This 81allows each display to have certain display-specific commands. 82.Pp 83Command line options: 84.Bl -tag -width "refresh_interval" 85.It Fl Ns Ar display 86The 87.Fl 88flag expects 89.Ar display 90to be one of: 91.Ic icmp , 92.Ic icmp6 , 93.Ic ifstat , 94.Ic iostat , 95.Ic ip , 96.Ic ip6 , 97.Ic mbufs , 98.Ic netstat , 99.Ic pigs , 100.Ic swap , 101.Ic tcp , 102or 103.Ic vmstat . 104These displays can also be requested interactively (without the 105.Dq Fl ) 106and are described in 107full detail below. 108.It Ar refresh-interval 109The 110.Ar refresh-value 111specifies the screen refresh time interval in seconds. 112.El 113.Pp 114Certain characters cause immediate action by 115.Nm . 116These are 117.Bl -tag -width Fl 118.It Ic \&^L 119Refresh the screen. 120.It Ic \&^G 121Print the name of the current ``display'' being shown in 122the lower window and the refresh interval. 123.It Ic \&: 124Move the cursor to the command line and interpret the input 125line typed as a command. 126While entering a command the 127current character erase, word erase, and line kill characters 128may be used. 129.El 130.Pp 131The following commands are interpreted by the ``global'' 132command 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 138on the command line. 139.It Ic stop 140Stop refreshing the screen. 141.It Xo 142.Op Ic start 143.Op Ar number 144.Xc 145Start (continue) refreshing the screen. 146If a second, numeric, 147argument is provided it is interpreted as a refresh interval 148(in seconds). 149Supplying only a number will set the refresh interval to this 150value. 151.It Ic quit 152Exit 153.Nm . 154(This may be abbreviated to 155.Ic q . ) 156.El 157.Pp 158The available displays are: 159.Bl -tag -width Ic 160.It Ic pigs 161Display, in the lower window, those processes resident in main 162memory and getting the 163largest portion of the processor (the default display). 164When less than 100% of the 165processor is scheduled to user processes, the remaining time 166is accounted to the ``idle'' process. 167.It Ic icmp 168Display, in the lower window, statistics about messages received and 169transmitted by the Internet Control Message Protocol 170.Pq Dq Tn ICMP . 171The left half of the screen displays information about received 172packets, and the right half displays information regarding transmitted 173packets. 174.Pp 175The 176.Ic icmp 177display understands two commands: 178.Ic mode 179and 180.Ic reset . 181The 182.Ic mode 183command is used to select one of four display modes, given as its argument: 184.Bl -tag -width absoluteXX -compact 185.It Ic rate : 186show the rate of change of each value in packets (the default) 187per second 188.It Ic delta : 189show the rate of change of each value in packets per refresh interval 190.It Ic since : 191show the total change of each value since the display was last reset 192.It Ic absolute : 193show the absolute value of each statistic 194.El 195.Pp 196The 197.Ic reset 198command resets the baseline for 199.Ic since 200mode. 201The 202.Ic mode 203command with no argument will display the current mode in the command 204line. 205.It Ic icmp6 206This display is like the 207.Ic icmp 208display, 209but displays statistics for IPv6 ICMP. 210.It Ic ip 211Otherwise identical to the 212.Ic icmp 213display, except that it displays 214.Tn IP 215and 216.Tn UDP 217statistics. 218.It Ic ip6 219Like the 220.Ic ip 221display, 222except that it displays 223.Tn IPv6 224statistics. 225It does not display 226.Tn UDP statistics. 227.It Ic tcp 228Like 229.Ic icmp , 230but with 231.Tn TCP 232statistics. 233.It Ic iostat 234Display, in the lower window, statistics about processor use 235and disk throughput. 236Statistics on processor use appear as 237bar graphs of the amount of time executing in user mode (``user''), 238in user mode running low priority processes (``nice''), in 239system mode (``system''), in interrupt mode (``interrupt''), 240and idle (``idle''). 241Statistics 242on disk throughput show, for each drive, megabytes per second, 243average number of disk transactions per second, and 244average kilobytes of data per transaction. 245This information may be 246displayed as bar graphs or as rows of numbers which scroll downward. 247Bar 248graphs are shown by default. 249.Pp 250The following commands are specific to the 251.Ic iostat 252display; the minimum unambiguous prefix may be supplied. 253.Pp 254.Bl -tag -width Fl -compact 255.It Cm numbers 256Show the disk 257.Tn I/O 258statistics in numeric form. 259Values are 260displayed in numeric columns which scroll downward. 261.It Cm bars 262Show the disk 263.Tn I/O 264statistics in bar graph form (default). 265.It Cm kbpt 266Toggle the display of kilobytes per transaction. 267(the default is to 268not display kilobytes per transaction). 269.El 270.It Ic swap 271Show information about swap space usage on all the 272swap areas compiled into the kernel. 273The first column is the device name of the partition. 274The next column is the total space available in the partition. 275The 276.Ar Used 277column indicates the total blocks used so far; 278the graph shows the percentage of space in use on each partition. 279If there are more than one swap partition in use, 280a total line is also shown. 281Areas known to the kernel, but not in use are shown as not available. 282.It Ic mbufs 283Display, in the lower window, the number of mbufs allocated 284for particular uses, i.e., data, socket structures, etc. 285.It Ic vmstat 286Take over the entire display and show a (rather crowded) compendium 287of statistics related to virtual memory usage, process scheduling, 288device interrupts, system name translation caching, disk 289.Tn I/O 290etc. 291.Pp 292The upper left quadrant of the screen shows the number 293of users logged in and the load average over the last one, five, 294and fifteen minute intervals. 295Below this line are statistics on memory utilization. 296The first row of the table reports memory usage only among 297active processes, that is processes that have run in the previous 298twenty seconds. 299The second row reports on memory usage of all processes. 300The first column reports on the number of kilobytes in physical pages 301claimed by processes. 302The second column reports the number of kilobytes in physical pages that 303are devoted to read only text pages. 304The third and fourth columns report the same two figures for 305virtual pages, that is the number of kilobytes in pages that would be 306needed if all processes had all of their pages. 307Finally the last column shows the number of kilobytes in physical pages 308on the free list. 309.Pp 310Below the memory display is a list of the 311average number of processes (over the last refresh interval) 312that are runnable (`r'), in page wait (`p'), 313in disk wait other than paging (`d'), 314sleeping (`s'), and swapped out but desiring to run (`w'). 315The row also shows the average number of context switches 316(`Csw'), traps (`Trp'; includes page faults), system calls (`Sys'), 317interrupts (`Int'), network software interrupts (`Sof'), and page 318faults (`Flt'). 319.Pp 320Below the process queue length listing is a numerical listing and 321a bar graph showing the amount of 322system (shown as `='), interrupt (shown as `+'), user (shown as `>'), 323nice (shown as `-'), and idle time (shown as ` '). 324.Pp 325Below the process display are statistics on name translations. 326It lists the number of names translated in the previous interval, 327the number and percentage of the translations that were 328handled by the system wide name translation cache, and 329the number and percentage of the translations that were 330handled by the per process name translation cache. 331.Pp 332To the right of the name translations display are lines showing 333the number of dirty buffers in the buffer cache (`dtbuf'), 334desired maximum size of vnode cache (`desvn'), 335number of vnodes actually allocated (`numvn'), 336and 337number of allocated vnodes that are free (`frevn'). 338.Pp 339At the bottom left is the disk usage display. 340It reports the number of 341kilobytes per transaction, transactions per second, megabytes 342per second and the percentage of the time the disk was busy averaged 343over the refresh period of the display (by default, five seconds). 344The system keeps statistics on most every storage device. 345In general, up 346to seven devices are displayed. 347The devices displayed by default are the 348first devices in the kernel's device list. 349See 350.Xr devstat 3 351and 352.Xr devstat 9 353for details on the devstat system. 354.Pp 355Under the date in the upper right hand quadrant are statistics 356on paging and swapping activity. 357The first two columns report the average number of pages 358brought in and out per second over the last refresh interval 359due to page faults and the paging daemon. 360The third and fourth columns report the average number of pages 361brought in and out per second over the last refresh interval 362due to swap requests initiated by the scheduler. 363The first row of the display shows the average 364number of disk transfers per second over the last refresh interval; 365the second row of the display shows the average 366number of pages transferred per second over the last refresh interval. 367.Pp 368Below the paging statistics is a column of lines regarding the virtual 369memory system. 370The first few lines describe, 371in units (except as noted below) 372of pages per second averaged over the sampling interval, 373pages copied on write (`cow'), 374pages zero filled on demand (`zfod'), 375pages optimally zero filled on demand (`ozfod'), 376the ratio of the (average) ozfod / zfod as a percentage (`%ozfod'), 377pages freed by the page daemon (`daefr'), 378pages freed by exiting processes (`prcfr'), 379total pages freed (`totfr'), 380pages reactivated from the free list (`react'), 381the average number of 382times per second that the page daemon was awakened (`pdwak'), 383pages analyzed by the page daemon (`pdpgs'), 384and 385in-transit blocking page faults (`intrn'). 386Note that the units are special for `%ozfod' and `pdwak'. 387The next few lines describe, 388as amounts of memory in kilobytes, 389pages wired down (`wire'), 390active pages (`act'), 391inactive pages (`inact'), 392pages on the cache queue (`cache'), 393and 394free pages (`free'). 395Note that the values displayed are the current transient ones; 396they are not averages. 397.Pp 398At the bottom of this column is a line showing the 399amount of virtual memory, in kilobytes, mapped into the buffer cache (`buf'). 400This statistic is not useful. 401It exists only as a placeholder for the corresponding useful statistic 402(the amount of real memory used to cache disks). 403The most important component of the latter (the amount of real memory 404used by the vm system to cache disks) is not available, 405but can be guessed from the `inact' amount under some system loads. 406.Pp 407Running down the right hand side of the display is a breakdown 408of the interrupts being handled by the system. 409At the top of the list is the total interrupts per second 410over the time interval. 411The rest of the column breaks down the total on a device 412by device basis. 413Only devices that have interrupted at least once since boot time are shown. 414.Pp 415The following commands are specific to the 416.Ic vmstat 417display; the minimum unambiguous prefix may be supplied. 418.Pp 419.Bl -tag -width Ar -compact 420.It Cm boot 421Display cumulative statistics since the system was booted. 422.It Cm run 423Display statistics as a running total from the point this 424command is given. 425.It Cm time 426Display statistics averaged over the refresh interval (the default). 427.It Cm zero 428Reset running statistics to zero. 429.El 430.It Ic netstat 431Display, in the lower window, network connections. 432By default, 433network servers awaiting requests are not displayed. 434Each address 435is displayed in the format ``host.port'', with each shown symbolically, 436when possible. 437It is possible to have addresses displayed numerically, 438limit the display to a set of ports, hosts, and/or protocols 439(the minimum unambiguous prefix may be supplied): 440.Pp 441.Bl -tag -width Ar -compact 442.It Cm all 443Toggle the displaying of server processes awaiting requests (this 444is the equivalent of the 445.Fl a 446flag to 447.Xr netstat 1 ) . 448.It Cm numbers 449Display network addresses numerically. 450.It Cm names 451Display network addresses symbolically. 452.It Cm proto Ar protocol 453Display only network connections using the indicated 454.Ar protocol . 455Supported protocols are ``tcp'', ``udp'', and ``all''. 456.It Cm ignore Op Ar items 457Do not display information about connections associated with 458the specified hosts or ports. 459Hosts and ports may be specified 460by name (``vangogh'', ``ftp''), or numerically. 461Host addresses 462use the Internet dot notation (``128.32.0.9''). 463Multiple items 464may be specified with a single command by separating them with 465spaces. 466.It Cm display Op Ar items 467Display information about the connections associated with the 468specified hosts or ports. 469As for 470.Ar ignore , 471.Op Ar items 472may be names or numbers. 473.It Cm show Op Ar ports\&|hosts 474Show, on the command line, the currently selected protocols, 475hosts, and ports. 476Hosts and ports which are being ignored 477are prefixed with a `!'. 478If 479.Ar ports 480or 481.Ar hosts 482is supplied as an argument to 483.Cm show , 484then only the requested information will be displayed. 485.It Cm reset 486Reset the port, host, and protocol matching mechanisms to the default 487(any protocol, port, or host). 488.El 489.It Ic ifstat 490Display the network traffic going through active interfaces on the 491system. 492Idle interfaces will not be displayed until they receive some 493traffic. 494.Pp 495For each interface being displayed, the current, peak and total 496statistics are displayed for incoming and outgoing traffic. 497By default, 498the 499.Ic ifstat 500display will automatically scale the units being used so that they are 501in a human-readable format. 502The scaling units used for the current and 503peak 504traffic columns can be altered by the 505.Ic scale 506command. 507.Bl -tag -width ".Cm scale Op Ar units" 508.It Cm scale Op Ar units 509Modify the scale used to display the current and peak traffic over all 510interfaces. 511The following units are recognised: kbit, kbyte, mbit, 512mbyte, gbit, gbyte and auto. 513.El 514.El 515.Pp 516Commands to switch between displays may be abbreviated to the 517minimum unambiguous prefix; for example, ``io'' for ``iostat''. 518Certain information may be discarded when the screen size is 519insufficient for display. 520For example, on a machine with 10 521drives the 522.Ic iostat 523bar graph displays only 3 drives on a 24 line terminal. 524When 525a bar graph would overflow the allotted screen space it is 526truncated and the actual value is printed ``over top'' of the bar. 527.Pp 528The following commands are common to each display which shows 529information about disk drives. 530These commands are used to 531select a set of drives to report on, should your system have 532more drives configured than can normally be displayed on the 533screen. 534.Pp 535.Bl -tag -width Ar -compact 536.It Cm ignore Op Ar drives 537Do not display information about the drives indicated. 538Multiple 539drives may be specified, separated by spaces. 540.It Cm display Op Ar drives 541Display information about the drives indicated. 542Multiple drives 543may be specified, separated by spaces. 544.It Cm only Op Ar drives 545Display only the specified drives. 546Multiple drives may be specified, 547separated by spaces. 548.It Cm drives 549Display a list of available devices. 550.It Cm match Xo 551.Ar type , Ns Ar if , Ns Ar pass 552.Op | Ar ... 553.Xc 554Display devices matching the given pattern. 555The basic matching 556expressions are the same as those used in 557.Xr iostat 8 558with one difference. 559Instead of specifying multiple 560.Fl t 561arguments which are then ORed together, the user instead specifies multiple 562matching expressions joined by the pipe 563.Pq Ql \&| 564character. 565The comma 566separated arguments within each matching expression are ANDed together, and 567then the pipe separated matching expressions are ORed together. 568Any 569device matching the combined expression will be displayed, if there is room 570to display it. 571For example: 572.Pp 573.Dl match da,scsi | cd,ide 574.Pp 575This will display all SCSI Direct Access devices and all IDE CDROM devices. 576.Pp 577.Dl match da | sa | cd,pass 578.Pp 579This will display all Direct Access devices, all Sequential Access devices, 580and all passthrough devices that provide access to CDROM drives. 581.El 582.Sh FILES 583.Bl -tag -width /boot/kernel/kernel -compact 584.It Pa /boot/kernel/kernel 585For the namelist. 586.It Pa /dev/kmem 587For information in main memory. 588.It Pa /etc/hosts 589For host names. 590.It Pa /etc/networks 591For network names. 592.It Pa /etc/services 593For port names. 594.El 595.Sh SEE ALSO 596.Xr netstat 1 , 597.Xr kvm 3 , 598.Xr icmp 4 , 599.Xr icmp6 4 , 600.Xr ip 4 , 601.Xr ip6 4 , 602.Xr tcp 4 , 603.Xr udp 4 , 604.Xr gstat 8 , 605.Xr iostat 8 , 606.Xr vmstat 8 607.Sh HISTORY 608The 609.Nm 610program appeared in 611.Bx 4.3 . 612The 613.Ic icmp , 614.Ic ip , 615and 616.Ic tcp 617displays appeared in 618.Fx 3.0 ; 619the notion of having different display modes for the 620.Tn ICMP , 621.Tn IP , 622.Tn TCP , 623and 624.Tn UDP 625statistics was stolen from the 626.Fl C 627option to 628.Xr netstat 1 629in Silicon Graphics' 630.Tn IRIX 631system. 632.Sh BUGS 633Certain displays presume a minimum of 80 characters per line. 634The 635.Ic vmstat 636display looks out of place because it is (it was added in as 637a separate display rather than created as a new program). 638