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