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