xref: /freebsd/usr.sbin/gstat/gstat.8 (revision 729362425c09cf6b362366aabc6fb547eee8035a)
1.\" Copyright (c) 2003 Giorgos Keramidas
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd September 15, 2001
28.Dt GSTAT 8
29.Os
30.Sh NAME
31.Nm gstat
32.Nd print statistics about geom disks
33.Sh SYNOPSIS
34.Nm
35.Op Fl c
36.Op Fl I Ar interval
37.Sh DESCRIPTION
38The
39.Nm
40utility can be used to monitor I/O transactions of
41.Xr geom 4
42devices.
43.Pp
44The options are as follows:
45.Bl -tag -width indent
46.It Fl c
47Enable display of
48.Xr geom 4
49consumers too.
50The default is to show statistics only for
51.Xr geom 4
52producers.
53.It Fl I Ar interval
54Refresh the
55.Nm
56display every
57.Ar interval
58microseconds.
59You can add a suffix of
60.Cm s ,
61.Cm ms ,
62or
63.Cm us
64(the default) to indicate that the update interval is specified in
65seconds, milliseconds or microseconds respectively.
66.El
67.Sh DIAGNOSTICS
68.Ex -std
69.Sh SEE ALSO
70.Xr geom 4
71.Sh HISTORY
72A
73.Nm
74utility appeared in
75.Fx 5.0 .
76.Sh BUGS
77The
78.Nm
79utility only works interactively.
80It should probably detect when it is run non-interactively and produce
81simple
82.Tn ASCII
83text output.
84Otherwise, this utility should probably be folded into
85.Xr systat 1
86which only works interactively and is the obvious utility to run for
87various other forms of system statistics.
88