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 May 24, 2015 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.Pp 265The following commands are specific to the 266.Ic sensors 267display; the minimum unambiguous prefix may be supplied. 268.Pp 269.Bl -tag -width Fl -compact 270.It Ic type Op Ar type ... 271Display only the sensors which match the specified 272.Ar type . 273Multiple types may be specified, 274separated by spaces. 275If no types are specified, 276all available sensors will be displayed. 277Supported values of 278.Ar type 279are 280.Cm temp , 281.Cm fan , 282.Cm volt , 283.Cm acvolt , 284.Cm resistance , 285.Cm power , 286.Cm current , 287.Cm watthour , 288.Cm amphour , 289.Cm indicator , 290.Cm raw , 291.Cm percent , 292.Cm illuminance , 293.Cm drive , 294.Cm timedelta , 295and 296.Cm ecc . 297.It Ic match Op Ar device ... 298Display only the sensors match the specified 299.Ar device . 300Multiple devices may be specified, 301separated by spaces. 302If no devices are specified, 303all available sensors will be displayed. 304A device type could be specified by using 305an asterisk 306.Pq Sq Li * 307in the place of the device unit. 308For example: 309.Pp 310.Dl match cpu* 311.El 312.It Ic swap 313Show information about swap space usage on all the 314swap areas compiled into the kernel. 315The first column is the device name of the partition. 316The next column is the total space available in the partition. 317The ``Used'' column indicates the total blocks used so far; 318the graph shows the percentage of space in use on each partition. 319If there are more than one swap partition in use, 320a total line is also shown. 321Areas known to the kernel, but not in use are shown as not available. 322.It Ic mbufs 323Display, in the lower window, the number of mbufs allocated 324for particular uses, i.e.\& data, socket structures, etc. 325.It Ic vmstat 326Take over the entire display and show a (rather crowded) compendium 327of statistics related to virtual memory usage, process scheduling, 328device interrupts, system name translation cacheing, disk 329.Tn I/O 330etc. 331.Pp 332The upper left quadrant of the screen shows the number 333of users logged in and the load average over the last one, five, 334and fifteen minute intervals. 335.Pp 336Below this line are statistics on memory utilization. 337The first row (`Act') reports memory usage only among active processes, 338that is processes that have run in the previous twenty seconds. 339The second row (`All') reports on memory usage of all processes. 340Two groups of columns are shown, `REAL' and `VIRTUAL'. 341The first column (`Tot') reports on the number of 342physical pages claimed by processes. 343The second column (`Share') reports the number of 344physical pages that are devoted to read only text pages. 345The third and fourth columns report the same two figures for 346virtual pages, that is the number of pages that would be 347needed if all processes had all of their pages. 348Finally the last column (`Free') shows the number of 349physical pages on the free list. 350.Pp 351Below the memory display is a list of the 352average number of processes (over the last refresh interval) 353that are runnable (`r'), in page wait (`p'), 354in disk wait other than paging (`d'), 355sleeping (`s'), and swapped out but desiring to run (`w'). 356The row also shows the average number of context switches (`Csw'), 357traps (`Trp'; includes page faults), system calls (`Sys'), interrupts (`Int'), 358network software interrupts (`Sof'), and page faults (`Flt'). 359.Pp 360Below the process queue length listing is a listing of 361.Tn CPU 362usage, a numerical listing and a bar graph showing the amount of 363system (`='), interrupt (`+'), user (`>'), nice (`-'), and idle time (` '). 364.Pp 365Below the 366.Tn CPU 367usage display are statistics on name translations. 368It lists the number of path names translated 369in the previous interval (`Path-lookups'), 370the number and percentage of the path lookups that were 371handled by the name translation cache, and 372the average number of path components in path lookups (`Components'). 373.Pp 374At the bottom left is the disk usage display. 375It reports the number of 376kilobytes per transaction (`KB/t'), 377read transactions per second (`tpr/s'), 378megabytes per second in read transaction (`MBr/s'), 379write transactions per second (`tpw/s'), 380megabytes per second in write transaction (`MBw/s') and 381the percentage of the time the disk was busy (`% busy') averaged 382over the refresh period of the display (by default, five seconds). 383The system keeps statistics on most every storage device. 384In general, up to seven devices are displayed. 385The devices displayed by default are the 386first devices in the kernel's device list. 387See 388.Xr devstat 3 389and 390.Xr devstat 9 391for details on the devstat system. 392.Pp 393If at most 4 disk devices are shown, 394extended virtual memory statistics are shown right to disk usage: 395pages zero filled on demand (`zfod'), 396pages optimized zero filled on demand (`ozfod'), 397slow (i.e.\& non-optimized) zero fills percentage (`%sloz'), 398total pages freed (`tfree'). 399.Pp 400Under the date in the upper right hand quadrant are statistics 401on paging and swapping activity. 402The first two columns (`VN PAGER') report the average number of pages 403brought in and out per second over the last refresh interval 404due to page faults and the paging daemon. 405The third and fourth columns (`SWAP PAGER') report the average number of pages 406brought in and out per second over the last refresh interval 407due to swap requests initiated by the scheduler. 408The first row (`count') of the display shows the average 409number of disk transfers per second over the last refresh interval; 410the second row (`pages') of the display shows the average 411number of pages transferred per second over the last refresh interval. 412.Pp 413Below the paging statistics is a column of lines regarding the virtual 414memory system which list the average number of 415pages zero filled on demand (`zfod') 416(shown with extended virtual memory statistics if screen space permits), 417pages copied on write (`cow'), 418pages wired down (`wire'), 419active pages (`act'), 420inactive pages (`inact'), 421pages on the buffer cache queue (`cache'), 422number of free pages (`free'), 423pages freed by the page daemon (`daefr'), 424pages freed by exiting processes (`prcfr'), 425pages reactivated from the free list (`react'), 426times the page daemon was awakened (`pdwak'), 427pages analyzed by the page daemon (`pdpgs'), 428and 429intransit blocking page faults (`intrn') 430per second over the refresh interval. 431.Pp 432At the bottom of this column are lines showing the 433amount of memory, in kilobytes, used for the buffer cache (`buf'), 434the number of dirty buffers in the buffer cache (`dirtybuf'), 435desired maximum size of vnode cache (`desiredvnodes') 436(mostly unused, except to size the name cache), 437number of vnodes actually allocated (`numvnodes'), 438and 439number of allocated vnodes that are free (`freevnodes'). 440.Pp 441Running down the right hand side of the display is a breakdown 442of the interrupts being handled by the system (`Interrupts'). 443At the top of the list is the total interrupts per second 444over the time interval (`total'). 445The rest of the column breaks down the total on a device by device basis. 446Only devices that have interrupted at least once since boot time are shown. 447.Pp 448The following commands are specific to the 449.Ic vmstat 450display; the minimum unambiguous prefix may be supplied. 451.Pp 452.Bl -tag -width Ar -compact 453.It Ic boot 454Display cumulative statistics since the system was booted. 455.It Ic run 456Display statistics as a running total from the point this command is given. 457.It Ic time 458Display statistics averaged over the refresh interval (the default). 459.It Ic want_fd 460Toggle the display of fd devices in the disk usage display. 461.It Ic zero 462Reset running statistics to zero. 463.El 464.It Ic pvmmeter 465Display per 466.Tn CPU 467statistics, including 468.Tn LAPIC 469timer interrupts (`timer'), 470.Tn IPIs 471(Inter-Processor Interrupts) (`ipi'), 472external interrupts (i.e.\& not timer or ipi) (`extint'), and 473.Tn CPU 474time breakdown (`user%', `nice%', `sys%', `intr%', and `idle%'). 475.It Ic netstat 476Display, in the lower window, network connections. 477By default, network servers awaiting requests are not displayed. 478Each address is displayed in the format ``host.port'', 479with each shown symbolically, when possible. 480It is possible to have addresses displayed numerically, 481limit the display to a set of ports, hosts, and/or protocols 482(the minimum unambiguous prefix may be supplied): 483.Pp 484.Bl -tag -width Ar -compact 485.It Ic all 486Toggle the displaying of server processes awaiting requests (this 487is the equivalent of the 488.Fl a 489flag to 490.Xr netstat 1 ) . 491.It Ic numbers 492Display network addresses numerically. 493.It Ic names 494Display network addresses symbolically. 495.It Ic proto Ar protocol 496Display only network connections using the indicated 497.Ar protocol . 498Supported protocols are 499.Cm tcp , 500.Cm udp , 501and 502.Cm all . 503.It Ic ignore Op Ar items 504Do not display information about connections associated with 505the specified hosts or ports. 506Hosts and ports may be specified 507by name (``vangogh'', ``ftp''), or numerically. 508Host addresses use the Internet dot notation (``128.32.0.9''). 509Multiple items 510may be specified with a single command by separating them with spaces. 511.It Ic display Op Ar items 512Display information about the connections associated with the 513specified hosts or ports. 514As for 515.Ic ignore , 516.Ar items 517may be names or numbers. 518.It Ic show Op Cm ports | hosts 519Show, on the command line, the currently selected protocols, hosts, and ports. 520Hosts and ports which are being ignored are prefixed with a `!'. 521If 522.Cm ports 523or 524.Cm hosts 525is supplied as an argument to 526.Ic show , 527then only the requested information will be displayed. 528.It Ic reset 529Reset the port, host, and protocol matching mechanisms to the default 530(any protocol, port, or host). 531.El 532.It Ic netbw 533Display aggregate and per-connection tcp receive and transmit rates. 534Only active tcp connections originated or terminated by the host 535are shown. 536.It Ic pftop 537Display packet filter (pf) state information for states which are 538actively passing data. This requires pf to be active to be meaningful 539but is capable of displaying connection state for all packet traffic 540passing through the machine, even for connections that do not originate 541or terminate on the machine. 542.Pp 543You need a wide ~100 column window to display pftop reasonably well. 544IPV6 addresses are truncated (just the first two and last two words 545are displayed) for brevity. Generally speaking 'rcv' is data received 546by the first IP and 'snd' is data sent to the second IP. 'ttl' is 547the sum total data sent plus received tracked by the state. 548.Pp 549The display is sorted by average rx+tx bandwidth calculated on a 1/8 decay 550curve to prevent fields from jumping around too much. Units for all rows 551are selected based on the largest bandwidth measurement for uniformity. 552Note that two states will be present for any connection operating over NAT. 553.It Ic altq 554Display packet filter altq statistics. 555The ALTQ operates in conjunction with the packet filter (pf) on the 556interface's transmit path. 557Packet rate, data rate in bytes per interval, drop rate, and queue 558length is displayed in three separate sections in a convenient 559INTERFACE-by-ALTQLABEL matrix. 560.Pp 561To save space drops 562and queue length are combined in the third section. 563If packet drops are present, drops 564will be displayed, otherwise the packet queue length with a 'Q' suffix 565will be displayed. 566.El 567.Pp 568Commands to switch between displays may be abbreviated to the 569minimum unambiguous prefix; for example, ``io'' for ``iostat''. 570Certain information may be discarded when the screen size is 571insufficient for display. 572For example, on a machine with 10 drives the 573.Ic iostat 574bar graph displays only 3 drives on a 24 line terminal. 575When a bar graph would overflow the allotted screen space it is 576truncated and the actual value is printed ``over top'' of the bar. 577.Pp 578The following commands are common to each display which shows 579information about disk drives. 580These commands are used to 581select a set of drives to report on, should your system have 582more drives configured than can normally be displayed on the screen. 583.Pp 584.Bl -tag -width Ar -compact 585.It Ic ignore Op Ar drives 586Do not display information about the drives indicated. 587Multiple drives may be specified, separated by spaces. 588.It Ic display Op Ar drives 589Display information about the drives indicated. 590Multiple drives may be specified, separated by spaces. 591.It Ic only Op Ar drives 592Display only the specified drives. 593Multiple drives may be specified, separated by spaces. 594.It Ic drives 595Display a list of available devices. 596.It Ic match Ar type , Ns Ar if , Ns Ar pass Op | Ar ... 597Display devices matching the given pattern. 598The basic matching expressions are the same as those used in 599.Xr iostat 8 600with one difference. 601Instead of specifying multiple 602.Fl t 603arguments which are then ORed together, the user instead specifies multiple 604matching expressions joined by the pipe 605.Pq Ql \&| 606character. 607The comma separated arguments within each matching expression are ANDed 608together, and then the pipe separated matching expressions are ORed together. 609Any device matching the combined expression will be displayed, 610if there is room to display it. 611For example: 612.Pp 613.Dl match da,scsi | cd,ide 614.Pp 615This will display all 616.Tn SCSI 617Direct Access devices and all 618.Tn IDE CDROM 619devices. 620.Pp 621.Dl match da | sa | cd,pass 622.Pp 623This will display all Direct Access devices, all Sequential Access devices, 624and all passthrough devices that provide access to 625.Tn CDROM 626drives. 627.El 628.Sh FILES 629.Bl -tag -width /etc/networks -compact 630.It Pa /boot/kernel 631For the namelist. 632.It Pa /dev/kmem 633For information in main memory. 634.It Pa /etc/hosts 635For host names. 636.It Pa /etc/networks 637For network names. 638.It Pa /etc/services 639For port names. 640.El 641.Sh SEE ALSO 642.Xr netstat 1 , 643.Xr kvm 3 , 644.Xr icmp 4 , 645.Xr icmp6 4 , 646.Xr ip 4 , 647.Xr ip6 4 , 648.Xr tcp 4 , 649.Xr udp 4 , 650.Xr iostat 8 , 651.Xr sysctl 8 , 652.Xr vmstat 8 653.Sh HISTORY 654The 655.Nm 656program appeared in 657.Bx 4.3 . 658The 659.Ic icmp , 660.Ic ip , 661and 662.Ic tcp 663displays appeared in 664.Fx 3.0 ; 665the notion of having different display modes for the 666.Tn ICMP , 667.Tn IP , 668.Tn TCP , 669and 670.Tn UDP 671statistics was stolen from the 672.Fl C 673option to 674.Xr netstat 1 675in Silicon Graphics' 676.Tn IRIX 677system. 678.Sh BUGS 679Certain displays presume a minimum of 80 characters per line. 680The 681.Ic vmstat 682display looks out of place because it is (it was added in as 683a separate display rather than created as a new program). 684