Documented new options, Added BUGS section.

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

diff --git a/utils/nfsstat/nfsstat.man b/utils/nfsstat/nfsstat.man
index 287f205c149599fab4a23906cce6bcbd0d04d596..747a3e22af995b2b14d77573da501c1ac784d13e 100644 (file)
--- a/utils/nfsstat/nfsstat.man
+++ b/utils/nfsstat/nfsstat.man
@@ -1,30 +1,46 @@
 .\"
 .\" nfsstat(8)
 .\" 
-.\" Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
-.TH nfsstat 8 "05 Oct 2001"
+.\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de>
+.TH nfsstat 8 "11 Apr 2005"
 .SH NAME
-nfsstat \- print NFS statistics
+nfsstat \- list NFS statistics
 .SH SYNOPSIS
-.BI "/usr/sbin/nfsstat [-anrcsz] [-o " "facility" "] ...
+.B nfsstat
+[\fIOPTION\fR]...
 .SH DESCRIPTION
 The
 .B nfsstat
 displays statistics kept about NFS client and server activity.
 .SH OPTIONS
 .TP
-.B -s
+.B -s, --server
 Print only server-side statistics. The default is to print both server and
 client statistics.
 .TP
-.B -c
+.B -c, --client
 Print only client-side statistics.
 .TP
-.B -n
+.B -n, --nfs
 Print only NFS statistics. The default is to print both NFS and RPC
 information.
 .TP
-.B -r
+.B -2
+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
+Print only NFS v3 statistics. 
+.TP
+.B -4
+Print only NFS v4 statistics. 
+.TP
+.B -m, --mounted
+Print information about each of the mounted \fBNFS\fR file systems.
+
+If this option is used, all other options are ignored.
+.TP
+.B -r, --rpc
 Print only RPC statistics.
 .TP
 .BI -o " facility
@@ -48,8 +64,33 @@ total number of lookups, and the number of hits and misses.
 .B rc
 Usage information on the server's request reply cache, including the
 total number of lookups, and the number of hits and misses.
+.TP
+.B all
+Display all of the above facilities.
 .RE
+.TP
+.B -v, --verbose
+This is equivient to \fB-o all\fR.
 .SH EXAMPLES
+.TP
+.B nfsstat -o all -234
+Show all information about all versions of \fBNFS\fR.
+.TP
+.B nfsstat --verbose -234
+Same as above.
+.TP
+.B nfsstat -o all
+Show all information about about active versions of \fBNFS\fR.
+.TP
+.B nfsstat --nfs --server -3
+Show statictics for \fBNFS\fR version 3 server.
+.TP
+.B nfsstat -m
+Show information about mounted \fBNFS\fR filesystems.
+.\" --------------------- DISPLAY --------------------------------
+.SH DISPLAY
+The \fBFlags\fR output from the \fB-m\fR option is the same as the
+flags give to the \fBmount\fR command.
 .\" --------------------- FILES ----------------------------------
 .SH FILES
 .TP
@@ -60,9 +101,26 @@ interface to kernel NFS server statistics.
 .B /proc/net/rpc/nfs
 .BR procfs -based
 interface to kernel NFS client statistics.
+.TP
+.B /proc/mounts
+.BR procfs -based
+interface to the mounted filesystems.
 .\" -------------------- SEE ALSO --------------------------------
 .SH SEE ALSO
 .BR rpc.nfsd (8).
+.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.
+.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,
+and the new \fB-[234]\fR options replace the \fB-v\fR option.
+.P
+The \fBDisplay\fR section should be more commplete.
+.P
+Further bugs can be found or reported at 
+.BR http://nfs.sf.net/ .
 .\" -------------------- AUTHOR ----------------------------------
 .SH AUTHOR
-Olaf Kirch, <okir@monad.swb.de>
+Olaf Kirch, <okir@suse.de>