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 cd
  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 c
  47 Enable display of
  48 .Xr geom 4
  49 consumers too.
  50 The default is to show statistics only for
  51 .Xr geom 4
  52 producers.
  53 .It Fl d
  54 Enable display of statistics for delete
  55 .Pq Dv BIO_DELETE
  56 operations.
  57 .It Fl I Ar interval
  58 Refresh the
  59 .Nm
  60 display every
  61 .Ar interval
  62 microseconds.
  63 Adding a suffix of
  64 .Cm s , ms ,
  65 or
  66 .Cm us
  67 (the default) indicates that the update interval is specified in
  68 seconds, milliseconds, or microseconds, respectively.
  69 .El
  70 .Sh DIAGNOSTICS
  71 .Ex -std
  72 .Sh SEE ALSO
  73 .Xr geom 4
  74 .Sh HISTORY
  75 A
  76 .Nm
  77 utility appeared in
  78 .Fx 5.0 .
  79 .Sh BUGS
  80 The
  81 .Nm
  82 utility only works interactively.
  83 It should probably detect when it is run non-interactively and produce
  84 simple
  85 .Tn ASCII
  86 text output.
  87 Otherwise, this utility should probably be folded into
  88 .Xr systat 1
  89 which only works interactively and is the obvious utility to run for
  90 various other forms of system statistics.