ubik: Remove unused sampleName
[openafs.git] / doc / man-pages / pod1 / fs_rxstatproc.pod
1 =head1 NAME
2
3 fs_rxstatproc - Manage per-process Rx statistics collection
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs rxstatproc> [B<-enable>] [B<-disable>] [B<-clear>] [B<-help>]
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 This command enables or disables the updating of RPC statistics counters
18 related to the entire RX process, or sets the accumulated counter values
19 back to zero.
20
21 =head1 OPTIONS
22
23 One or more of the following options must be specified:
24
25 =over 4
26
27 =item B<-enable>
28
29 Enable the collection of process RPC statistics
30
31 =item B<-disable>
32
33 Enable the collection of process RPC statistics
34
35 =item B<-clear>
36
37 Resets all trace counters to zero.
38
39 =item B<-help>
40
41 Prints the online help for this command. All other valid options are
42 ignored.
43
44 =back
45
46 =head1 OUTPUT
47
48 This command produces no output other than error-messages.
49
50 =head1 EXAMPLES
51
52 The following command starts collecting statistics:
53
54    % fs rxstatproc -enable
55
56 =head1 PRIVILEGE REQUIRED
57
58 The issuer must be logged in as the local superuser root.
59
60 =head1 SEE ALSO
61
62 L<fs(1)>,
63 L<fs_rxstatpeer(1)>,
64 L<rxdebug(1)>
65
66 =head1 COPYRIGHT
67
68 Copyright 2008. This documentation is covered by the BSD License as
69 written in the doc/LICENSE file. This man page was written by Mike
70 Robinson (L<mike@endpoint.com>) for OpenAFS.