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