diff options
Diffstat (limited to 'usr.bin/systat')
| -rw-r--r-- | usr.bin/systat/systat.1 | 113 |
1 files changed, 51 insertions, 62 deletions
diff --git a/usr.bin/systat/systat.1 b/usr.bin/systat/systat.1 index e99252a5f3e..ba6c98b401d 100644 --- a/usr.bin/systat/systat.1 +++ b/usr.bin/systat/systat.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: systat.1,v 1.72 2008/11/08 15:46:49 jmc Exp $ +.\" $OpenBSD: systat.1,v 1.73 2008/11/17 08:10:51 jmc Exp $ .\" $NetBSD: systat.1,v 1.6 1996/05/10 23:16:39 thorpej Exp $ .\" .\" Copyright (c) 1985, 1990, 1993 @@ -30,7 +30,7 @@ .\" .\" @(#)systat.1 8.2 (Berkeley) 12/30/93 .\" -.Dd $Mdocdate: November 8 2008 $ +.Dd $Mdocdate: November 17 2008 $ .Dt SYSTAT 1 .Os .Sh NAME @@ -46,33 +46,25 @@ .Op Ar delay .Sh DESCRIPTION .Nm -displays various system statistics in a screen oriented fashion -using the curses screen display library, -.Xr curses 3 . +displays various system statistics in a screen-oriented fashion +using the +.Xr curses 3 +screen display library. .Pp While .Nm -is running the screen is usually divided into two windows (an exception -is the vmstat display which uses the entire screen). -The upper window depicts the current system load average. -The information displayed in the lower window may vary, depending on -user commands. -The last line on the screen is reserved for user -input and error messages. -.Pp -By default -.Nm -displays the processes getting the largest percentage of the processor -in the lower window. -Other displays include swap space usage, disk I/O -statistics (a la -.Xr iostat 8 ) , -virtual memory statistics (a la -.Xr vmstat 8 ) , -network -.Dq mbuf -utilization, and network connections (a la -.Xr netstat 1 ) . +is running, the screen is divided into differing areas. +The top line depicts the current system load average. +The bottom line of the screen is reserved for +user input and error messages. +The information displayed in the rest of the screen +comprises a +.Em view , +and is the main interface for +displaying differing types of system statistics. +The +.Ic vmstat +view is the default. .Pp Input is interpreted at two different levels. A @@ -95,12 +87,12 @@ screen updates. .It Fl i Interactive mode. .It Fl n -Do not try to reverse-map IP address. +Do not try to reverse map IP addresses. .It Fl s Ar delay Specifies the screen refresh time interval in seconds. This option is overridden by the final .Ar delay -argument if given. +argument, if given. The default interval is 5 seconds. .It Fl w Ar width Specifies the maximum width of the display. @@ -136,11 +128,10 @@ for .It Ar delay The .Ar delay -specifies the screen refresh time interval in seconds. -This is provided for backwards compatibility, and overrides the -.Ar wait +argument specifies the screen refresh time interval in seconds. +This is provided for backwards compatibility, and overrides any interval specified with the -.Fl w +.Fl s flag. The default interval is 5 seconds. .El @@ -164,7 +155,7 @@ Not all views support orderings. Pause .Nm . .It Ic q -Exit +Quit .Nm . .It Ic r Reverse the selected ordering if supported by the view. @@ -178,9 +169,7 @@ Jump to the end of the current view. Select the next view. .It Ic ^G Print the name of the current -.Dq display -being shown in -the lower window and the refresh interval. +view being shown and the refresh interval. .It Ic ^L Refresh the screen. .It Ic ^N \*(Ba Aq Ic down arrow @@ -201,12 +190,12 @@ The following commands are interpreted by the command interpreter. .Bl -tag -width Fl .It Ic help -Print the names of the available displays on the command line. +Print the names of the available views on the command line. .It Ic load Print the load average over the past 1, 5, and 15 minutes on the command line. .It Ic quit -Exit +Quit .Nm . (This may be abbreviated to .Ic q . ) @@ -224,10 +213,9 @@ Supplying only a number will set the refresh interval to this value. .El .Pp -Again, -.Ar display +.Ar view may be abbreviated to the minimum unambiguous prefix. -The available displays are: +The available views are: .Bl -tag -width "netstatXXX" .It Ic buckets Display kernel @@ -235,7 +223,7 @@ Display kernel bucket statistics similar to the output of .Cm vmstat Fl m . .It Ic ifstat -Display, in the lower window, interface statistics. +Display interface statistics. The .Dq State column has the format @@ -258,7 +246,7 @@ in the case of interfaces, whether the interface is in master or backup state, respectively. See below for more options. .It Ic iostat -Display, in the lower window, statistics about disk throughput. +Display statistics about disk throughput. Statistics on disk throughput show, for each drive, data transferred in kilobytes, number of disk transactions performed, and time spent in disk accesses @@ -275,10 +263,11 @@ Available orderings are: and .Ic requests . .It Ic mbufs -Display, in the lower window, the number of mbufs allocated -for particular uses, i.e., data, socket structures, etc. +Display the number of mbufs allocated +for particular uses, +such as data and socket structures. .It Ic netstat -Display, in the lower window, network connections. +Display network connections. By default, network servers awaiting requests are not displayed. Each address is displayed in the format @@ -342,9 +331,9 @@ similar to the output of .Cm pfctl Fl s Cm info option. .It Ic pigs -Display, in the lower window, those processes resident in main +Display those processes resident in main memory and getting the -largest portion of the processor (the default display). +largest portion of the processor. When less than 100% of the processor is scheduled to user processes, the remaining time is accounted to the @@ -368,8 +357,7 @@ queues, similar to the output of Display pf rules statistics, similar to the output of .Cm pfctl Fl s Cm rules . .It Ic sensors -Display, in the lower window, -the current values of available hardware sensors, +Display the current values of available hardware sensors, in a format similar to that of .Xr sysctl 8 . .It Ic states @@ -405,6 +393,7 @@ Areas known to the kernel but not in use are shown as not available. Take over the entire display and show a (rather crowded) compendium of statistics related to virtual memory usage, process scheduling, device interrupts, system name translation caching, disk I/O etc. +This view is the default. .Pp The upper left quadrant of the screen shows the number of users logged in and the load average over the last 1, 5, @@ -550,7 +539,7 @@ The following commands are specific to the .Ic vmstat and .Ic ifstat -displays; the minimum unambiguous prefix may be supplied. +views; the minimum unambiguous prefix may be supplied. .Pp .Bl -tag -width Ds -compact .It Cm boot @@ -574,12 +563,11 @@ truncated and the actual value is printed .Dq over top of the bar. .Pp -The following commands are common to each display which shows +The following commands are common to each view which shows information about disk drives. -These commands are used to -select a set of drives to report on, should your system have -more drives configured than can normally be displayed on the -screen. +These commands are used to select a set of drives to report on, +should a system have more drives configured +than can normally be displayed on the screen. .Pp .Bl -tag -width Tx -compact .It Cm display Op Ar drives @@ -590,15 +578,16 @@ Do not display information about the drives indicated. Multiple drives may be specified, separated by spaces. .El .Sh FILES -.Bl -tag -width /etc/networks -compact +.Bl -tag -width "/etc/networksXXX" -compact .It Pa /etc/hosts -host names +Host names. .It Pa /etc/networks -network names +Network names. .It Pa /etc/pf.conf -pf and altq configuration +.Xr pf 4 +configuration. .It Pa /etc/services -port names +Port names. .El .Sh SEE ALSO .Xt fstat 1 , @@ -615,7 +604,7 @@ port names .Sh HISTORY The .Nm -program appeared in +program first appeared in .Bx 4.3 . .Sh BUGS Certain displays presume a minimum of 80 characters per line. |