d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c847212986
freebsd-skq/usr.sbin/gstat/gstat.8

112 lines
3.0 KiB
Groff
Raw Normal View History

Add a small manpage.
2003-03-22 09:44:56 +00:00
.\" Copyright (c) 2003 Giorgos Keramidas
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
- Add CSV output to gstat via -C flag. Add a -C option, similar to -B, that allows gstat to produce basic CSV output with absolute timestamps (ISO 8601, nearly.) Multiple devices are handled by way of a single-pivot CSV table with duplicated timestamps for each object output. Submitted by: Nick Principe <nap__ixsystems.com> Reviewed by: myself, imp@, asomers (earlier verison), bcr (manpages) Sponsored by: iXsystems Inc. Differential Revision: https://reviews.freebsd.org/D16151
2018-08-21 11:22:49 +00:00
.Dd August 21, 2018
Add a small manpage.
2003-03-22 09:44:56 +00:00
.Dt GSTAT 8
.Os
.Sh NAME
.Nm gstat
Sigh, I guess this manpage used cat(1) as a template? Otherwise, fix the manpage to not use the second person, and add two missing punctuation bits.
2003-05-31 18:19:50 +00:00
.Nd print statistics about GEOM disks
Add a small manpage.
2003-03-22 09:44:56 +00:00
.Sh SYNOPSIS
.Nm
Add flag -B which does the same like batch mode but without exiting after print. Also add a new flag -s that add blocks size to statistics. PR: 198347, 212726 Submitted by: Ben RUBSON <ben.rubson@gmail.com> Tested by: pi MFC After: 2 weeks.
2016-11-09 07:31:39 +00:00
.Op Fl abBcdops
- Add support for filtering the the list of providers by a regular expression, which makes it possible to only see interesting providers. "f" is used inside gstat to set a filter, "F" is used to remove current filter. - Do not print some uninteresting values in the gstat title line. - Do not print past the end of the screen. - Read multiple keystrokes per "wait" when gstat is running. - Remove a redundant != check, right after check of NULL against the same variable ("gid"). - Use sysexits.h. - Do not link against libkvm and libsbuf, they are not actually used. - Fix a few style(9) issues where I had to touch nearby code anyway. Approved by: cperciva (mentor) MFC after: 2 weeks
2006-05-20 19:17:47 +00:00
.Op Fl f Ar filter
Add a small manpage.
2003-03-22 09:44:56 +00:00
.Op Fl I Ar interval
.Sh DESCRIPTION
The
.Nm
utility can be used to monitor I/O transactions of
.Xr geom 4
devices.
.Pp
The options are as follows:
.Bl -tag -width indent
Add an '-a' switch to only display providers that are at least 0.1% busy. OK'ed by: phk
2004-10-10 16:13:11 +00:00
.It Fl a
Only display providers that are at least 0.1% busy.
- Allow gstat to print values to different kind of outputs. - Introduce batch mode, where gstat will collect the numbers, print them, and exit. - Document batch mode in the gstat man page. Submitted by: anders
2008-10-07 10:25:27 +00:00
.It Fl b
o Turn the batch mode on if stdout is not tty. Submitted by: vsevolod MFC after: 1 week
2009-03-12 13:17:46 +00:00
Batch mode.
Collect numbers, print and exit.
Default if stdout is not a tty.
Add flag -B which does the same like batch mode but without exiting after print. Also add a new flag -s that add blocks size to statistics. PR: 198347, 212726 Submitted by: Ben RUBSON <ben.rubson@gmail.com> Tested by: pi MFC After: 2 weeks.
2016-11-09 07:31:39 +00:00
.It Fl B
Endless batch mode.
Same as batch mode, but does not exit after collecting
the first set of data.
Add a small manpage.
2003-03-22 09:44:56 +00:00
.It Fl c
Enable display of
.Xr geom 4
consumers too.
The default is to show statistics only for
.Xr geom 4
producers.
- Add CSV output to gstat via -C flag. Add a -C option, similar to -B, that allows gstat to produce basic CSV output with absolute timestamps (ISO 8601, nearly.) Multiple devices are handled by way of a single-pivot CSV table with duplicated timestamps for each object output. Submitted by: Nick Principe <nap__ixsystems.com> Reviewed by: myself, imp@, asomers (earlier verison), bcr (manpages) Sponsored by: iXsystems Inc. Differential Revision: https://reviews.freebsd.org/D16151
2018-08-21 11:22:49 +00:00
.It Fl C
CSV output mode.
Implies endless batch mode, but output is in the form of comma-separated
values, with ISO 8601-like timestamps.
Add -d flag to monitor BIO_DELETE operations too
2004-02-15 09:34:08 +00:00
.It Fl d
Markup nits.
2004-06-04 19:23:12 +00:00
Enable display of statistics for delete
.Pq Dv BIO_DELETE
operations.
- Add support for filtering the the list of providers by a regular expression, which makes it possible to only see interesting providers. "f" is used inside gstat to set a filter, "F" is used to remove current filter. - Do not print some uninteresting values in the gstat title line. - Do not print past the end of the screen. - Read multiple keystrokes per "wait" when gstat is running. - Remove a redundant != check, right after check of NULL against the same variable ("gid"). - Use sysexits.h. - Do not link against libkvm and libsbuf, they are not actually used. - Fix a few style(9) issues where I had to touch nearby code anyway. Approved by: cperciva (mentor) MFC after: 2 weeks
2006-05-20 19:17:47 +00:00
.It Fl f Ar filter
A regular expression that can be used to only show statistics for some
devices.
Language tweak.
2006-09-29 16:51:29 +00:00
Only devices with the names matching
- Add support for filtering the the list of providers by a regular expression, which makes it possible to only see interesting providers. "f" is used inside gstat to set a filter, "F" is used to remove current filter. - Do not print some uninteresting values in the gstat title line. - Do not print past the end of the screen. - Read multiple keystrokes per "wait" when gstat is running. - Remove a redundant != check, right after check of NULL against the same variable ("gid"). - Use sysexits.h. - Do not link against libkvm and libsbuf, they are not actually used. - Fix a few style(9) issues where I had to touch nearby code anyway. Approved by: cperciva (mentor) MFC after: 2 weeks
2006-05-20 19:17:47 +00:00
.Ar filter
will be displayed.
The format of the regular expression is described in
.Xr re_format 7 .
Add -o option to gstat to display "other" operatins (e.g. BIO_FLUSH). MFC after: 1 week
2014-05-17 15:26:08 +00:00
.It Fl o
Enable display of statistics for other operations
.Pq Dv BIO_FLUSH .
Add flag -B which does the same like batch mode but without exiting after print. Also add a new flag -s that add blocks size to statistics. PR: 198347, 212726 Submitted by: Ben RUBSON <ben.rubson@gmail.com> Tested by: pi MFC After: 2 weeks.
2016-11-09 07:31:39 +00:00
.It Fl s
Enable blocks' size statistics.
Add a small manpage.
2003-03-22 09:44:56 +00:00
.It Fl I Ar interval
Refresh the
.Nm
display every
.Ar interval
microseconds.
Sigh, I guess this manpage used cat(1) as a template? Otherwise, fix the manpage to not use the second person, and add two missing punctuation bits.
2003-05-31 18:19:50 +00:00
Adding a suffix of
.Cm s , ms ,
Add a small manpage.
2003-03-22 09:44:56 +00:00
or
.Cm us
Sigh, I guess this manpage used cat(1) as a template? Otherwise, fix the manpage to not use the second person, and add two missing punctuation bits.
2003-05-31 18:19:50 +00:00
(the default) indicates that the update interval is specified in
seconds, milliseconds, or microseconds, respectively.
Add an option, -p, which makes gstat(8) to only display physical providers (those with rank of 1). MFC after: 2 weeks
2014-07-03 21:48:19 +00:00
.It Fl p
Only display physical providers (those with rank of 1).
Add a small manpage.
2003-03-22 09:44:56 +00:00
.El
Added the EXIT STATUS section where appropriate.
2005-01-17 07:44:44 +00:00
.Sh EXIT STATUS
Add a small manpage.
2003-03-22 09:44:56 +00:00
.Ex -std
.Sh SEE ALSO
Add cross-references to iostat, systat and vmstat.
2005-05-27 00:21:12 +00:00
.Xr systat 1 ,
.Xr geom 4 ,
.Xr iostat 8 ,
.Xr vmstat 8
Add a small manpage.
2003-03-22 09:44:56 +00:00
.Sh HISTORY
A
.Nm
utility appeared in
.Fx 5.0 .
Reference in New Issue Copy Permalink