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