All of lore.kernel.org
 help / color / mirror / Atom feed
From: Scott Mayhew <smayhew@redhat.com>
To: linux-nfs@vger.kernel.org
Subject: [nfs-utils PATCH v2 14/17] mountstats: Updated the mountstats(8) man page.
Date: Wed, 26 Nov 2014 14:13:52 -0500	[thread overview]
Message-ID: <1417029235-37675-15-git-send-email-smayhew@redhat.com> (raw)
In-Reply-To: <1417029235-37675-1-git-send-email-smayhew@redhat.com>

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 --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>
-- 
1.9.3


  parent reply	other threads:[~2014-11-26 19:14 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-26 19:13 [nfs-utils PATCH v2 00/17] A few enhancements to mountstats.py Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 01/17] mountstats: Fix up NFS event counters Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 02/17] mountstats: Add lists of various counters Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 03/17] mountstats: Refactor __parse_nfs_line and __parse_rpc_line Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 04/17] mountstats: Refactor compare_iostats Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 05/17] mountstats: Convert existing option parsing to use the argparse module Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 06/17] mountstats: Make ms-iostat output match that of nfs-iostat.py Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 07/17] mountstats: Make print_iostat_summary handle newly appearing mounts Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 08/17] mountstats: Add support for -f/--file to the mountstats and ms-iostat commands Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 09/17] mountstats: Add support for -S/--since " Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 10/17] mountstats: Fix IndexError in __parse_nfs_line Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 11/17] mountstats: Allow mountstats_command to take a variable number of mountpoints Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 12/17] mountstats: Add support for -R/--raw to mountstats_command Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 13/17] mountstats: Implement nfsstat_command Scott Mayhew
2014-11-26 19:13 ` Scott Mayhew [this message]
2014-11-26 19:13 ` [nfs-utils PATCH v2 15/17] mountstats: Added man page for ms-iostat(8) Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 16/17] mountstats: Added man page for ms-nfsstat(8) Scott Mayhew
2014-11-26 19:13 ` [nfs-utils PATCH v2 17/17] mountstats: add ms-iostat and ms-nfsstat to Makefile.am Scott Mayhew
2014-12-02 17:20 ` [nfs-utils PATCH v2 00/17] A few enhancements to mountstats.py Chuck Lever

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1417029235-37675-15-git-send-email-smayhew@redhat.com \
    --to=smayhew@redhat.com \
    --cc=linux-nfs@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.