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