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.\" 34.Dd September 9, 1997 35.Dt SYSTAT 1 36.Os BSD 4.3 37.Sh NAME 38.Nm systat 39.Nd display system statistics on a crt 40.Sh SYNOPSIS 41.Nm 42.Op Fl display 43.Op Ar refresh-interval 44.Sh DESCRIPTION 45.Nm Systat 46displays various system statistics in a screen oriented fashion 47using the curses screen display library, 48.Xr curses 3 . 49.Pp 50While 51.Nm 52is running the screen is usually divided into two windows (an exception 53is the vmstat display which uses the entire screen). The 54upper window depicts the current system load average. The 55information displayed in the lower window may vary, depending on 56user commands. The last line on the screen is reserved for user 57input and error messages. 58.Pp 59By default 60.Nm 61displays the processes getting the largest percentage of the processor 62in the lower window. Other 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. This 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 iostat , 90.Ic ip , 91.Ic mbufs , 92.Ic netstat , 93.Ic pigs , 94.Ic swap , 95.Ic tcp , 96or 97.Ic vmstat . 98These displays can also be requested interactively (without the 99.Dq Fl ) 100and are described in 101full detail below. 102.It Ar refresh-interval 103The 104.Ar refresh-value 105specifies the screen refresh time interval in seconds. 106.El 107.Pp 108Certain characters cause immediate action by 109.Nm systat . 110These are 111.Bl -tag -width Fl 112.It Ic \&^L 113Refresh the screen. 114.It Ic \&^G 115Print the name of the current ``display'' being shown in 116the lower window and the refresh interval. 117.It Ic \&^Z 118Stop 119.Nm systat . 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 systat . 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, kilobytes of data transferred, 221number of disk transactions performed, and average seek time 222(in milliseconds). This information may be displayed as 223bar 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 msps 241Toggle the display of average seek time (the default is to 242not display seek times). 243.El 244.It Ic swap 245Show information about swap space usage on all the 246swap areas compiled into the kernel. 247The first column is the device name of the partition. 248The next column is the total space available in the partition. 249The 250.Ar Used 251column indicates the total blocks used so far; 252the graph shows the percentage of space in use on each partition. 253If there are more than one swap partition in use, 254a total line is also shown. 255Areas known to the kernel, but not in use are shown as not available. 256.It Ic mbufs 257Display, in the lower window, the number of mbufs allocated 258for particular uses, i.e. data, socket structures, etc. 259.It Ic vmstat 260Take over the entire display and show a (rather crowded) compendium 261of statistics related to virtual memory usage, process scheduling, 262device interrupts, system name translation cacheing, disk 263.Tn I/O 264etc. 265.Pp 266The upper left quadrant of the screen shows the number 267of users logged in and the load average over the last one, five, 268and fifteen minute intervals. 269Below this line are statistics on memory utilization. 270The first row of the table reports memory usage only among 271active processes, that is processes that have run in the previous 272twenty seconds. 273The second row reports on memory usage of all processes. 274The first column reports on the number of physical pages 275claimed by processes. 276The second column reports the number of physical pages that 277are devoted to read only text pages. 278The third and fourth columns report the same two figures for 279virtual pages, that is the number of pages that would be 280needed if all processes had all of their pages. 281Finally the last column shows the number of physical pages 282on the free list. 283.Pp 284Below the memory display is a list of the 285average number of processes (over the last refresh interval) 286that are runnable (`r'), in page wait (`p'), 287in disk wait other than paging (`d'), 288sleeping (`s'), and swapped out but desiring to run (`w'). 289Below the queue length listing is a numerical listing and 290a bar graph showing the amount of 291system (shown as `='), interrupt (shown as `+'), user (shown as `>'), 292nice (shown as `-'), and idle time (shown as ` '). 293.Pp 294Below the process display are statistics on name translations. 295It lists the number of names translated in the previous interval, 296the number and percentage of the translations that were 297handled by the system wide name translation cache, and 298the number and percentage of the translations that were 299handled by the per process name translation cache. 300.Pp 301At the bottom left is the disk usage display. 302It reports the number of seeks, transfers, and number 303of kilobyte blocks transferred per second averaged over the 304refresh period of the display (by default, five seconds). 305For some disks it also reports the average milliseconds per seek. 306Note that the system only keeps statistics on at most eight disks 307(this is controlled by the constant 308.Dv DK_NDRIVE 309in 310.Aq Pa sys/dkstat.h 311as a kernel compile-time constant). 312.Pp 313Under the date in the upper right hand quadrant are statistics 314on paging and swapping activity. 315The first two columns report the average number of pages 316brought in and out per second over the last refresh interval 317due to page faults and the paging daemon. 318The third and fourth columns report the average number of pages 319brought in and out per second over the last refresh interval 320due to swap requests initiated by the scheduler. 321The first row of the display shows the average 322number of disk transfers per second over the last refresh interval; 323the second row of the display shows the average 324number of pages transferred per second over the last refresh interval. 325.Pp 326Below the paging statistics is a line listing the average number of 327total reclaims ('Rec'), 328intransit blocking page faults (`It'), 329swap text pages found in free list (`F/S'), 330file system text pages found in free list (`F/F'), 331reclaims from free list 332pages freed by the clock daemon (`Fre'), 333and sequential process pages freed (`SFr') 334per second over the refresh interval. 335.Pp 336Below this line are statistics on the average number of 337zero filled pages (`zf') and demand filled text pages (`xf') 338per second over the refresh period. 339The first row indicates the number of requests that were 340resolved, the second row shows the number that were set up, 341and the last row shows the percentage of setup requests that were 342actually used. 343Note that this percentage is usually less than 100%, 344however it may exceed 100% if a large number of requests 345are actually used long after they were set up during a 346period when no new pages are being set up. 347Thus this figure is most interesting when observed over 348a long time period, such as from boot time 349(see below on getting such a display). 350.Pp 351Below the page fill statistics is a column that 352lists the average number of context switches (`Csw'), 353traps (`Trp'; includes page faults), system calls (`Sys'), interrupts (`Int'), 354characters output to DZ ports using 355.No pseudo Ns -DMA 356(`Pdm'), 357network software interrupts (`Sof'), 358page faults (`Flt'), pages scanned by the page daemon (`Scn'), 359and revolutions of the page daemon's hand (`Rev') 360per second over the refresh interval. 361.Pp 362Running down the right hand side of the display is a breakdown 363of the interrupts being handled by the system. 364At the top of the list is the total interrupts per second 365over the time interval. 366The rest of the column breaks down the total on a device 367by device basis. 368Only devices that have interrupted at least once since boot time are shown. 369.Pp 370The following commands are specific to the 371.Ic vmstat 372display; the minimum unambiguous prefix may be supplied. 373.Pp 374.Bl -tag -width Ar -compact 375.It Cm boot 376Display cumulative statistics since the system was booted. 377.It Cm run 378Display statistics as a running total from the point this 379command is given. 380.It Cm time 381Display statistics averaged over the refresh interval (the default). 382.It Cm zero 383Reset running statistics to zero. 384.El 385.It Ic netstat 386Display, in the lower window, network connections. By default, 387network servers awaiting requests are not displayed. Each address 388is displayed in the format ``host.port'', with each shown symbolically, 389when possible. It is possible to have addresses displayed numerically, 390limit the display to a set of ports, hosts, and/or protocols 391(the minimum unambiguous prefix may be supplied): 392.Pp 393.Bl -tag -width Ar -compact 394.It Cm all 395Toggle the displaying of server processes awaiting requests (this 396is the equivalent of the 397.Fl a 398flag to 399.Ar netstat 1 ) . 400.It Cm numbers 401Display network addresses numerically. 402.It Cm names 403Display network addresses symbolically. 404.It Ar protocol 405Display only network connections using the indicated protocol 406(currently either ``tcp'' or ``udp''). 407.It Cm ignore Op Ar items 408Do not display information about connections associated with 409the specified hosts or ports. Hosts and ports may be specified 410by name (``vangogh'', ``ftp''), or numerically. Host addresses 411use the Internet dot notation (``128.32.0.9''). Multiple items 412may be specified with a single command by separating them with 413spaces. 414.It Cm display Op Ar items 415Display information about the connections associated with the 416specified hosts or ports. As for 417.Ar ignore , 418.Op Ar items 419may be names or numbers. 420.It Cm show Op Ar ports\&|hosts 421Show, on the command line, the currently selected protocols, 422hosts, and ports. Hosts and ports which are being ignored 423are prefixed with a `!'. If 424.Ar ports 425or 426.Ar hosts 427is supplied as an argument to 428.Cm show , 429then only the requested information will be displayed. 430.It Cm reset 431Reset the port, host, and protocol matching mechanisms to the default 432(any protocol, port, or host). 433.El 434.El 435.Pp 436Commands to switch between displays may be abbreviated to the 437minimum unambiguous prefix; for example, ``io'' for ``iostat''. 438Certain information may be discarded when the screen size is 439insufficient for display. For example, on a machine with 10 440drives the 441.Ic iostat 442bar graph displays only 3 drives on a 24 line terminal. When 443a bar graph would overflow the allotted screen space it is 444truncated and the actual value is printed ``over top'' of the bar. 445.Pp 446The following commands are common to each display which shows 447information about disk drives. These commands are used to 448select a set of drives to report on, should your system have 449more drives configured than can normally be displayed on the 450screen. 451.Pp 452.Bl -tag -width Tx -compact 453.It Cm ignore Op Ar drives 454Do not display information about the drives indicated. Multiple 455drives may be specified, separated by spaces. 456.It Cm display Op Ar drives 457Display information about the drives indicated. Multiple drives 458may be specified, separated by spaces. 459.El 460.Sh SEE ALSO 461.Xr iostat 1 , 462.Xr netstat 1 , 463.Xr vmstat 1 , 464.Xr icmp 4 , 465.Xr ip 4 , 466.Xr tcp 4 , 467.Xr udp 4 468.Sh FILES 469.Bl -tag -width /etc/networks -compact 470.It Pa /kernel 471For the namelist. 472.It Pa /dev/kmem 473For information in main memory. 474.It Pa /dev/drum 475For information about swapped out processes. 476.It Pa /etc/hosts 477For host names. 478.It Pa /etc/networks 479For network names. 480.It Pa /etc/services 481For port names. 482.El 483.Sh HISTORY 484The 485.Nm 486program appeared in 487.Bx 4.3 . 488The 489.Ic icmp , 490.Ic ip , 491and 492.Ic tcp 493displays appeared in 494.Fx 3.0 ; 495the notion of having different display modes for the 496.Tn ICMP , 497.Tn IP 498.Tn TCP , 499and 500.Tn UDP 501statistics was stolen from the 502.Fl C 503option to 504.Xr netstat 1 505in Silicon Graphics' 506.Tn IRIX 507system. 508.Sh BUGS 509Takes 2-10 percent of the cpu. 510Certain displays presume a minimum of 80 characters per line. 511The 512.Ic vmstat 513display looks out of place because it is (it was added in as 514a separate display rather than created as a new program). 515