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 24, 2015
  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 .Tn TCP/IP
  71 statistics,
  72 and network connections (a la
  73 .Xr netstat 1 ) .
  74 .Pp
  75 Input is interpreted at two different levels.
  76 A ``global'' command interpreter processes all keyboard input.
  77 If this command interpreter fails to recognize a command, the
  78 input line is passed to a per-display command interpreter.
  79 This
  80 allows each display to have certain display-specific commands.
  81 .Pp
  82 Command line options:
  83 .Bl -tag -width "refresh_interval"
  84 .It Fl Ns Ar display
  85 The
  86 .Fl
  87 flag expects
  88 .Ar display
  89 to be one of:
  90 .Ic icmp ,
  91 .Ic icmp6 ,
  92 .Ic ifstat ,
  93 .Ic iostat ,
  94 .Ic ip ,
  95 .Ic ip6 ,
  96 .Ic netstat ,
  97 .Ic pigs ,
  98 .Ic sctp ,
  99 .Ic swap ,
 100 .Ic tcp ,
 101 or
 102 .Ic vmstat .
 103 These displays can also be requested interactively (without the
 104 .Dq Fl )
 105 and are described in
 106 full detail below.
 107 .It Ar refresh-interval
 108 The
 109 .Ar refresh-value
 110 specifies the screen refresh time interval in seconds.
 111 Time interval can be fractional.
 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 sctp
 228 Like
 229 .Ic icmp ,
 230 but with
 231 .Tn SCTP
 232 statistics.
 233 .It Ic tcp
 234 Like
 235 .Ic icmp ,
 236 but with
 237 .Tn TCP
 238 statistics.
 239 .It Ic iostat
 240 Display, in the lower window, statistics about processor use
 241 and disk throughput.
 242 Statistics on processor use appear as
 243 bar graphs of the amount of time executing in user mode (``user''),
 244 in user mode running low priority processes (``nice''), in
 245 system mode (``system''), in interrupt mode (``interrupt''),
 246 and idle (``idle'').
 247 Statistics
 248 on disk throughput show, for each drive, megabytes per second,
 249 average number of disk transactions per second, and
 250 average kilobytes of data per transaction.
 251 This information may be
 252 displayed as bar graphs or as rows of numbers which scroll downward.
 253 Bar
 254 graphs are shown by default.
 255 .Pp
 256 The following commands are specific to the
 257 .Ic iostat
 258 display; the minimum unambiguous prefix may be supplied.
 259 .Pp
 260 .Bl -tag -width Fl -compact
 261 .It Cm numbers
 262 Show the disk
 263 .Tn I/O
 264 statistics in numeric form.
 265 Values are
 266 displayed in numeric columns which scroll downward.
 267 .It Cm bars
 268 Show the disk
 269 .Tn I/O
 270 statistics in bar graph form (default).
 271 .It Cm kbpt
 272 Toggle the display of kilobytes per transaction.
 273 (the default is to
 274 not display kilobytes per transaction).
 275 .El
 276 .It Ic swap
 277 Show information about swap space usage on all the
 278 swap areas compiled into the kernel.
 279 The first column is the device name of the partition.
 280 The next column is the total space available in the partition.
 281 The
 282 .Ar Used
 283 column indicates the total blocks used so far;
 284 the graph shows the percentage of space in use on each partition.
 285 If there are more than one swap partition in use,
 286 a total line is also shown.
 287 Areas known to the kernel, but not in use are shown as not available.
 288 .It Ic vmstat
 289 Take over the entire display and show a (rather crowded) compendium
 290 of statistics related to virtual memory usage, process scheduling,
 291 device interrupts, system name translation caching, disk
 292 .Tn I/O
 293 etc.
 294 .Pp
 295 The upper left quadrant of the screen shows the number
 296 of users logged in and the load average over the last one, five,
 297 and fifteen minute intervals.
 298 Below this line are statistics on memory utilization.
 299 The first row of the table reports memory usage only among
 300 active processes, that is processes that have run in the previous
 301 twenty seconds.
 302 The second row reports on memory usage of all processes.
 303 The first column reports on the number of kilobytes in physical pages
 304 claimed by processes.
 305 The second column reports the number of kilobytes in physical pages that
 306 are devoted to read only text pages.
 307 The third and fourth columns report the same two figures for
 308 virtual pages, that is the number of kilobytes in pages that would be
 309 needed if all processes had all of their pages.
 310 Finally the last column shows the number of kilobytes in physical pages
 311 on the free list.
 312 .Pp
 313 Below the memory display is a list of the
 314 average number of processes (over the last refresh interval)
 315 that are runnable (`r'), in page wait (`p'),
 316 in disk wait other than paging (`d'),
 317 sleeping (`s'), and swapped out but desiring to run (`w').
 318 The row also shows the average number of context switches
 319 (`Csw'), traps (`Trp'; includes page faults), system calls (`Sys'),
 320 interrupts (`Int'), network software interrupts (`Sof'), and page
 321 faults (`Flt').
 322 .Pp
 323 Below the process queue length listing is a numerical listing and
 324 a bar graph showing the amount of
 325 system (shown as `='), interrupt (shown as `+'), user (shown as `>'),
 326 nice (shown as `-'), and idle time (shown as ` ').
 327 .Pp
 328 Below the process display are statistics on name translations.
 329 It lists the number of names translated in the previous interval,
 330 the number and percentage of the translations that were
 331 handled by the system wide name translation cache, and
 332 the number and percentage of the translations that were
 333 handled by the per process name translation cache.
 334 .Pp
 335 To the right of the name translations display are lines showing
 336 the number of dirty buffers in the buffer cache (`dtbuf'),
 337 desired maximum size of vnode cache (`desvn'),
 338 number of vnodes actually allocated (`numvn'),
 339 and
 340 number of allocated vnodes that are free (`frevn').
 341 .Pp
 342 At the bottom left is the disk usage display.
 343 It reports the number of
 344 kilobytes per transaction, transactions per second, megabytes
 345 per second and the percentage of the time the disk was busy averaged
 346 over the refresh period of the display (by default, five seconds).
 347 The system keeps statistics on most every storage device.
 348 In general, up
 349 to seven devices are displayed.
 350 The devices displayed by default are the
 351 first devices in the kernel's device list.
 352 See
 353 .Xr devstat 3
 354 and
 355 .Xr devstat 9
 356 for details on the devstat system.
 357 .Pp
 358 Under the date in the upper right hand quadrant are statistics
 359 on paging and swapping activity.
 360 The first two columns report the average number of pages
 361 brought in and out per second over the last refresh interval
 362 due to page faults and the paging daemon.
 363 The third and fourth columns report the average number of pages
 364 brought in and out per second over the last refresh interval
 365 due to swap requests initiated by the scheduler.
 366 The first row of the display shows the average
 367 number of disk transfers per second over the last refresh interval;
 368 the second row of the display shows the average
 369 number of pages transferred per second over the last refresh interval.
 370 .Pp
 371 Below the paging statistics is a column of lines regarding the virtual
 372 memory system.
 373 The first few lines describe,
 374 in units (except as noted below)
 375 of pages per second averaged over the sampling interval,
 376 pages copied on write (`cow'),
 377 pages zero filled on demand (`zfod'),
 378 pages optimally zero filled on demand (`ozfod'),
 379 the ratio of the (average) ozfod / zfod as a percentage (`%ozfod'),
 380 pages freed by the page daemon (`daefr'),
 381 pages freed by exiting processes (`prcfr'),
 382 total pages freed (`totfr'),
 383 pages reactivated from the free list (`react'),
 384 the average number of
 385 times per second that the page daemon was awakened (`pdwak'),
 386 pages analyzed by the page daemon (`pdpgs'),
 387 and
 388 in-transit blocking page faults (`intrn').
 389 Note that the units are special for `%ozfod' and `pdwak'.
 390 The next few lines describe,
 391 as amounts of memory in kilobytes,
 392 pages wired down (`wire'),
 393 active pages (`act'),
 394 inactive pages (`inact'),
 395 pages on the cache queue (`cache'),
 396 and
 397 free pages (`free').
 398 Note that the values displayed are the current transient ones;
 399 they are not averages.
 400 .Pp
 401 At the bottom of this column is a line showing the
 402 amount of virtual memory, in kilobytes, mapped into the buffer cache (`buf').
 403 This statistic is not useful.
 404 It exists only as a placeholder for the corresponding useful statistic
 405 (the amount of real memory used to cache disks).
 406 The most important component of the latter (the amount of real memory
 407 used by the vm system to cache disks) is not available,
 408 but can be guessed from the `inact' amount under some system loads.
 409 .Pp
 410 Running down the right hand side of the display is a breakdown
 411 of the interrupts being handled by the system.
 412 At the top of the list is the total interrupts per second
 413 over the time interval.
 414 The rest of the column breaks down the total on a device
 415 by device basis.
 416 Only devices that have interrupted at least once since boot time are shown.
 417 .Pp
 418 The following commands are specific to the
 419 .Ic vmstat
 420 display; the minimum unambiguous prefix may be supplied.
 421 .Pp
 422 .Bl -tag -width Ar -compact
 423 .It Cm boot
 424 Display cumulative statistics since the system was booted.
 425 .It Cm run
 426 Display statistics as a running total from the point this
 427 command is given.
 428 .It Cm time
 429 Display statistics averaged over the refresh interval (the default).
 430 .It Cm zero
 431 Reset running statistics to zero.
 432 .El
 433 .It Ic netstat
 434 Display, in the lower window, network connections.
 435 By default,
 436 network servers awaiting requests are not displayed.
 437 Each address
 438 is displayed in the format ``host.port'', with each shown symbolically,
 439 when possible.
 440 It is possible to have addresses displayed numerically,
 441 limit the display to a set of ports, hosts, and/or protocols
 442 (the minimum unambiguous prefix may be supplied):
 443 .Pp
 444 .Bl -tag -width Ar -compact
 445 .It Cm all
 446 Toggle the displaying of server processes awaiting requests (this
 447 is the equivalent of the
 448 .Fl a
 449 flag to
 450 .Xr netstat 1 ) .
 451 .It Cm numbers
 452 Display network addresses numerically.
 453 .It Cm names
 454 Display network addresses symbolically.
 455 .It Cm proto Ar protocol
 456 Display only network connections using the indicated
 457 .Ar protocol .
 458 Supported protocols are ``tcp'', ``udp'', and ``all''.
 459 .It Cm ignore Op Ar items
 460 Do not display information about connections associated with
 461 the specified hosts or ports.
 462 Hosts and ports may be specified
 463 by name (``vangogh'', ``ftp''), or numerically.
 464 Host addresses
 465 use the Internet dot notation (``128.32.0.9'').
 466 Multiple items
 467 may be specified with a single command by separating them with
 468 spaces.
 469 .It Cm display Op Ar items
 470 Display information about the connections associated with the
 471 specified hosts or ports.
 472 As for
 473 .Ar ignore ,
 474 .Op Ar items
 475 may be names or numbers.
 476 .It Cm show Op Ar ports\&|hosts
 477 Show, on the command line, the currently selected protocols,
 478 hosts, and ports.
 479 Hosts and ports which are being ignored
 480 are prefixed with a `!'.
 481 If
 482 .Ar ports
 483 or
 484 .Ar hosts
 485 is supplied as an argument to
 486 .Cm show ,
 487 then only the requested information will be displayed.
 488 .It Cm reset
 489 Reset the port, host, and protocol matching mechanisms to the default
 490 (any protocol, port, or host).
 491 .El
 492 .It Ic ifstat
 493 Display the network traffic going through active interfaces on the
 494 system.
 495 Idle interfaces will not be displayed until they receive some
 496 traffic.
 497 .Pp
 498 For each interface being displayed, the current, peak and total
 499 statistics are displayed for incoming and outgoing traffic.
 500 By default,
 501 the
 502 .Ic ifstat
 503 display will automatically scale the units being used so that they are
 504 in a human-readable format.
 505 The scaling units used for the current and
 506 peak
 507 traffic columns can be altered by the
 508 .Ic scale
 509 command.
 510 .Bl -tag -width ".Cm scale Op Ar units"
 511 .It Cm scale Op Ar units
 512 Modify the scale used to display the current and peak traffic over all
 513 interfaces.
 514 The following units are recognised: kbit, kbyte, mbit,
 515 mbyte, gbit, gbyte and auto.
 516 .It Cm pps
 517 Show statistics in packets per second instead of bytes/bits per second.
 518 A subsequent call of
 519 .Ic pps
 520 switches this mode off.
 521 .It Cm match Op Ar patterns
 522 Display only interfaces that match pattern provided as an argument.
 523 Patterns should be in shell syntax separated by whitespaces or commas.
 524 If this command is called without arguments then all interfaces are displayed.
 525 For example:
 526 .Pp
 527 .Dl match em0, bge1
 528 .Pp
 529 This will display em0 and bge1 interfaces.
 530 .Pp
 531 .Dl match em*, bge*, lo0
 532 .Pp
 533 This will display all
 534 .Ic em
 535 interfaces, all
 536 .Ic bge
 537 interfaces and the loopback interface.
 538 .El
 539 .El
 540 .Pp
 541 Commands to switch between displays may be abbreviated to the
 542 minimum unambiguous prefix; for example, ``io'' for ``iostat''.
 543 Certain information may be discarded when the screen size is
 544 insufficient for display.
 545 For example, on a machine with 10
 546 drives the
 547 .Ic iostat
 548 bar graph displays only 3 drives on a 24 line terminal.
 549 When
 550 a bar graph would overflow the allotted screen space it is
 551 truncated and the actual value is printed ``over top'' of the bar.
 552 .Pp
 553 The following commands are common to each display which shows
 554 information about disk drives.
 555 These commands are used to
 556 select a set of drives to report on, should your system have
 557 more drives configured than can normally be displayed on the
 558 screen.
 559 .Pp
 560 .Bl -tag -width Ar -compact
 561 .It Cm ignore Op Ar drives
 562 Do not display information about the drives indicated.
 563 Multiple
 564 drives may be specified, separated by spaces.
 565 .It Cm display Op Ar drives
 566 Display information about the drives indicated.
 567 Multiple drives
 568 may be specified, separated by spaces.
 569 .It Cm only Op Ar drives
 570 Display only the specified drives.
 571 Multiple drives may be specified,
 572 separated by spaces.
 573 .It Cm drives
 574 Display a list of available devices.
 575 .It Cm match Xo
 576 .Ar type , Ns Ar if , Ns Ar pass
 577 .Op | Ar ...
 578 .Xc
 579 Display devices matching the given pattern.
 580 The basic matching
 581 expressions are the same as those used in
 582 .Xr iostat 8
 583 with one difference.
 584 Instead of specifying multiple
 585 .Fl t
 586 arguments which are then ORed together, the user instead specifies multiple
 587 matching expressions joined by the pipe
 588 .Pq Ql \&|
 589 character.
 590 The comma
 591 separated arguments within each matching expression are ANDed together, and
 592 then the pipe separated matching expressions are ORed together.
 593 Any
 594 device matching the combined expression will be displayed, if there is room
 595 to display it.
 596 For example:
 597 .Pp
 598 .Dl match da,scsi | cd,ide
 599 .Pp
 600 This will display all SCSI Direct Access devices and all IDE CDROM devices.
 601 .Pp
 602 .Dl match da | sa | cd,pass
 603 .Pp
 604 This will display all Direct Access devices, all Sequential Access devices,
 605 and all passthrough devices that provide access to CDROM drives.
 606 .El
 607 .Sh FILES
 608 .Bl -tag -width /boot/kernel/kernel -compact
 609 .It Pa /boot/kernel/kernel
 610 For the namelist.
 611 .It Pa /dev/kmem
 612 For information in main memory.
 613 .It Pa /etc/hosts
 614 For host names.
 615 .It Pa /etc/networks
 616 For network names.
 617 .It Pa /etc/services
 618 For port names.
 619 .El
 620 .Sh SEE ALSO
 621 .Xr netstat 1 ,
 622 .Xr kvm 3 ,
 623 .Xr icmp 4 ,
 624 .Xr icmp6 4 ,
 625 .Xr ip 4 ,
 626 .Xr ip6 4 ,
 627 .Xr tcp 4 ,
 628 .Xr udp 4 ,
 629 .Xr gstat 8 ,
 630 .Xr iostat 8 ,
 631 .Xr vmstat 8
 632 .Sh HISTORY
 633 The
 634 .Nm
 635 program appeared in
 636 .Bx 4.3 .
 637 The
 638 .Ic icmp ,
 639 .Ic ip ,
 640 and
 641 .Ic tcp
 642 displays appeared in
 643 .Fx 3.0 ;
 644 the notion of having different display modes for the
 645 .Tn ICMP ,
 646 .Tn IP ,
 647 .Tn TCP ,
 648 and
 649 .Tn UDP
 650 statistics was stolen from the
 651 .Fl C
 652 option to
 653 .Xr netstat 1
 654 in Silicon Graphics'
 655 .Tn IRIX
 656 system.
 657 .Sh BUGS
 658 Certain displays presume a minimum of 80 characters per line.
 659 The
 660 .Ic vmstat
 661 display looks out of place because it is (it was added in as
 662 a separate display rather than created as a new program).