freebsd-skq/usr.bin/nfsstat/nfsstat.1

.\" Copyright (c) 1989, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     From: @(#)nfsstat.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd April 23, 2015
.Dt NFSSTAT 1
.Os
.Sh NAME
.Nm nfsstat
.Nd display
.Tn NFS
statistics
.Sh SYNOPSIS
.Nm
.Op Fl cemszW
.Op Fl M Ar core
.Op Fl N Ar system
.Op Fl w Ar wait
.Sh DESCRIPTION
The
.Nm
command displays statistics kept about
.Tn NFS
client and server activity.
For the NFSv4 server, the statistics are for operations within the Compound
RPCs and not the count of RPCs.
If you wish to compare RPC counts between NFSv3 and NFSv4, you must use
statistics in the client(s).
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl c
Only display client side statistics.
.It Fl e
Report the extra statistics collected by the NFS client and
server for NFSv4.
.It Fl M
Extract values associated with the name list from the specified core
instead of the default
.Pa /dev/kmem .
.It Fl m
Report the mount options for all new NFS client mounts.
This option overrides all others and
.Nm
will exit after completing the report.
This option is only supported by the new NFS client.
.It Fl N
Extract the name list from the specified system instead of the default
.Pa /boot/kernel/kernel .
.It Fl s
Only display server side statistics.
.It Fl W
Use wide format with interval short summary.
This option is especially
useful when combined with
.Fl c
or
.Fl s
and a time delay.
.It Fl w
Display a shorter summary of
.Tn NFS
activity for both the client and server at
.Ar wait
second intervals.
.It Fl z
Reset statistics after displaying them.
.El
.Sh FILES
.Bl -tag -width ".Pa /boot/kernel/kernel" -compact
.It Pa /boot/kernel/kernel
default kernel namelist
.It Pa /dev/kmem
default memory file
.El
.Sh SEE ALSO
.Xr fstat 1 ,
.Xr netstat 1 ,
.Xr ps 1 ,
.Xr systat 1 ,
.Xr sysctl 3 ,
.Xr iostat 8 ,
.Xr nfsdumpstate 8 ,
.Xr pstat 8 ,
.Xr vmstat 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.4 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1989, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Use new NFS sysctl interface to get statistics rather than reading /dev/kmem, unless the user specifies a dead kernel to operate on. 1994-10-23 23:25:43 +00:00			`.\" From: @(#)nfsstat.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Remove oldnfs support from nfsstat(1). Reviewed by: rmacklem@ (earlier version) Sponsored by: The FreeBSD Foundation 2015-04-23 14:36:01 +00:00			`.Dd April 23, 2015`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt NFSSTAT 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 14:16:33 +00:00			`.Os`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh NAME`
			`.Nm nfsstat`
			`.Nd display`
			`.Tn NFS`
			`statistics`
			`.Sh SYNOPSIS`
``appears'' -> ``appeared'' (closes PR#3393, Submitted-by: Josh Gilliam) add missing Id's other minor clean ups 1997-04-27 08:45:46 +00:00			`.Nm`
Remove oldnfs support from nfsstat(1). Reviewed by: rmacklem@ (earlier version) Sponsored by: The FreeBSD Foundation 2015-04-23 14:36:01 +00:00			`.Op Fl cemszW`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl M Ar core`
			`.Op Fl N Ar system`
			`.Op Fl w Ar wait`
			`.Sh DESCRIPTION`
``appears'' -> ``appeared'' (closes PR#3393, Submitted-by: Josh Gilliam) add missing Id's other minor clean ups 1997-04-27 08:45:46 +00:00			`The`
			`.Nm`
			`command displays statistics kept about`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Tn NFS`
			`client and server activity.`
Document that the NFSv4 server statistics are operation counts and not RPC counts. This is a content change. MFC after: 2 weeks 2013-05-01 22:16:29 +00:00			`For the NFSv4 server, the statistics are for operations within the Compound`
			`RPCs and not the count of RPCs.`
			`If you wish to compare RPC counts between NFSv3 and NFSv4, you must use`
			`statistics in the client(s).`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
			`The options are as follows:`
Fix markup. 2006-12-25 20:30:10 +00:00			`.Bl -tag -width indent`
Rev 1.9 did not follow style(9) in ordering. 1999-12-16 09:49:54 +00:00			`.It Fl c`
Fix markup. 2006-12-25 20:30:10 +00:00			`Only display client side statistics.`
Update nfsstat.1 to reflect the changes done to nfsstat(1) by r221455. This includes a new "-o" option for displaying statistics from the old NFS client/server and a slightly different description for the "-e" option. This is a content change. 2011-05-04 20:28:06 +00:00			`.It Fl e`
Remove oldnfs support from nfsstat(1). Reviewed by: rmacklem@ (earlier version) Sponsored by: The FreeBSD Foundation 2015-04-23 14:36:01 +00:00			`Report the extra statistics collected by the NFS client and`
Update nfsstat.1 to reflect the changes done to nfsstat(1) by r221455. This includes a new "-o" option for displaying statistics from the old NFS client/server and a slightly different description for the "-e" option. This is a content change. 2011-05-04 20:28:06 +00:00			`server for NFSv4.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl M`
			`Extract values associated with the name list from the specified core`
			`instead of the default`
			`.Pa /dev/kmem .`
Document the "-m" option added by r243783. This is a content change. Reviewed by: alfred MFC after: 2 weeks 2012-12-02 01:25:19 +00:00			`.It Fl m`
			`Report the mount options for all new NFS client mounts.`
			`This option overrides all others and`
			`.Nm`
			`will exit after completing the report.`
			`This option is only supported by the new NFS client.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl N`
			`Extract the name list from the specified system instead of the default`
Replace /kernel with /boot/kernel/kernel. PR: docs/37757 Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-09 11:47:42 +00:00			`.Pa /boot/kernel/kernel .`
Rev 1.9 did not follow style(9) in ordering. 1999-12-16 09:49:54 +00:00			`.It Fl s`
Fix markup. 2006-12-25 20:30:10 +00:00			`Only display server side statistics.`
Add -c, -s, and -W options to nfsstat. Improve interval output and add wide-format option to get client-side ops and cache statistics on a single line. Change client side ops to the number of attempted ops, whether cached or not, rather then just the number of rpc's that went through to the server. This brings nfsstat inline with systat -vm and vmstat and reduces confusion. The combined cache percentage stats now available via 'nfsstat -cW 1' becomes very useful. 1999-10-25 19:39:17 +00:00			`.It Fl W`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`Use wide format with interval short summary.`
			`This option is especially`
Fix markup. 2006-12-25 20:30:10 +00:00			`useful when combined with`
			`.Fl c`
			`or`
			`.Fl s`
			`and a time delay.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl w`
			`Display a shorter summary of`
			`.Tn NFS`
			`activity for both the client and server at`
			`.Ar wait`
			`second intervals.`
Add a -z flag to nfsstat which zeros the NFS statistics after displaying them. MFC after: 1 week Requested by: ps Submitted by: ps (6 years ago) 2007-10-18 16:38:07 +00:00			`.It Fl z`
			`Reset statistics after displaying them.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
			`.Sh FILES`
Fix markup. 2006-12-25 20:30:10 +00:00			`.Bl -tag -width ".Pa /boot/kernel/kernel" -compact`
Replace /kernel with /boot/kernel/kernel. PR: docs/37757 Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-09 11:47:42 +00:00			`.It Pa /boot/kernel/kernel`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`default kernel namelist`
			`.It Pa /dev/kmem`
			`default memory file`
			`.El`
			`.Sh SEE ALSO`
			`.Xr fstat 1 ,`
			`.Xr netstat 1 ,`
			`.Xr ps 1 ,`
			`.Xr systat 1 ,`
Use new NFS sysctl interface to get statistics rather than reading /dev/kmem, unless the user specifies a dead kernel to operate on. 1994-10-23 23:25:43 +00:00			`.Xr sysctl 3 ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Xr iostat 8 ,`
Add the "-4" option to nfsstat, so that it will reports stats for the experimental nfs subsystem when that option is specified. Approved by: kib (mentor) 2009-05-25 15:48:10 +00:00			`.Xr nfsdumpstate 8 ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Xr pstat 8 ,`
Fix a variety of minor typos and cross references in a bunch of man pages. Masanobu Saitoh <msaitoh@spa.is.uec.ac.jp> Giles Lean <giles@nemeton.com.au> <soda@sra.co.jp> 1996-01-20 07:29:11 +00:00			`.Xr vmstat 8`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`The`
``appears'' -> ``appeared'' (closes PR#3393, Submitted-by: Josh Gilliam) add missing Id's other minor clean ups 1997-04-27 08:45:46 +00:00			`.Nm`
			`command appeared in`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Bx 4.4 .`