xref: /freebsd/usr.bin/systat/systat.1 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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 curses 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 systat  .
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 systat  .
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 systat  .
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. (the default is to
243not display kilobytes per transaction).
244.El
245.It Ic swap
246Show information about swap space usage on all the
247swap areas compiled into the kernel.
248The first column is the device name of the partition.
249The next column is the total space available in the partition.
250The
251.Ar Used
252column indicates the total blocks used so far;
253the graph shows the percentage of space in use on each partition.
254If there are more than one swap partition in use,
255a total line is also shown.
256Areas known to the kernel, but not in use are shown as not available.
257.It Ic mbufs
258Display, in the lower window, the number of mbufs allocated
259for particular uses, i.e. data, socket structures, etc.
260.It Ic vmstat
261Take over the entire display and show a (rather crowded) compendium
262of statistics related to virtual memory usage, process scheduling,
263device interrupts, system name translation cacheing, disk
264.Tn I/O
265etc.
266.Pp
267The upper left quadrant of the screen shows the number
268of users logged in and the load average over the last one, five,
269and fifteen minute intervals.
270Below this line are statistics on memory utilization.
271The first row of the table reports memory usage only among
272active processes, that is processes that have run in the previous
273twenty seconds.
274The second row reports on memory usage of all processes.
275The first column reports on the number of physical pages
276claimed by processes.
277The second column reports the number of physical pages that
278are devoted to read only text pages.
279The third and fourth columns report the same two figures for
280virtual pages, that is the number of pages that would be
281needed if all processes had all of their pages.
282Finally the last column shows the number of physical pages
283on the free list.
284.Pp
285Below the memory display is a list of the
286average number of processes (over the last refresh interval)
287that are runnable (`r'), in page wait (`p'),
288in disk wait other than paging (`d'),
289sleeping (`s'), and swapped out but desiring to run (`w').
290The row also shows the average number of context switches
291(`Csw'), traps (`Trp'; includes page faults), system calls (`Sys'),
292interrupts (`Int'), network software interrupts (`Sof'), and page
293faults (`Flt').
294.Pp
295Below the process queue length listing is a numerical listing and
296a bar graph showing the amount of
297system (shown as `='), interrupt (shown as `+'), user (shown as `>'),
298nice (shown as `-'), and idle time (shown as ` ').
299.Pp
300Below the process display are statistics on name translations.
301It lists the number of names translated in the previous interval,
302the number and percentage of the translations that were
303handled by the system wide name translation cache, and
304the number and percentage of the translations that were
305handled by the per process name translation cache.
306.Pp
307At the bottom left is the disk usage display.
308It reports the number of
309kilobytes per transaction, transactions per second, megabytes
310per second and the percentage of the time the disk was busy averaged
311over the refresh period of the display (by default, five seconds).
312The system keeps statistics on most every storage device.  In general, up
313to seven devices are displayed.  The devices displayed by default are the
314first devices in the kernel's device list.  See
315.Xr devstat 3
316and
317.Xr devstat 9
318for details on the devstat system.
319.Pp
320Under the date in the upper right hand quadrant are statistics
321on paging and swapping activity.
322The first two columns report the average number of pages
323brought in and out per second over the last refresh interval
324due to page faults and the paging daemon.
325The third and fourth columns report the average number of pages
326brought in and out per second over the last refresh interval
327due to swap requests initiated by the scheduler.
328The first row of the display shows the average
329number of disk transfers per second over the last refresh interval;
330the second row of the display shows the average
331number of pages transferred per second over the last refresh interval.
332.Pp
333Below the paging statistics is a column of lines regarding the virtual
334memory system which list the average number of
335pages copied on write (`cow'),
336pages zero filled on demand (`zfod'),
337slow (on-the-fly) zero fills percentage (`%slo-z'),
338pages wired down (`wire'),
339active pages (`act'),
340inactive pages (`inact'),
341pages on the buffer cache queue (`cache'),
342number of free pages (`free'),
343pages freed by the page daemon (`daefr'),
344pages freed by exiting processes (`prcfr'),
345pages reactivated from the free list (`react'),
346times the page daemon was awakened (`pdwak'),
347pages analyzed by the page daemon (`pdpgs'),
348and
349intransit blocking page faults (`intrn')
350per second over the refresh interval.
351.Pp
352At the bottom of this column are lines showing the
353amount of memory, in kilobytes, used for the buffer cache (`buf'),
354the number of dirty buffers in the buffer cache (`dirtybuf'),
355desired maximum size of vnode cache (`desiredvnodes') (mostly unused,
356except to size the name cache),
357number of vnodes actually allocated (`numvnodes'),
358and
359number of allocated vnodes that are free (`freevnodes').
360.Pp
361Running down the right hand side of the display is a breakdown
362of the interrupts being handled by the system.
363At the top of the list is the total interrupts per second
364over the time interval.
365The rest of the column breaks down the total on a device
366by device basis.
367Only devices that have interrupted at least once since boot time are shown.
368.Pp
369The following commands are specific to the
370.Ic vmstat
371display; the minimum unambiguous prefix may be supplied.
372.Pp
373.Bl -tag -width Ar -compact
374.It Cm boot
375Display cumulative statistics since the system was booted.
376.It Cm run
377Display statistics as a running total from the point this
378command is given.
379.It Cm time
380Display statistics averaged over the refresh interval (the default).
381.It Cm want_fd
382Toggle the display of fd devices in the disk usage display.
383.It Cm zero
384Reset running statistics to zero.
385.El
386.It Ic netstat
387Display, in the lower window, network connections.  By default,
388network servers awaiting requests are not displayed.  Each address
389is displayed in the format ``host.port'', with each shown symbolically,
390when possible.  It is possible to have addresses displayed numerically,
391limit 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
396Toggle the displaying of server processes awaiting requests (this
397is the equivalent of the
398.Fl a
399flag to
400.Xr netstat 1 ) .
401.It Cm numbers
402Display network addresses numerically.
403.It Cm names
404Display network addresses symbolically.
405.It Cm proto Ar protocol
406Display only network connections using the indicated
407.Ar protocol .
408Supported protocols are ``tcp'', ``udp'', and ``all''.
409.It Cm ignore Op Ar items
410Do not display information about connections associated with
411the specified hosts or ports.  Hosts and ports may be specified
412by name (``vangogh'', ``ftp''), or numerically.  Host addresses
413use the Internet dot notation (``128.32.0.9'').  Multiple items
414may be specified with a single command by separating them with
415spaces.
416.It Cm display Op Ar items
417Display information about the connections associated with the
418specified hosts or ports.  As for
419.Ar ignore  ,
420.Op Ar items
421may be names or numbers.
422.It Cm show Op Ar ports\&|hosts
423Show, on the command line, the currently selected protocols,
424hosts, and ports.  Hosts and ports which are being ignored
425are prefixed with a `!'.  If
426.Ar ports
427or
428.Ar hosts
429is supplied as an argument to
430.Cm show  ,
431then only the requested information will be displayed.
432.It Cm reset
433Reset the port, host, and protocol matching mechanisms to the default
434(any protocol, port, or host).
435.El
436.El
437.Pp
438Commands to switch between displays may be abbreviated to the
439minimum unambiguous prefix; for example, ``io'' for ``iostat''.
440Certain information may be discarded when the screen size is
441insufficient for display.  For example, on a machine with 10
442drives the
443.Ic iostat
444bar graph displays only 3 drives on a 24 line terminal.  When
445a bar graph would overflow the allotted screen space it is
446truncated and the actual value is printed ``over top'' of the bar.
447.Pp
448The following commands are common to each display which shows
449information about disk drives.  These commands are used to
450select a set of drives to report on, should your system have
451more drives configured than can normally be displayed on the
452screen.
453.Pp
454.Bl -tag -width Tx -compact
455.It Cm ignore Op Ar drives
456Do not display information about the drives indicated.  Multiple
457drives may be specified, separated by spaces.
458.It Cm display Op Ar drives
459Display information about the drives indicated.  Multiple drives
460may be specified, separated by spaces.
461.It Cm only Op Ar drives
462Display only the specified drives.  Multiple drives may be specified,
463separated by spaces.
464.It Cm drives
465Display a list of available devices.
466.It Cm match Ar type,if,pass Op Ar | ...
467Display devivces matching the given pattern.  The basic matching
468expressions are the same as those used in
469.Xr iostat 8
470with one difference.  Instead of specifying multiple
471.Fl t
472arguments which are then ORed together, the user instead specifys multiple
473matching expressions joined by the pipe ( | ) character.  The comma
474separated arguments within each matching expression are ANDed together, and
475then the pipe separated matching expressions are ORed together.  Any
476device matching the combined expression will be displayed, if there is room
477to display it.  For example:
478.Pp
479.Dl match da,scsi | cd,ide
480.Pp
481This will display all SCSI Direct Access devices and all IDE CDROM devices.
482.Pp
483.Dl match da | sa | cd,pass
484.Pp
485This will display all Direct Access devices, all Sequential Access devices,
486and all passthrough devices that provide access to CDROM drives.
487.El
488.Sh SEE ALSO
489.Xr iostat 8 ,
490.Xr netstat 1 ,
491.Xr vmstat 8 ,
492.Xr icmp 4 ,
493.Xr ip 4 ,
494.Xr tcp 4 ,
495.Xr udp 4
496.Sh FILES
497.Bl -tag -width /etc/networks -compact
498.It Pa /kernel
499For the namelist.
500.It Pa /dev/kmem
501For information in main memory.
502.It Pa /dev/drum
503For information about swapped out processes.
504.It Pa /etc/hosts
505For host names.
506.It Pa /etc/networks
507For network names.
508.It Pa /etc/services
509For port names.
510.El
511.Sh HISTORY
512The
513.Nm
514program appeared in
515.Bx 4.3 .
516The
517.Ic icmp ,
518.Ic ip ,
519and
520.Ic tcp
521displays appeared in
522.Fx 3.0 ;
523the notion of having different display modes for the
524.Tn ICMP ,
525.Tn IP ,
526.Tn TCP ,
527and
528.Tn UDP
529statistics was stolen from the
530.Fl C
531option to
532.Xr netstat 1
533in Silicon Graphics'
534.Tn IRIX
535system.
536.Sh BUGS
537Takes 2-10 percent of the cpu.
538Certain displays presume a minimum of 80 characters per line.
539The
540.Ic vmstat
541display looks out of place because it is (it was added in as
542a separate display rather than created as a new program).
543