5d83dc4584ac16eaaf29537a09aef07d78df4fd7
[nfs-utils.git] / utils / nfsstat / nfsstat.man
1 .\"
2 .\" nfsstat(8)
3 .\" 
4 .\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de>
5 .TH nfsstat 8 "11 Apr 2005"
6 .SH NAME
7 nfsstat \- list NFS statistics
8 .SH SYNOPSIS
9 .B nfsstat
10 [\fIOPTION\fR]...
11 .SH DESCRIPTION
12 The
13 .B nfsstat
14 displays statistics kept about NFS client and server activity.
15 .SH OPTIONS
16 .TP
17 .B -s, --server
18 Print only server-side statistics. The default is to print both server and
19 client statistics.
20 .TP
21 .B -c, --client
22 Print only client-side statistics.
23 .TP
24 .B -n, --nfs
25 Print only NFS statistics. The default is to print both NFS and RPC
26 information.
27 .TP
28 .B -2
29 Print only NFS v2 statistics. The default is to only print information
30 about the versions of \fBNFS\fR that have non-zero counts.
31 .TP
32 .B -3
33 Print only NFS v3 statistics. 
34 .TP
35 .B -4
36 Print only NFS v4 statistics. 
37 .TP
38 .B -m, --mounted
39 Print information about each of the mounted \fBNFS\fR file systems.
40
41 If this option is used, all other options are ignored.
42 .TP
43 .B -r, --rpc
44 Print only RPC statistics.
45 .TP
46 .BI -o " facility
47 Display statistics for the specified facility, which must be one of:
48 .RS
49 .TP
50 .B nfs
51 NFS protocol information, split up by RPC call.
52 .TP
53 .B rpc
54 General RPC information.
55 .TP
56 .B net
57 Network layer statistics, such as the number of received packets, number
58 of TCP connections, etc.
59 .TP
60 .B fh
61 Usage information on the server's file handle cache, including the
62 total number of lookups, and the number of hits and misses.
63 .TP
64 .B rc
65 Usage information on the server's request reply cache, including the
66 total number of lookups, and the number of hits and misses.
67 .TP
68 .B all
69 Display all of the above facilities.
70 .RE
71 .TP
72 .B -v, --verbose
73 This is equivalent to \fB-o all\fR.
74 .SH EXAMPLES
75 .TP
76 .B nfsstat -o all -234
77 Show all information about all versions of \fBNFS\fR.
78 .TP
79 .B nfsstat --verbose -234
80 Same as above.
81 .TP
82 .B nfsstat -o all
83 Show all information about about active versions of \fBNFS\fR.
84 .TP
85 .B nfsstat --nfs --server -3
86 Show statistics for \fBNFS\fR version 3 server.
87 .TP
88 .B nfsstat -m
89 Show information about mounted \fBNFS\fR filesystems.
90 .\" --------------------- DISPLAY --------------------------------
91 .SH DISPLAY
92 The \fBFlags\fR output from the \fB-m\fR option is the same as the
93 flags give to the \fBmount\fR command.
94 .\" --------------------- FILES ----------------------------------
95 .SH FILES
96 .TP
97 .B /proc/net/rpc/nfsd
98 .BR procfs -based
99 interface to kernel NFS server statistics.
100 .TP
101 .B /proc/net/rpc/nfs
102 .BR procfs -based
103 interface to kernel NFS client statistics.
104 .TP
105 .B /proc/mounts
106 .BR procfs -based
107 interface to the mounted filesystems.
108 .\" -------------------- SEE ALSO --------------------------------
109 .SH SEE ALSO
110 .BR rpc.nfsd (8).
111 .BR nfs (5).
112 .\" ---------------------- BUGS ----------------------------------
113 .SH BUGS
114 The default output has be changed.  To get the old default output you must run \fBnfsstat --auto -2\fR.
115 .P
116 The function of the \fB-v\fR and \fB-a\fR options have changed. The \fB-a\fR option
117 is now reserved for future use. The \fB-v\fR does what the \fB-a\fR option used to do,
118 and the new \fB-[234]\fR options replace the \fB-v\fR option.
119 .P
120 The \fBDisplay\fR section should be more complete.
121 .P
122 Further bugs can be found or reported at 
123 .BR http://nfs.sf.net/ .
124 .\" -------------------- AUTHOR ----------------------------------
125 .SH AUTHOR
126 Olaf Kirch, <okir@suse.de>