]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.bin/systat/systat.1
MFV ntp-4.2.8p4 (r289715)
[FreeBSD/FreeBSD.git] / 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 July 15, 2013
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 display-commands
41 .Op Ar refresh-interval
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility displays various system statistics in a screen oriented fashion
46 using the curses screen display library,
47 .Xr ncurses 3 .
48 .Pp
49 While
50 .Nm
51 is running the screen is usually divided into two windows (an exception
52 is the vmstat display which uses the entire screen).
53 The
54 upper window depicts the current system load average.
55 The
56 information displayed in the lower window may vary, depending on
57 user commands.
58 The last line on the screen is reserved for user
59 input and error messages.
60 .Pp
61 By default
62 .Nm
63 displays the processes getting the largest percentage of the processor
64 in the lower window.
65 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 .Tn TCP/IP
72 statistics,
73 and network connections (a la
74 .Xr netstat 1 ) .
75 .Pp
76 Input is interpreted at two different levels.
77 A ``global'' command interpreter processes all keyboard input.
78 If this command interpreter fails to recognize a command, the
79 input line is passed to a per-display command interpreter.
80 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 netstat ,
98 .Ic pigs ,
99 .Ic swap ,
100 .Ic tcp ,
101 .Ic vmstat ,
102 or
103 .Ic zarc ,
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 Time interval can be fractional.
113 .It Ar display-commands
114 A list of commands specific for this display. These commands can also
115 be entered interactively and are described for each display separately
116 below. If the command of the display requires an argument or arguments,
117 it is possible to specify them as separate command line argument. To finish
118 display commands it is possible to use double dash at the end
119 of the list. For example:
120 .Pp
121 .Dl Nm Fl ifstat Fl match Ar bge0,em1 Fl pps
122 .Pp
123 This will display statistics of packets per second for network interfaces
124 named as bge0 and em1.
125 .Pp
126 .Dl Nm Fl iostat Fl numeric Fl - Ar 2.1
127 .Pp
128 This will display all IO statistics in a numeric format and the information
129 will be refreshed each 2.1 seconds.
130 .El
131 .Pp
132 Certain characters cause immediate action by
133 .Nm .
134 These are
135 .Bl -tag -width Fl
136 .It Ic \&^L
137 Refresh the screen.
138 .It Ic \&^G
139 Print the name of the current ``display'' being shown in
140 the lower window and the refresh interval.
141 .It Ic \&:
142 Move the cursor to the command line and interpret the input
143 line typed as a command.
144 While entering a command the
145 current character erase, word erase, and line kill characters
146 may be used.
147 .El
148 .Pp
149 The following commands are interpreted by the ``global''
150 command interpreter.
151 .Bl -tag -width Fl
152 .It Ic help
153 Print the names of the available displays on the command line.
154 .It Ic load
155 Print the load average over the past 1, 5, and 15 minutes
156 on the command line.
157 .It Ic stop
158 Stop refreshing the screen.
159 .It Xo
160 .Op Ic start
161 .Op Ar number
162 .Xc
163 Start (continue) refreshing the screen.
164 If a second, numeric,
165 argument is provided it is interpreted as a refresh interval
166 (in seconds).
167 Supplying only a number will set the refresh interval to this
168 value.
169 .It Ic quit
170 Exit
171 .Nm .
172 (This may be abbreviated to
173 .Ic q . )
174 .El
175 .Pp
176 The available displays are:
177 .Bl -tag -width Ic
178 .It Ic pigs
179 Display, in the lower window, those processes resident in main
180 memory and getting the
181 largest portion of the processor (the default display).
182 When less than 100% of the
183 processor is scheduled to user processes, the remaining time
184 is accounted to the ``idle'' process.
185 .It Ic icmp
186 Display, in the lower window, statistics about messages received and
187 transmitted by the Internet Control Message Protocol
188 .Pq Dq Tn ICMP .
189 The left half of the screen displays information about received
190 packets, and the right half displays information regarding transmitted
191 packets.
192 .Pp
193 The
194 .Ic icmp
195 display understands two commands:
196 .Ic mode
197 and
198 .Ic reset .
199 The
200 .Ic mode
201 command is used to select one of four display modes, given as its argument:
202 .Bl -tag -width absoluteXX -compact
203 .It Ic rate :
204 show the rate of change of each value in packets (the default)
205 per second
206 .It Ic delta :
207 show the rate of change of each value in packets per refresh interval
208 .It Ic since :
209 show the total change of each value since the display was last reset
210 .It Ic absolute :
211 show the absolute value of each statistic
212 .El
213 .Pp
214 The
215 .Ic reset
216 command resets the baseline for
217 .Ic since
218 mode.
219 The
220 .Ic mode
221 command with no argument will display the current mode in the command
222 line.
223 .It Ic icmp6
224 This display is like the
225 .Ic icmp
226 display,
227 but displays statistics for IPv6 ICMP.
228 .It Ic ip
229 Otherwise identical to the
230 .Ic icmp
231 display, except that it displays
232 .Tn IP
233 and
234 .Tn UDP
235 statistics.
236 .It Ic ip6
237 Like the
238 .Ic ip
239 display,
240 except that it displays
241 .Tn IPv6
242 statistics.
243 It does not display
244 .Tn UDP statistics.
245 .It Ic tcp
246 Like
247 .Ic icmp ,
248 but with
249 .Tn TCP
250 statistics.
251 .It Ic iostat
252 Display, in the lower window, statistics about processor use
253 and disk throughput.
254 Statistics on processor use appear as
255 bar graphs of the amount of time executing in user mode (``user''),
256 in user mode running low priority processes (``nice''), in
257 system mode (``system''), in interrupt mode (``interrupt''),
258 and idle (``idle'').
259 Statistics
260 on disk throughput show, for each drive, megabytes per second,
261 average number of disk transactions per second, and
262 average kilobytes of data per transaction.
263 This information may be
264 displayed as bar graphs or as rows of numbers which scroll downward.
265 Bar
266 graphs are shown by default.
267 .Pp
268 The following commands are specific to the
269 .Ic iostat
270 display; the minimum unambiguous prefix may be supplied.
271 .Pp
272 .Bl -tag -width Fl -compact
273 .It Cm numbers
274 Show the disk
275 .Tn I/O
276 statistics in numeric form.
277 Values are
278 displayed in numeric columns which scroll downward.
279 .It Cm bars
280 Show the disk
281 .Tn I/O
282 statistics in bar graph form (default).
283 .It Cm kbpt
284 Toggle the display of kilobytes per transaction.
285 (the default is to
286 not display kilobytes per transaction).
287 .El
288 .It Ic swap
289 Show information about swap space usage on all the
290 swap areas compiled into the kernel.
291 The first column is the device name of the partition.
292 The next column is the total space available in the partition.
293 The
294 .Ar Used
295 column indicates the total blocks used so far;
296 the graph shows the percentage of space in use on each partition.
297 If there are more than one swap partition in use,
298 a total line is also shown.
299 Areas known to the kernel, but not in use are shown as not available.
300 .It Ic vmstat
301 Take over the entire display and show a (rather crowded) compendium
302 of statistics related to virtual memory usage, process scheduling,
303 device interrupts, system name translation caching, disk
304 .Tn I/O
305 etc.
306 .Pp
307 The upper left quadrant of the screen shows the number
308 of users logged in and the load average over the last one, five,
309 and fifteen minute intervals.
310 Below this line are statistics on memory utilization.
311 The first row of the table reports memory usage only among
312 active processes, that is processes that have run in the previous
313 twenty seconds.
314 The second row reports on memory usage of all processes.
315 The first column reports on the number of kilobytes in physical pages
316 claimed by processes.
317 The second column reports the number of kilobytes in physical pages that
318 are devoted to read only text pages.
319 The third and fourth columns report the same two figures for
320 virtual pages, that is the number of kilobytes in pages that would be
321 needed if all processes had all of their pages.
322 Finally the last column shows the number of kilobytes in physical pages
323 on the free list.
324 .Pp
325 Below the memory display is a list of the
326 average number of processes (over the last refresh interval)
327 that are runnable (`r'), in page wait (`p'),
328 in disk wait other than paging (`d'),
329 sleeping (`s'), and swapped out but desiring to run (`w').
330 The row also shows the average number of context switches
331 (`Csw'), traps (`Trp'; includes page faults), system calls (`Sys'),
332 interrupts (`Int'), network software interrupts (`Sof'), and page
333 faults (`Flt').
334 .Pp
335 Below the process queue length listing is a numerical listing and
336 a bar graph showing the amount of
337 system (shown as `='), interrupt (shown as `+'), user (shown as `>'),
338 nice (shown as `-'), and idle time (shown as ` ').
339 .Pp
340 Below the process display are statistics on name translations.
341 It lists the number of names translated in the previous interval,
342 the number and percentage of the translations that were
343 handled by the system wide name translation cache, and
344 the number and percentage of the translations that were
345 handled by the per process name translation cache.
346 .Pp
347 To the right of the name translations display are lines showing
348 the number of dirty buffers in the buffer cache (`dtbuf'),
349 desired maximum size of vnode cache (`desvn'),
350 number of vnodes actually allocated (`numvn'),
351 and
352 number of allocated vnodes that are free (`frevn').
353 .Pp
354 At the bottom left is the disk usage display.
355 It reports the number of
356 kilobytes per transaction, transactions per second, megabytes
357 per second and the percentage of the time the disk was busy averaged
358 over the refresh period of the display (by default, five seconds).
359 The system keeps statistics on most every storage device.
360 In general, up
361 to seven devices are displayed.
362 The devices displayed by default are the
363 first devices in the kernel's device list.
364 See
365 .Xr devstat 3
366 and
367 .Xr devstat 9
368 for details on the devstat system.
369 .Pp
370 Under the date in the upper right hand quadrant are statistics
371 on paging and swapping activity.
372 The first two columns report the average number of pages
373 brought in and out per second over the last refresh interval
374 due to page faults and the paging daemon.
375 The third and fourth columns report the average number of pages
376 brought in and out per second over the last refresh interval
377 due to swap requests initiated by the scheduler.
378 The first row of the display shows the average
379 number of disk transfers per second over the last refresh interval;
380 the second row of the display shows the average
381 number of pages transferred per second over the last refresh interval.
382 .Pp
383 Below the paging statistics is a column of lines regarding the virtual
384 memory system.
385 The first few lines describe,
386 in units (except as noted below)
387 of pages per second averaged over the sampling interval,
388 pages copied on write (`cow'),
389 pages zero filled on demand (`zfod'),
390 pages optimally zero filled on demand (`ozfod'),
391 the ratio of the (average) ozfod / zfod as a percentage (`%ozfod'),
392 pages freed by the page daemon (`daefr'),
393 pages freed by exiting processes (`prcfr'),
394 total pages freed (`totfr'),
395 pages reactivated from the free list (`react'),
396 the average number of
397 times per second that the page daemon was awakened (`pdwak'),
398 pages analyzed by the page daemon (`pdpgs'),
399 and
400 in-transit blocking page faults (`intrn').
401 Note that the units are special for `%ozfod' and `pdwak'.
402 The next few lines describe,
403 as amounts of memory in kilobytes,
404 pages wired down (`wire'),
405 active pages (`act'),
406 inactive pages (`inact'),
407 pages on the cache queue (`cache'),
408 and
409 free pages (`free').
410 Note that the values displayed are the current transient ones;
411 they are not averages.
412 .Pp
413 At the bottom of this column is a line showing the
414 amount of virtual memory, in kilobytes, mapped into the buffer cache (`buf').
415 This statistic is not useful.
416 It exists only as a placeholder for the corresponding useful statistic
417 (the amount of real memory used to cache disks).
418 The most important component of the latter (the amount of real memory
419 used by the vm system to cache disks) is not available,
420 but can be guessed from the `inact' amount under some system loads.
421 .Pp
422 Running down the right hand side of the display is a breakdown
423 of the interrupts being handled by the system.
424 At the top of the list is the total interrupts per second
425 over the time interval.
426 The rest of the column breaks down the total on a device
427 by device basis.
428 Only devices that have interrupted at least once since boot time are shown.
429 .Pp
430 The following commands are specific to the
431 .Ic vmstat
432 display; the minimum unambiguous prefix may be supplied.
433 .Pp
434 .Bl -tag -width Ar -compact
435 .It Cm boot
436 Display cumulative statistics since the system was booted.
437 .It Cm run
438 Display statistics as a running total from the point this
439 command is given.
440 .It Cm time
441 Display statistics averaged over the refresh interval (the default).
442 .It Cm zero
443 Reset running statistics to zero.
444 .El
445 .It Ic zarc
446 display arc cache usage and hit/miss statistics.
447 .It Ic netstat
448 Display, in the lower window, network connections.
449 By default,
450 network servers awaiting requests are not displayed.
451 Each address
452 is displayed in the format ``host.port'', with each shown symbolically,
453 when possible.
454 It is possible to have addresses displayed numerically,
455 limit the display to a set of ports, hosts, and/or protocols
456 (the minimum unambiguous prefix may be supplied):
457 .Pp
458 .Bl -tag -width Ar -compact
459 .It Cm all
460 Toggle the displaying of server processes awaiting requests (this
461 is the equivalent of the
462 .Fl a
463 flag to
464 .Xr netstat 1 ) .
465 .It Cm numbers
466 Display network addresses numerically.
467 .It Cm names
468 Display network addresses symbolically.
469 .It Cm proto Ar protocol
470 Display only network connections using the indicated
471 .Ar protocol .
472 Supported protocols are ``tcp'', ``udp'', and ``all''.
473 .It Cm ignore Op Ar items
474 Do not display information about connections associated with
475 the specified hosts or ports.
476 Hosts and ports may be specified
477 by name (``vangogh'', ``ftp''), or numerically.
478 Host addresses
479 use the Internet dot notation (``128.32.0.9'').
480 Multiple items
481 may be specified with a single command by separating them with
482 spaces.
483 .It Cm display Op Ar items
484 Display information about the connections associated with the
485 specified hosts or ports.
486 As for
487 .Ar ignore ,
488 .Op Ar items
489 may be names or numbers.
490 .It Cm show Op Ar ports\&|hosts
491 Show, on the command line, the currently selected protocols,
492 hosts, and ports.
493 Hosts and ports which are being ignored
494 are prefixed with a `!'.
495 If
496 .Ar ports
497 or
498 .Ar hosts
499 is supplied as an argument to
500 .Cm show ,
501 then only the requested information will be displayed.
502 .It Cm reset
503 Reset the port, host, and protocol matching mechanisms to the default
504 (any protocol, port, or host).
505 .El
506 .It Ic ifstat
507 Display the network traffic going through active interfaces on the
508 system.
509 Idle interfaces will not be displayed until they receive some
510 traffic.
511 .Pp
512 For each interface being displayed, the current, peak and total
513 statistics are displayed for incoming and outgoing traffic.
514 By default,
515 the
516 .Ic ifstat
517 display will automatically scale the units being used so that they are
518 in a human-readable format.
519 The scaling units used for the current and
520 peak
521 traffic columns can be altered by the
522 .Ic scale
523 command.
524 .Bl -tag -width ".Cm scale Op Ar units"
525 .It Cm scale Op Ar units
526 Modify the scale used to display the current and peak traffic over all
527 interfaces.
528 The following units are recognised: kbit, kbyte, mbit,
529 mbyte, gbit, gbyte and auto.
530 .It Cm pps
531 Show statistics in packets per second instead of bytes/bits per second.
532 A subsequent call of
533 .Ic pps
534 switches this mode off.
535 .It Cm match Op Ar patterns
536 Display only interfaces that match pattern provided as an argument.
537 Patterns should be in shell syntax separated by whitespaces or commas.
538 If this command is called without arguments then all interfaces are displayed.
539 For example:
540 .Pp
541 .Dl match em0, bge1
542 .Pp
543 This will display em0 and bge1 interfaces.
544 .Pp
545 .Dl match em*, bge*, lo0
546 .Pp
547 This will display all
548 .Ic em
549 interfaces, all
550 .Ic bge
551 interfaces and the loopback interface.
552 .El
553 .El
554 .Pp
555 Commands to switch between displays may be abbreviated to the
556 minimum unambiguous prefix; for example, ``io'' for ``iostat''.
557 Certain information may be discarded when the screen size is
558 insufficient for display.
559 For example, on a machine with 10
560 drives the
561 .Ic iostat
562 bar graph displays only 3 drives on a 24 line terminal.
563 When
564 a bar graph would overflow the allotted screen space it is
565 truncated and the actual value is printed ``over top'' of the bar.
566 .Pp
567 The following commands are common to each display which shows
568 information about disk drives.
569 These commands are used to
570 select a set of drives to report on, should your system have
571 more drives configured than can normally be displayed on the
572 screen.
573 .Pp
574 .Bl -tag -width Ar -compact
575 .It Cm ignore Op Ar drives
576 Do not display information about the drives indicated.
577 Multiple
578 drives may be specified, separated by spaces.
579 .It Cm display Op Ar drives
580 Display information about the drives indicated.
581 Multiple drives
582 may be specified, separated by spaces.
583 .It Cm only Op Ar drives
584 Display only the specified drives.
585 Multiple drives may be specified,
586 separated by spaces.
587 .It Cm drives
588 Display a list of available devices.
589 .It Cm match Xo
590 .Ar type , Ns Ar if , Ns Ar pass
591 .Op | Ar ...
592 .Xc
593 Display devices matching the given pattern.
594 The basic matching
595 expressions are the same as those used in
596 .Xr iostat 8
597 with one difference.
598 Instead of specifying multiple
599 .Fl t
600 arguments which are then ORed together, the user instead specifies multiple
601 matching expressions joined by the pipe
602 .Pq Ql \&|
603 character.
604 The comma
605 separated arguments within each matching expression are ANDed together, and
606 then the pipe separated matching expressions are ORed together.
607 Any
608 device matching the combined expression will be displayed, if there is room
609 to display it.
610 For example:
611 .Pp
612 .Dl match da,scsi | cd,ide
613 .Pp
614 This will display all SCSI Direct Access devices and all IDE CDROM devices.
615 .Pp
616 .Dl match da | sa | cd,pass
617 .Pp
618 This will display all Direct Access devices, all Sequential Access devices,
619 and all passthrough devices that provide access to CDROM drives.
620 .El
621 .Sh FILES
622 .Bl -tag -width /boot/kernel/kernel -compact
623 .It Pa /boot/kernel/kernel
624 For the namelist.
625 .It Pa /dev/kmem
626 For information in main memory.
627 .It Pa /etc/hosts
628 For host names.
629 .It Pa /etc/networks
630 For network names.
631 .It Pa /etc/services
632 For port names.
633 .El
634 .Sh SEE ALSO
635 .Xr netstat 1 ,
636 .Xr kvm 3 ,
637 .Xr icmp 4 ,
638 .Xr icmp6 4 ,
639 .Xr ip 4 ,
640 .Xr ip6 4 ,
641 .Xr tcp 4 ,
642 .Xr udp 4 ,
643 .Xr gstat 8 ,
644 .Xr iostat 8 ,
645 .Xr vmstat 8
646 .Sh HISTORY
647 The
648 .Nm
649 program appeared in
650 .Bx 4.3 .
651 The
652 .Ic icmp ,
653 .Ic ip ,
654 and
655 .Ic tcp
656 displays appeared in
657 .Fx 3.0 ;
658 the notion of having different display modes for the
659 .Tn ICMP ,
660 .Tn IP ,
661 .Tn TCP ,
662 and
663 .Tn UDP
664 statistics was stolen from the
665 .Fl C
666 option to
667 .Xr netstat 1
668 in Silicon Graphics'
669 .Tn IRIX
670 system.
671 .Sh BUGS
672 Certain displays presume a minimum of 80 characters per line.
673 The
674 .Ic vmstat
675 display looks out of place because it is (it was added in as
676 a separate display rather than created as a new program).