usr.bin/systat/systat.1

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