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