Merge branch 'upstream'
[nfs-utils.git] / tools / nfs-iostat / nfsiostat.man
1 .\"
2 .\" nfsiostat(8)
3 .\"
4 .TH nfsiostat 8 "15 Apr 2010"
5 .SH NAME
6 nfsiostat \- Emulate iostat for NFS mount points using /proc/self/mountstats
7 .SH SYNOPSIS
8 .BI "nfsiostat [[" <interval> "] [" <count> "]] [" <options> "]["<mount_point> "]
9 .SH DESCRIPTION
10 The
11 .B nfsiostat
12 command displays NFS client per-mount statisitics. 
13 .TP 
14 <interval>
15 specifies the amount of time in seconds between each report.
16 The first report contains statistics for the time since each file
17 system was mounted.  Each subsequent report contains statistics collected
18 during the interval since the previous report.
19 .TP
20 <count>
21 If the
22 .I <count>
23 parameter is
24 specified, the value of 
25 .I <count> 
26 determines the number of reports generated at
27 .I <interval> 
28 seconds apart. if the interval parameter is 
29 specified without the
30 .I <count> 
31 parameter, the command generates reports continuously.
32 .TP
33 <options>
34 Define below
35 .TP
36 <mount_point>
37 If one or more
38 .I <mount point> 
39 names are specified, statistics for only these mount points will
40 be displayed.  Otherwise, all NFS mount points on the client are listed.
41 .SH OPTIONS
42 .TP
43 .B \-a " or " \-\-attr
44 displays statistics related to the attribute cache
45 .TP
46 .B \-d " or " \-\-dir 
47 displays statistics related to directory operations
48 .TP
49 .B \-h " or " \-\-help 
50 shows help message and exit
51 .TP
52 .B \-l LIST or " \-\-list=LIST 
53 only print stats for first LIST mount points
54 .TP
55 .B \-p " or " \-\-page
56 displays statistics related to the page cache
57 .TP
58 .B \-s " or " \-\-sort
59 Sort NFS mount points by ops/second
60 .TP
61 .B \-\-version
62 show program's version number and exit
63 .SH FILES
64 .TP
65 .B /proc/self/mountstats
66 .SH SEE ALSO
67 .BR iostat (8),
68 .BR mountstats (8),
69 .BR nfsstat(8)
70 .SH AUTHOR
71 Chuck Lever <chuck.lever@oracle.com>