xref: /freebsd/usr.sbin/gstat/gstat.8 (revision fbbe961c4124ef4fd33755802a390d1ef533e618)
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 March 3, 2003
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 d
37.Op Fl I Ar interval
38.Sh DESCRIPTION
39The
40.Nm
41utility can be used to monitor I/O transactions of
42.Xr geom 4
43devices.
44.Pp
45The options are as follows:
46.Bl -tag -width indent
47.It Fl c
48Enable display of
49.Xr geom 4
50consumers too.
51The default is to show statistics only for
52.Xr geom 4
53producers.
54.It Fl d
55Enable display of statistics for delete (BIO_DELETE) operations.
56.It Fl I Ar interval
57Refresh the
58.Nm
59display every
60.Ar interval
61microseconds.
62Adding a suffix of
63.Cm s , ms ,
64or
65.Cm us
66(the default) indicates that the update interval is specified in
67seconds, milliseconds, or microseconds, respectively.
68.El
69.Sh DIAGNOSTICS
70.Ex -std
71.Sh SEE ALSO
72.Xr geom 4
73.Sh HISTORY
74A
75.Nm
76utility appeared in
77.Fx 5.0 .
78.Sh BUGS
79The
80.Nm
81utility only works interactively.
82It should probably detect when it is run non-interactively and produce
83simple
84.Tn ASCII
85text output.
86Otherwise, this utility should probably be folded into
87.Xr systat 1
88which only works interactively and is the obvious utility to run for
89various other forms of system statistics.
90