utils/nfsstat/nfsstat.man

   1 .\"
   2 .\" nfsstat(8)
   3 .\"
   4 .\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de>
   5 .TH nfsstat 8 "7 Aug 2007"
   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, \-\-mounts
  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 .TP
  75 .BI "\-S, \-\-since " file
  76 Instead of printing current statistics,
  77 .B nfsstat
  78 imports statistics from
  79 .I file
  80 and displays the difference between those and the current statistics.
  81 Valid input
  82 .IR file "s may be in the form of "
  83 .B /proc/net/rpc/nfs
  84 (raw client stats),
  85 .B /proc/net/rpc/nfsd
  86 (raw server stats), or saved output from
  87 .B nfsstat
  88 itself (client and/or server stats).   Any statistics missing from a saved
  89 .B nfsstat
  90 output
  91 .I file
  92 are treated as zeroes.
  93 .TP
  94 .B \-Z, \-\-sleep
  95 Instead of printing current statistics and immediately exiting,
  96 .B nfsstat
  97 takes a snapshot of the current statistics and pauses until it receives
  98 .B SIGINT
  99 (typically from
 100 .BR Ctrl-C ),
 101 at which point it takes another snapshot and displays the difference
 102 between the two.
 103 .\" --------------------- EXAMPLES -------------------------------
 104 .SH EXAMPLES
 105 .TP
 106 .B nfsstat \-o all \-234
 107 Show all information about all versions of \fBNFS\fR.
 108 .TP
 109 .B nfsstat \-\-verbose \-234
 110 Same as above.
 111 .TP
 112 .B nfsstat \-o all
 113 Show all information about active versions of \fBNFS\fR.
 114 .TP
 115 .B nfsstat \-\-nfs \-\-server \-3
 116 Show statistics for \fBNFS\fR version 3 server.
 117 .TP
 118 .B nfsstat \-m
 119 Show information about mounted \fBNFS\fR filesystems.
 120 .\" --------------------- DISPLAY --------------------------------
 121 .SH DISPLAY
 122 The \fBFlags\fR output from the \fB\-m\fR option is the same as the
 123 flags give to the \fBmount\fR command.
 124 .\" --------------------- FILES ----------------------------------
 125 .SH FILES
 126 .TP
 127 .B /proc/net/rpc/nfsd
 128 .BR procfs -based
 129 interface to kernel NFS server statistics.
 130 .TP
 131 .B /proc/net/rpc/nfs
 132 .BR procfs -based
 133 interface to kernel NFS client statistics.
 134 .TP
 135 .B /proc/mounts
 136 .BR procfs -based
 137 interface to the mounted filesystems.
 138 .\" -------------------- SEE ALSO --------------------------------
 139 .SH SEE ALSO
 140 .BR rpc.nfsd (8).
 141 .BR nfs (5).
 142 .\" ---------------------- BUGS ----------------------------------
 143 .SH BUGS
 144 The default output has been changed.  To get the old default output you must run \fBnfsstat \-\-auto \-2\fR.
 145 .P
 146 The function of the \fB\-v\fR and \fB\-a\fR options have changed. The \fB\-a\fR option
 147 is now reserved for future use. The \fB\-v\fR does what the \fB\-a\fR option used to do,
 148 and the new \fB\-[234]\fR options replace the \fB\-v\fR option.
 149 .P
 150 The \fBDisplay\fR section should be more complete.
 151 .P
 152 Further bugs can be found or reported at
 153 .BR http://nfs.sf.net/ .
 154 .\" -------------------- AUTHOR ----------------------------------
 155 .SH AUTHOR
 156 Olaf Kirch, <okir@suse.de>