proper merge

[nfs-utils.git] / utils / nfsstat / nfsstat.man

diff --git a/utils/nfsstat/nfsstat.man b/utils/nfsstat/nfsstat.man
index eb548cb202c71da83d0deed652f87ff306ac3650..cd573b071ee68ef3f1d957a56fe33c6a6912db87 100644 (file)
--- a/utils/nfsstat/nfsstat.man
+++ b/utils/nfsstat/nfsstat.man
@@ -2,7 +2,7 @@
 .\" nfsstat(8)
 .\" 
 .\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de>
 .\" nfsstat(8)
 .\" 
 .\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de>

-.TH nfsstat 8 "11 Apr 2005"
+.TH nfsstat 8 "7 Aug 2007"

 .SH NAME
 nfsstat \- list NFS statistics
 .SH SYNOPSIS
 .SH NAME
 nfsstat \- list NFS statistics
 .SH SYNOPSIS


@@ -30,12 +30,14 @@ Print only NFS v2 statistics. The default is to only print information
 about the versions of \fBNFS\fR that have non-zero counts.
 .TP
 .B \-3
 about the versions of \fBNFS\fR that have non-zero counts.
 .TP
 .B \-3

-Print only NFS v3 statistics. 
+Print only NFS v3 statistics. The default is to only print information
+about the versions of \fBNFS\fR that have non-zero counts.

 .TP
 .B \-4
 .TP
 .B \-4

-Print only NFS v4 statistics. 
+Print only NFS v4 statistics. The default is to only print information
+about the versions of \fBNFS\fR that have non-zero counts.

 .TP
 .TP

-.B \-m, \-\-mounted
+.B \-m, \-\-mounts

 Print information about each of the mounted \fBNFS\fR file systems.
 
 If this option is used, all other options are ignored.
 Print information about each of the mounted \fBNFS\fR file systems.
 
 If this option is used, all other options are ignored.


@@ -71,6 +73,43 @@ Display all of the above facilities.
 .TP
 .B \-v, \-\-verbose
 This is equivalent to \fB\-o all\fR.
 .TP
 .B \-v, \-\-verbose
 This is equivalent to \fB\-o all\fR.

+.TP
+.B \-l, \-\-list
+Print information in list form.
+.TP
+.BI "\-S, \-\-since " file
+Instead of printing current statistics, 
+.B nfsstat
+imports statistics from
+.I file
+and displays the difference between those and the current statistics.
+Valid input
+.IR file "s may be in the form of "
+.B /proc/net/rpc/nfs
+(raw client stats),
+.B /proc/net/rpc/nfsd
+(raw server stats), or saved output from
+.B nfsstat
+itself (client and/or server stats).   Any statistics missing from a saved
+.B nfsstat
+output 
+.I file
+are treated as zeroes.
+.TP
+.B \-Z[interval], \-\-sleep=[interval]
+Instead of printing current statistics and immediately exiting,
+.B nfsstat
+takes a snapshot of the current statistics and pauses until it receives
+.B SIGINT
+(typically from
+.BR Ctrl-C ),
+at which point it takes another snapshot and displays the difference
+between the two.
+If \fIinterval\fR is specified, 
+.B nfsstat
+will print the number of \fBNFS\fR calls made since the previous report.
+Stats will be printed repeatedly every \fIinterval\fR seconds.
+.\" --------------------- EXAMPLES -------------------------------

 .SH EXAMPLES
 .TP
 .B nfsstat \-o all \-234
 .SH EXAMPLES
 .TP
 .B nfsstat \-o all \-234


@@ -80,7 +119,7 @@ Show all information about all versions of \fBNFS\fR.
 Same as above.
 .TP
 .B nfsstat \-o all
 Same as above.
 .TP
 .B nfsstat \-o all

-Show all information about about active versions of \fBNFS\fR.
+Show all information about active versions of \fBNFS\fR.

 .TP
 .B nfsstat \-\-nfs \-\-server \-3
 Show statistics for \fBNFS\fR version 3 server.
 .TP
 .B nfsstat \-\-nfs \-\-server \-3
 Show statistics for \fBNFS\fR version 3 server.


@@ -111,7 +150,7 @@ interface to the mounted filesystems.
 .BR nfs (5).
 .\" ---------------------- BUGS ----------------------------------
 .SH BUGS
 .BR nfs (5).
 .\" ---------------------- BUGS ----------------------------------
 .SH BUGS

-The default output has be changed.  To get the old default output you must run \fBnfsstat \-\-auto \-2\fR.
+The default output has been changed.  To get the old default output you must run \fBnfsstat \-\-auto \-2\fR.

 .P
 The function of the \fB\-v\fR and \fB\-a\fR options have changed. The \fB\-a\fR option
 is now reserved for future use. The \fB\-v\fR does what the \fB\-a\fR option used to do,
 .P
 The function of the \fB\-v\fR and \fB\-a\fR options have changed. The \fB\-a\fR option
 is now reserved for future use. The \fB\-v\fR does what the \fB\-a\fR option used to do,