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