diff mbox

[nfs-utils,v3,15/17] mountstats: Added man page for ms-iostat(8)

Message ID 1418068645-10134-16-git-send-email-smayhew@redhat.com (mailing list archive)
State New, archived
Headers show

Commit Message

Scott Mayhew Dec. 8, 2014, 7:57 p.m. UTC
Signed-off-by: Scott Mayhew <smayhew@redhat.com>
---
 tools/mountstats/ms-iostat.man | 49 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 tools/mountstats/ms-iostat.man
diff mbox

Patch

diff --git a/tools/mountstats/ms-iostat.man b/tools/mountstats/ms-iostat.man
new file mode 100644
index 0000000..a254a37
--- /dev/null
+++ b/tools/mountstats/ms-iostat.man
@@ -0,0 +1,49 @@ 
+.\"
+.\" ms-iostat(8)
+.\"
+.TH ms-iostat 8 "25 Nov 2014"
+.SH NAME
+ms-iostat \- iostat-like program to display NFS client per-mount statistics
+.SH SYNOPSIS
+\fBms-iostat [\fIOPTION\fB]\fR... \fB[\fIinterval\fB] [\fIcount\fB] [\fImountpoint\fB]\fR...
+.SH DESCRIPTION
+.RB "The " ms-iostat " command is an iostat-like program to display NFS client per-mount statistics."
+.P
+.RI "The " interval
+parameter specifies the amount of time in seconds between each report.  The first report contains statistics for the time since each file system was mounted.  Each subsequent report contains statistics collected during the interval since the previous report.
+.P
+.RI "If the " count
+.RI "parameter is specified, the value of " count
+.RI "determines the number of reports generated at " interval
+.RI "seconds apart.  If the " interval
+.RI "parameter is specified without the " count
+parameter, the command generates reports continuously.
+.P
+.RI "If one or more " mountpoint
+names are specified, statistics for only these mount points will be displayed.  Otherwise, all NFS mount points on the client are listed.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+show the help message and exit
+.TP
+.B \-v, \-\-version
+show program's version number and exit
+.TP
+\fB\-f \fIINFILE\fR, \fB\-\-file \fIINFILE
+.RI "Read stats from " INFILE " instead of " /proc/self/mountstats ".  "
+.RI "This may not be used with the " interval " or " count " options."
+.TP
+\fB\-S \fISINCE\fR, \fB\-\-since \fISINCE
+.RI "Show difference between current stats and those in " SINCE ".  "
+.RI "This may not be used with the " interval " or " count " options."
+.SH FILES
+.TP
+.B /proc/self/mountstats
+.SH SEE ALSO
+.BR iostat (8),
+.BR nfsiostat (8),
+.BR nfsstat (8),
+.BR ms-iostat (8),
+.BR ms-nfsstat (8)
+.SH AUTHOR
+Chuck Lever <chuck.lever@oracle.com>