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