summaryrefslogtreecommitdiffstats
path: root/usr.bin/systat
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-07-02 22:22:35 +0000
committerru <ru@FreeBSD.org>2004-07-02 22:22:35 +0000
commitfb1d8b3724cde10863de04d2c0884fbc5035eeef (patch)
treeb3cdbab3d24866d3829616606f702cb5cb5d6c97 /usr.bin/systat
parent2334c79a7573e958e33d5cc7301829244e5d216f (diff)
downloadFreeBSD-src-fb1d8b3724cde10863de04d2c0884fbc5035eeef.zip
FreeBSD-src-fb1d8b3724cde10863de04d2c0884fbc5035eeef.tar.gz
Mechanically kill hard sentence breaks.
Diffstat (limited to 'usr.bin/systat')
-rw-r--r--usr.bin/systat/systat.1119
1 files changed, 79 insertions, 40 deletions
diff --git a/usr.bin/systat/systat.1 b/usr.bin/systat/systat.1
index ec550f1..ace79a2 100644
--- a/usr.bin/systat/systat.1
+++ b/usr.bin/systat/systat.1
@@ -52,16 +52,20 @@ using the curses screen display library,
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
+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
+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 show swap space usage, disk
+in the lower window.
+Other displays show swap space usage, disk
.Tn I/O
statistics (a la
.Xr iostat 8 ) ,
@@ -76,7 +80,8 @@ and network connections (a la
Input is interpreted at two different levels.
A ``global'' command interpreter processes all keyboard input.
If this command interpreter fails to recognize a command, the
-input line is passed to a per-display command interpreter. This
+input line is passed to a per-display command interpreter.
+This
allows each display to have certain display-specific commands.
.Pp
Command line options:
@@ -121,7 +126,8 @@ Print the name of the current ``display'' being shown in
the lower window and the refresh interval.
.It Ic \&:
Move the cursor to the command line and interpret the input
-line typed as a command. While entering a command the
+line typed as a command.
+While entering a command the
current character erase, word erase, and line kill characters
may be used.
.El
@@ -140,7 +146,8 @@ Stop refreshing the screen.
.Op Ic start
.Op Ar number
.Xc
-Start (continue) refreshing the screen. If a second, numeric,
+Start (continue) refreshing the screen.
+If a second, numeric,
argument is provided it is interpreted as a refresh interval
(in seconds).
Supplying only a number will set the refresh interval to this
@@ -194,7 +201,8 @@ The
.Ic reset
command resets the baseline for
.Ic since
-mode. The
+mode.
+The
.Ic mode
command with no argument will display the current mode in the command
line.
@@ -228,15 +236,19 @@ but with
statistics.
.It Ic iostat
Display, in the lower window, statistics about processor use
-and disk throughput. Statistics on processor use appear as
+and disk throughput.
+Statistics on processor use appear as
bar graphs of the amount of time executing in user mode (``user''),
in user mode running low priority processes (``nice''), in
system mode (``system''), in interrupt mode (``interrupt''),
-and idle (``idle''). Statistics
+and idle (``idle'').
+Statistics
on disk throughput show, for each drive, megabytes per second,
average number of disk transactions per second, and
-average kilobytes of data per transaction. This information may be
-displayed as bar graphs or as rows of numbers which scroll downward. Bar
+average kilobytes of data per transaction.
+This information may be
+displayed as bar graphs or as rows of numbers which scroll downward.
+Bar
graphs are shown by default.
.Pp
The following commands are specific to the
@@ -247,7 +259,8 @@ display; the minimum unambiguous prefix may be supplied.
.It Cm numbers
Show the disk
.Tn I/O
-statistics in numeric form. Values are
+statistics in numeric form.
+Values are
displayed in numeric columns which scroll downward.
.It Cm bars
Show the disk
@@ -272,7 +285,7 @@ a total line is also shown.
Areas known to the kernel, but not in use are shown as not available.
.It Ic mbufs
Display, in the lower window, the number of mbufs allocated
-for particular uses, i.e. data, socket structures, etc.
+for particular uses, i.e., data, socket structures, etc.
.It Ic vmstat
Take over the entire display and show a (rather crowded) compendium
of statistics related to virtual memory usage, process scheduling,
@@ -325,9 +338,12 @@ It reports the number of
kilobytes per transaction, transactions per second, megabytes
per second and the percentage of the time the disk was busy averaged
over the refresh period of the display (by default, five seconds).
-The system keeps statistics on most every storage device. In general, up
-to seven devices are displayed. The devices displayed by default are the
-first devices in the kernel's device list. See
+The system keeps statistics on most every storage device.
+In general, up
+to seven devices are displayed.
+The devices displayed by default are the
+first devices in the kernel's device list.
+See
.Xr devstat 3
and
.Xr devstat 9
@@ -400,10 +416,13 @@ Toggle the display of fd devices in the disk usage display.
Reset running statistics to zero.
.El
.It Ic netstat
-Display, in the lower window, network connections. By default,
-network servers awaiting requests are not displayed. Each address
+Display, in the lower window, network connections.
+By default,
+network servers awaiting requests are not displayed.
+Each address
is displayed in the format ``host.port'', with each shown symbolically,
-when possible. It is possible to have addresses displayed numerically,
+when possible.
+It is possible to have addresses displayed numerically,
limit the display to a set of ports, hosts, and/or protocols
(the minimum unambiguous prefix may be supplied):
.Pp
@@ -424,21 +443,27 @@ Display only network connections using the indicated
Supported protocols are ``tcp'', ``udp'', and ``all''.
.It Cm ignore Op Ar items
Do not display information about connections associated with
-the specified hosts or ports. Hosts and ports may be specified
-by name (``vangogh'', ``ftp''), or numerically. Host addresses
-use the Internet dot notation (``128.32.0.9''). Multiple items
+the specified hosts or ports.
+Hosts and ports may be specified
+by name (``vangogh'', ``ftp''), or numerically.
+Host addresses
+use the Internet dot notation (``128.32.0.9'').
+Multiple items
may be specified with a single command by separating them with
spaces.
.It Cm display Op Ar items
Display information about the connections associated with the
-specified hosts or ports. As for
+specified hosts or ports.
+As for
.Ar ignore ,
.Op Ar items
may be names or numbers.
.It Cm show Op Ar ports\&|hosts
Show, on the command line, the currently selected protocols,
-hosts, and ports. Hosts and ports which are being ignored
-are prefixed with a `!'. If
+hosts, and ports.
+Hosts and ports which are being ignored
+are prefixed with a `!'.
+If
.Ar ports
or
.Ar hosts
@@ -451,15 +476,18 @@ Reset the port, host, and protocol matching mechanisms to the default
.El
.It Ic ifstat
Display the network traffic going through active interfaces on the
-system. Idle interfaces will not be displayed until they receive some
+system.
+Idle interfaces will not be displayed until they receive some
traffic.
.Pp
For each interface being displayed, the current, peak and total
-statistics are displayed for incoming and outgoing traffic. By default,
+statistics are displayed for incoming and outgoing traffic.
+By default,
the
.Ic ifstat
display will automatically scale the units being used so that they are
-in a human-readable format. The scaling units used for the current and
+in a human-readable format.
+The scaling units used for the current and
peak
traffic columns can be altered by the
.Ic scale
@@ -467,7 +495,8 @@ command.
.Bl -tag -width ".Cm scale Op Ar units"
.It Cm scale Op Ar units
Modify the scale used to display the current and peak traffic over all
-interfaces. The following units are recognised: kbit, kbyte, mbit,
+interfaces.
+The following units are recognised: kbit, kbyte, mbit,
mbyte, gbit, gbyte and auto.
.El
.El
@@ -475,28 +504,34 @@ mbyte, gbit, gbyte and auto.
Commands to switch between displays may be abbreviated to the
minimum unambiguous prefix; for example, ``io'' for ``iostat''.
Certain information may be discarded when the screen size is
-insufficient for display. For example, on a machine with 10
+insufficient for display.
+For example, on a machine with 10
drives the
.Ic iostat
-bar graph displays only 3 drives on a 24 line terminal. When
+bar graph displays only 3 drives on a 24 line terminal.
+When
a bar graph would overflow the allotted screen space it is
truncated and the actual value is printed ``over top'' of the bar.
.Pp
The following commands are common to each display which shows
-information about disk drives. These commands are used to
+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.
.Pp
.Bl -tag -width Ar -compact
.It Cm ignore Op Ar drives
-Do not display information about the drives indicated. Multiple
+Do not display information about the drives indicated.
+Multiple
drives may be specified, separated by spaces.
.It Cm display Op Ar drives
-Display information about the drives indicated. Multiple drives
+Display information about the drives indicated.
+Multiple drives
may be specified, separated by spaces.
.It Cm only Op Ar drives
-Display only the specified drives. Multiple drives may be specified,
+Display only the specified drives.
+Multiple drives may be specified,
separated by spaces.
.It Cm drives
Display a list of available devices.
@@ -504,10 +539,12 @@ Display a list of available devices.
.Ar type , Ns Ar if , Ns Ar pass
.Op | Ar ...
.Xc
-Display devices matching the given pattern. The basic matching
+Display devices matching the given pattern.
+The basic matching
expressions are the same as those used in
.Xr iostat 8
-with one difference. Instead of specifying multiple
+with one difference.
+Instead of specifying multiple
.Fl t
arguments which are then ORed together, the user instead specifies multiple
matching expressions joined by the pipe
@@ -515,9 +552,11 @@ matching expressions joined by the pipe
character.
The comma
separated arguments within each matching expression are ANDed together, and
-then the pipe separated matching expressions are ORed together. Any
+then the pipe separated matching expressions are ORed together.
+Any
device matching the combined expression will be displayed, if there is room
-to display it. For example:
+to display it.
+For example:
.Pp
.Dl match da,scsi | cd,ide
.Pp
OpenPOWER on IntegriCloud