diff mbox

[nfs-utils,v2,14/17] mountstats: Updated the mountstats(8) man page.

Message ID 1417029235-37675-15-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
Updated the mounstats(8) man page to match the --help output.

Signed-off-by: Scott Mayhew <smayhew@redhat.com>
---
 tools/mountstats/mountstats.man | 45 ++++++++++++++++++++++++++++++++---------
 1 file changed, 35 insertions(+), 10 deletions(-)
diff mbox

Patch

diff --git a/tools/mountstats/mountstats.man b/tools/mountstats/mountstats.man
index 0de31b7..1269a8c 100644
--- a/tools/mountstats/mountstats.man
+++ b/tools/mountstats/mountstats.man
@@ -1,32 +1,57 @@ 
 .\"
 .\" mountstats(8)
 .\"
-.TH mountstats 8 "15 Apr 2010"
+.TH mountstats 8 "25 Nov 2014"
 .SH NAME
 mountstats \- Displays NFS client per-mount statistics
 .SH SYNOPSIS
-.BI "mountstats ["<options> "] " <mount_point> " [ " <mount_point> "]" 
+.BI "mountstats [" OPTIONS "] [" mountpoint " [" mountpoint "] " ...  " ]" 
 .SH DESCRIPTION
 The
 .B mountstats
 command displays NFS client statisitics on each given
-.I <mount_point>
+.IR mountpoint .
+.P
+If no
+.I mountpoint
+is given, statistics will be displayed for all NFS mountpoints on the client.
 .SH OPTIONS
 .TP
-.B " \-\-nfs
-display only the NFS statistics
+.B \-h, \-\-help
+show the help message and exit
 .TP
-.B " \-\-rpc 
-display only the RPC statistics
+.B \-v, \-\-version
+show program's version number and exit
 .TP
-.B " \-\-version 
-display the version of this command
+\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
+.I SINCE
+.TP
+.B \-n, \-\-nfs
+Display only the NFS statistics
+.TP
+.B \-r, \-\-rpc 
+Display only the RPC statistics
+.TP
+.B \-R, \-\-raw 
+Display only the raw statistics.  This is intended for use with the
+.B \-f/\-\-file
+and
+.B \-S/\-\-since
+options.
 .SH FILES
 .TP
 .B /proc/self/mountstats
 .SH SEE ALSO
 .BR iostat (8),
 .BR nfsiostat (8),
-.BR nfsstat(8)
+.BR nfsstat (8),
+.BR ms-iostat (8),
+.BR ms-nfsstat (8)
 .SH AUTHOR
 Chuck Lever <chuck.lever@oracle.com>