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: src/usr.bin/systat/systat.1,v 1.23.2.9 2002/12/29 16:35:40 schweikh Exp $
  34 .\" $DragonFly: src/usr.bin/systat/systat.1,v 1.5 2007/05/31 11:38:37 hasso Exp $
  35 .\"
  36 .Dd May 31, 2007
  37 .Dt SYSTAT 1
  38 .Os
  39 .Sh NAME
  40 .Nm systat
  41 .Nd display system statistics on a crt
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl display
  45 .Op Ar refresh-interval
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility displays various system statistics in a screen oriented fashion
  50 using the curses screen display library,
  51 .Xr ncurses 3 .
  52 .Pp
  53 While
  54 .Nm
  55 is running the screen is usually divided into two windows (an exception
  56 is the vmstat display which uses the entire screen).  The
  57 upper window depicts the current system load average.  The
  58 information displayed in the lower window may vary, depending on
  59 user commands.  The last line on the screen is reserved for user
  60 input and error messages.
  61 .Pp
  62 By default
  63 .Nm
  64 displays the processes getting the largest percentage of the processor
  65 in the lower window.  Other displays show swap space usage, disk
  66 .Tn I/O
  67 statistics (a la
  68 .Xr iostat  8  ) ,
  69 virtual memory statistics (a la
  70 .Xr vmstat  8  ) ,
  71 network ``mbuf'' utilization,
  72 .Tn TCP/IP
  73 statistics,
  74 and network connections (a la
  75 .Xr netstat  1  ) .
  76 .Pp
  77 Input is interpreted at two different levels.
  78 A ``global'' command interpreter processes all keyboard input.
  79 If this command interpreter fails to recognize a command, the
  80 input line is passed to a per-display command interpreter.  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.  While entering a command the
 126 current character erase, word erase, and line kill characters
 127 may be used.
 128 .El
 129 .Pp
 130 The following commands are interpreted by the ``global''
 131 command interpreter.
 132 .Bl -tag -width Fl
 133 .It Ic help
 134 Print the names of the available displays on the command line.
 135 .It Ic load
 136 Print the load average over the past 1, 5, and 15 minutes
 137 on the command line.
 138 .It Ic stop
 139 Stop refreshing the screen.
 140 .It Xo
 141 .Op Ic start
 142 .Op Ar number
 143 .Xc
 144 Start (continue) refreshing the screen.  If a second, numeric,
 145 argument is provided it is interpreted as a refresh interval
 146 (in seconds).
 147 Supplying only a number will set the refresh interval to this
 148 value.
 149 .It Ic quit
 150 Exit
 151 .Nm .
 152 (This may be abbreviated to
 153 .Ic q  . )
 154 .El
 155 .Pp
 156 The available displays are:
 157 .Bl -tag -width Ic
 158 .It Ic pigs
 159 Display, in the lower window, those processes resident in main
 160 memory and getting the
 161 largest portion of the processor (the default display).
 162 When less than 100% of the
 163 processor is scheduled to user processes, the remaining time
 164 is accounted to the ``idle'' process.
 165 .It Ic icmp
 166 Display, in the lower window, statistics about messages received and
 167 transmitted by the Internet Control Message Protocol
 168 .Pq Dq Tn ICMP .
 169 The left half of the screen displays information about received
 170 packets, and the right half displays information regarding transmitted
 171 packets.
 172 .Pp
 173 The
 174 .Ic icmp
 175 display understands two commands:
 176 .Ic mode
 177 and
 178 .Ic reset .
 179 The
 180 .Ic mode
 181 command is used to select one of four display modes, given as its argument:
 182 .Bl -tag -width absoluteXX -compact
 183 .It Ic rate :
 184 show the rate of change of each value in packets (the default)
 185 per second
 186 .It Ic delta :
 187 show the rate of change of each value in packets per refresh interval
 188 .It Ic since :
 189 show the total change of each value since the display was last reset
 190 .It Ic absolute :
 191 show the absolute value of each statistic
 192 .El
 193 .Pp
 194 The
 195 .Ic reset
 196 command resets the baseline for
 197 .Ic since
 198 mode.  The
 199 .Ic mode
 200 command with no argument will display the current mode in the command
 201 line.
 202 .It Ic icmp6
 203 This display is like the
 204 .Ic icmp
 205 display,
 206 but displays statistics for IPv6 ICMP.
 207 .It Ic ip
 208 Otherwise identical to the
 209 .Ic icmp
 210 display, except that it displays
 211 .Tn IP
 212 and
 213 .Tn UDP
 214 statistics.
 215 .It Ic ip6
 216 Like the
 217 .Ic ip
 218 display,
 219 except that it displays
 220 .Tn IPv6
 221 statics.
 222 .It Ic tcp
 223 Like
 224 .Ic icmp ,
 225 but with
 226 .Tn TCP
 227 statistics.
 228 .It Ic ifstat
 229 Display, in the lower window, statistics about network throughput on
 230 a per-interface basis.
 231 .It Ic iostat
 232 Display, in the lower window, statistics about processor use
 233 and disk throughput.  Statistics on processor use appear as
 234 bar graphs of the amount of time executing in user mode (``user''),
 235 in user mode running low priority processes (``nice''), in
 236 system mode (``system''), in interrupt mode (``interrupt''),
 237 and idle (``idle'').  Statistics
 238 on disk throughput show, for each drive, megabytes per second,
 239 average number of disk transactions per second, and
 240 average kilobytes of data per transaction.  This information may be
 241 displayed as bar graphs or as rows of numbers which scroll downward.  Bar
 242 graphs are shown by default.
 243 .Pp
 244 The following commands are specific to the
 245 .Ic iostat
 246 display; the minimum unambiguous prefix may be supplied.
 247 .Pp
 248 .Bl -tag -width Fl -compact
 249 .It Cm numbers
 250 Show the disk
 251 .Tn I/O
 252 statistics in numeric form.  Values are
 253 displayed in numeric columns which scroll downward.
 254 .It Cm bars
 255 Show the disk
 256 .Tn I/O
 257 statistics in bar graph form (default).
 258 .It Cm kbpt
 259 Toggle the display of kilobytes per transaction.
 260 (the default is to
 261 not display kilobytes per transaction).
 262 .El
 263 .It Ic swap
 264 Show information about swap space usage on all the
 265 swap areas compiled into the kernel.
 266 The first column is the device name of the partition.
 267 The next column is the total space available in the partition.
 268 The
 269 .Ar Used
 270 column indicates the total blocks used so far;
 271 the graph shows the percentage of space in use on each partition.
 272 If there are more than one swap partition in use,
 273 a total line is also shown.
 274 Areas known to the kernel, but not in use are shown as not available.
 275 .It Ic mbufs
 276 Display, in the lower window, the number of mbufs allocated
 277 for particular uses, i.e. data, socket structures, etc.
 278 .It Ic vmstat
 279 Take over the entire display and show a (rather crowded) compendium
 280 of statistics related to virtual memory usage, process scheduling,
 281 device interrupts, system name translation cacheing, disk
 282 .Tn I/O
 283 etc.
 284 .Pp
 285 The upper left quadrant of the screen shows the number
 286 of users logged in and the load average over the last one, five,
 287 and fifteen minute intervals.
 288 Below this line are statistics on memory utilization.
 289 The first row of the table reports memory usage only among
 290 active processes, that is processes that have run in the previous
 291 twenty seconds.
 292 The second row reports on memory usage of all processes.
 293 The first column reports on the number of physical pages
 294 claimed by processes.
 295 The second column reports the number of physical pages that
 296 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 shows the number of physical pages
 301 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
 309 (`Csw'), traps (`Trp'; includes page faults), system calls (`Sys'),
 310 interrupts (`Int'), network software interrupts (`Sof'), and page
 311 faults (`Flt').
 312 .Pp
 313 Below the process queue length listing is a numerical listing and
 314 a bar graph showing the amount of
 315 system (shown as `='), interrupt (shown as `+'), user (shown as `>'),
 316 nice (shown as `-'), and idle time (shown as ` ').
 317 .Pp
 318 Below the process display are statistics on name translations.
 319 It lists the number of names translated in the previous interval,
 320 the number and percentage of the translations that were
 321 handled by the system wide name translation cache, and
 322 the number and percentage of the translations that were
 323 handled by the per process name translation cache.
 324 .Pp
 325 At the bottom left is the disk usage display.
 326 It reports the number of
 327 kilobytes per transaction, transactions per second, megabytes
 328 per second and the percentage of the time the disk was busy averaged
 329 over the refresh period of the display (by default, five seconds).
 330 The system keeps statistics on most every storage device.  In general, up
 331 to seven devices are displayed.  The devices displayed by default are the
 332 first devices in the kernel's device list.  See
 333 .Xr devstat 3
 334 and
 335 .Xr devstat 9
 336 for details on the devstat system.
 337 .Pp
 338 Under the date in the upper right hand quadrant are statistics
 339 on paging and swapping activity.
 340 The first two columns report the average number of pages
 341 brought in and out per second over the last refresh interval
 342 due to page faults and the paging daemon.
 343 The third and fourth columns report the average number of pages
 344 brought in and out per second over the last refresh interval
 345 due to swap requests initiated by the scheduler.
 346 The first row of the display shows the average
 347 number of disk transfers per second over the last refresh interval;
 348 the second row of the display shows the average
 349 number of pages transferred per second over the last refresh interval.
 350 .Pp
 351 Below the paging statistics is a column of lines regarding the virtual
 352 memory system which list the average number of
 353 pages copied on write (`cow'),
 354 pages zero filled on demand (`zfod'),
 355 slow (on-the-fly) zero fills percentage (`%slo-z'),
 356 pages wired down (`wire'),
 357 active pages (`act'),
 358 inactive pages (`inact'),
 359 pages on the buffer cache queue (`cache'),
 360 number of free pages (`free'),
 361 pages freed by the page daemon (`daefr'),
 362 pages freed by exiting processes (`prcfr'),
 363 pages reactivated from the free list (`react'),
 364 times the page daemon was awakened (`pdwak'),
 365 pages analyzed by the page daemon (`pdpgs'),
 366 and
 367 intransit blocking page faults (`intrn')
 368 per second over the refresh interval.
 369 .Pp
 370 At the bottom of this column are lines showing the
 371 amount of memory, in kilobytes, used for the buffer cache (`buf'),
 372 the number of dirty buffers in the buffer cache (`dirtybuf'),
 373 desired maximum size of vnode cache (`desiredvnodes') (mostly unused,
 374 except to size the name cache),
 375 number of vnodes actually allocated (`numvnodes'),
 376 and
 377 number of allocated vnodes that are free (`freevnodes').
 378 .Pp
 379 Running down the right hand side of the display is a breakdown
 380 of the interrupts being handled by the system.
 381 At the top of the list is the total interrupts per second
 382 over the time interval.
 383 The rest of the column breaks down the total on a device
 384 by device basis.
 385 Only devices that have interrupted at least once since boot time are shown.
 386 .Pp
 387 The following commands are specific to the
 388 .Ic vmstat
 389 display; the minimum unambiguous prefix may be supplied.
 390 .Pp
 391 .Bl -tag -width Ar -compact
 392 .It Cm boot
 393 Display cumulative statistics since the system was booted.
 394 .It Cm run
 395 Display statistics as a running total from the point this
 396 command is given.
 397 .It Cm time
 398 Display statistics averaged over the refresh interval (the default).
 399 .It Cm want_fd
 400 Toggle the display of fd devices in the disk usage display.
 401 .It Cm zero
 402 Reset running statistics to zero.
 403 .El
 404 .It Ic netstat
 405 Display, in the lower window, network connections.  By default,
 406 network servers awaiting requests are not displayed.  Each address
 407 is displayed in the format ``host.port'', with each shown symbolically,
 408 when possible.  It is possible to have addresses displayed numerically,
 409 limit the display to a set of ports, hosts, and/or protocols
 410 (the minimum unambiguous prefix may be supplied):
 411 .Pp
 412 .Bl -tag -width Ar -compact
 413 .It Cm all
 414 Toggle the displaying of server processes awaiting requests (this
 415 is the equivalent of the
 416 .Fl a
 417 flag to
 418 .Xr netstat 1 ) .
 419 .It Cm numbers
 420 Display network addresses numerically.
 421 .It Cm names
 422 Display network addresses symbolically.
 423 .It Cm proto Ar protocol
 424 Display only network connections using the indicated
 425 .Ar protocol .
 426 Supported protocols are ``tcp'', ``udp'', and ``all''.
 427 .It Cm ignore Op Ar items
 428 Do not display information about connections associated with
 429 the specified hosts or ports.  Hosts and ports may be specified
 430 by name (``vangogh'', ``ftp''), or numerically.  Host addresses
 431 use the Internet dot notation (``128.32.0.9'').  Multiple items
 432 may be specified with a single command by separating them with
 433 spaces.
 434 .It Cm display Op Ar items
 435 Display information about the connections associated with the
 436 specified hosts or ports.  As for
 437 .Ar ignore  ,
 438 .Op Ar items
 439 may be names or numbers.
 440 .It Cm show Op Ar ports\&|hosts
 441 Show, on the command line, the currently selected protocols,
 442 hosts, and ports.  Hosts and ports which are being ignored
 443 are prefixed with a `!'.  If
 444 .Ar ports
 445 or
 446 .Ar hosts
 447 is supplied as an argument to
 448 .Cm show  ,
 449 then only the requested information will be displayed.
 450 .It Cm reset
 451 Reset the port, host, and protocol matching mechanisms to the default
 452 (any protocol, port, or host).
 453 .El
 454 .El
 455 .Pp
 456 Commands to switch between displays may be abbreviated to the
 457 minimum unambiguous prefix; for example, ``io'' for ``iostat''.
 458 Certain information may be discarded when the screen size is
 459 insufficient for display.  For example, on a machine with 10
 460 drives the
 461 .Ic iostat
 462 bar graph displays only 3 drives on a 24 line terminal.  When
 463 a bar graph would overflow the allotted screen space it is
 464 truncated and the actual value is printed ``over top'' of the bar.
 465 .Pp
 466 The following commands are common to each display which shows
 467 information about disk drives.  These commands are used to
 468 select a set of drives to report on, should your system have
 469 more drives configured than can normally be displayed on the
 470 screen.
 471 .Pp
 472 .Bl -tag -width Ar -compact
 473 .It Cm ignore Op Ar drives
 474 Do not display information about the drives indicated.  Multiple
 475 drives may be specified, separated by spaces.
 476 .It Cm display Op Ar drives
 477 Display information about the drives indicated.  Multiple drives
 478 may be specified, separated by spaces.
 479 .It Cm only Op Ar drives
 480 Display only the specified drives.  Multiple drives may be specified,
 481 separated by spaces.
 482 .It Cm drives
 483 Display a list of available devices.
 484 .It Cm match Xo
 485 .Ar type , Ns Ar if , Ns Ar pass
 486 .Op | Ar ...
 487 .Xc
 488 Display devices matching the given pattern.  The basic matching
 489 expressions are the same as those used in
 490 .Xr iostat 8
 491 with one difference.  Instead of specifying multiple
 492 .Fl t
 493 arguments which are then ORed together, the user instead specifies multiple
 494 matching expressions joined by the pipe
 495 .Pq Ql \&|
 496 character.
 497 The comma
 498 separated arguments within each matching expression are ANDed together, and
 499 then the pipe separated matching expressions are ORed together.  Any
 500 device matching the combined expression will be displayed, if there is room
 501 to display it.  For example:
 502 .Pp
 503 .Dl match da,scsi | cd,ide
 504 .Pp
 505 This will display all SCSI Direct Access devices and all IDE CDROM devices.
 506 .Pp
 507 .Dl match da | sa | cd,pass
 508 .Pp
 509 This will display all Direct Access devices, all Sequential Access devices,
 510 and all passthrough devices that provide access to CDROM drives.
 511 .El
 512 .Sh FILES
 513 .Bl -tag -width /etc/networks -compact
 514 .It Pa /kernel
 515 For the namelist.
 516 .It Pa /dev/kmem
 517 For information in main memory.
 518 .It Pa /etc/hosts
 519 For host names.
 520 .It Pa /etc/networks
 521 For network names.
 522 .It Pa /etc/services
 523 For port names.
 524 .El
 525 .Sh SEE ALSO
 526 .Xr netstat 1 ,
 527 .Xr kvm 3 ,
 528 .Xr icmp 4 ,
 529 .Xr icmp6 4 ,
 530 .Xr ip 4 ,
 531 .Xr ip6 4 ,
 532 .Xr tcp 4 ,
 533 .Xr udp 4 ,
 534 .Xr iostat 8 ,
 535 .Xr vmstat 8
 536 .Sh HISTORY
 537 The
 538 .Nm
 539 program appeared in
 540 .Bx 4.3 .
 541 The
 542 .Ic icmp ,
 543 .Ic ip ,
 544 and
 545 .Ic tcp
 546 displays appeared in
 547 .Fx 3.0 ;
 548 the notion of having different display modes for the
 549 .Tn ICMP ,
 550 .Tn IP ,
 551 .Tn TCP ,
 552 and
 553 .Tn UDP
 554 statistics was stolen from the
 555 .Fl C
 556 option to
 557 .Xr netstat 1
 558 in Silicon Graphics'
 559 .Tn IRIX
 560 system.
 561 .Sh BUGS
 562 Certain displays presume a minimum of 80 characters per line.
 563 The
 564 .Ic vmstat
 565 display looks out of place because it is (it was added in as
 566 a separate display rather than created as a new program).