diff mbox

[nfs-utils,v2,16/17] mountstats: Added man page for ms-nfsstat(8)

Message ID 1417029235-37675-17-git-send-email-smayhew@redhat.com (mailing list archive)
State New, archived
Headers show

Commit Message

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

Patch

diff --git a/tools/mountstats/ms-nfsstat.man b/tools/mountstats/ms-nfsstat.man
new file mode 100644
index 0000000..53bfb30
--- /dev/null
+++ b/tools/mountstats/ms-nfsstat.man
@@ -0,0 +1,49 @@ 
+.\"
+.\" ms-nfsstat(8)
+.\"
+.TH ms-nfsstat 8 "25 Nov 2014"
+.SH NAME
+ms-nfsstat \- nfsstat-like program that uses NFS client per-mount statistics
+.SH SYNOPSIS
+.BI "ms-nfsstat [" OPTIONS "] [" mountpoint " [" mountpoint "] " ...  " ]" 
+.SH DESCRIPTION
+The
+.B ms-nfsstat
+command is an nfsstat-like program to display NFS client statistics generated from /proc/self/mountstats instead of from /proc/net/rpc/nfs.
+.P
+If one or more
+.I mountpoint
+names are specified, statistics for only these mount points will be displayed.  Otherwise, statistics for 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
+Read stats from
+.I INFILE
+instead of /proc/self/mountstats.
+.TP
+\fB\-S \fISINCE\fR, \fB\-\-since \fISINCE
+Show difference between current stats and those in
+.IR SINCE .
+.TP
+.B -3
+Show only NFS version 3 statistics.  The default is to show both version 3 and version 4 statistics.
+.TP
+.B -4
+Show only NFS version 4 statistics.  The default is to show both version 3 and version 4 statistics.
+.SH FILES
+.TP
+.B /proc/self/mountstats
+.SH SEE ALSO
+.BR iostat (8),
+.BR nfsiostat (8),
+.BR nfsstat (8),
+.BR mountstats (8),
+.BR ms-iostat (8)
+.SH AUTHOR
+Chuck Lever <chuck.lever@oracle.com>