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