usr.sbin/gstat/gstat.8

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