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