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