]> git.decadent.org.uk Git - nfs-utils.git/blob - tools/rpcdebug/rpcdebug.man
Updated both the mountstats and nfs-iostat scripts to used the
[nfs-utils.git] / tools / rpcdebug / rpcdebug.man
1 .\"
2 .\" rpcdebug(8)
3 .\" 
4 .\" By Greg Banks <gnb@melbourne.sgi.com>
5 .\" Copyright (c) 2006 Silicon Graphics, Inc.
6 .\" Derived from nfsstat.man which bore the message:
7 .\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de>
8 .TH rpcdebug 8 "5 Jul 2006"
9 .SH NAME
10 rpcdebug \- set and clear NFS and RPC kernel debug flags
11 .SH SYNOPSIS
12 \fBrpcdebug\fP \fB\-vh\fP
13 .br
14 \fBrpcdebug\fP \fB\-m\fP \fImodule\fP
15 .br
16 \fBrpcdebug\fP \fB\-m\fP \fImodule\fP \fB\-s\fP \fIflags\fP...
17 .br
18 \fBrpcdebug\fP \fB\-m\fP \fImodule\fP \fB\-c\fP \fIflags\fP...
19 .br
20 .SH DESCRIPTION
21 The \fBrpcdebug\fP command allows an administrator to set and clear
22 the Linux kernel's NFS client and server debug flags.  Setting these
23 flags causes the kernel to emit messages to the system log in response
24 to NFS activity; this is typically useful when debugging NFS problems.
25 .PP
26 The first form in the synopsis can be used to list all available
27 debug flags.  The second form shows the currently set debug flags
28 for the given module.  The third form sets one or more flags, and
29 the fourth form clears one or more flags.
30 .PP
31 The value \fBall\fP may be used to set or clear all the flags for
32 the given module.
33 .SH OPTIONS
34 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
35 .TP
36 .B \-c
37 Clear the given debug flags.
38 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
39 .TP
40 .B \-h
41 Print a help message and exit.  When combined with the \fB\-v\fP
42 option, also prints the available debug flags.
43 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
44 .TP
45 .BI \-m " module"
46 Specify which module's flags to set or clear.  Available
47 modules are:
48 .RS
49 .TP
50 .BR nfsd
51 The NFS server.
52 .TP
53 .BR nfs
54 The NFS client.
55 .TP
56 .BR nlm
57 The Network Lock Manager, in either an NFS client or server.
58 .TP
59 .BR rpc
60 The Remote Procedure Call module, in either an NFS client or server.
61 .RE
62 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
63 .TP
64 .B \-s
65 Set the given debug flags.
66 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
67 .TP
68 .B \-v
69 Increase the verbosity of \fBrpcdebug\fP's output.
70 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
71 .SH FILES
72 .TP
73 .B /proc/sys/sunrpc/{rpc,nfs,nfsd,nlm}_debug
74 procfs\-based interface to kernel debug flags.
75 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
76 .SH SEE ALSO
77 .BR rpc.nfsd (8),
78 .BR nfs (5),
79 .BR syslogd (8).
80 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
81 .SH BUGS
82 Bugs can be found or reported at
83 .BR http://nfs.sf.net/ .
84 .\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
85 .SH AUTHOR
86 Program by Olaf Kirch <okir@suse.de> and
87 <frederic.jolly@bull.ext.net>.
88 Manpage by Greg Banks <gnb@melbourne.sgi.com>.