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