DEVEL15-rxdebug-man-formatting-20060803
[openafs.git] / doc / man-pages / pod1 / rxdebug.pod
1 =head1 NAME
2
3 rxdebug - Provides debugging trace of Rx activity
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<rxdebug> S<<< B<-servers> <I<server machine>> >>> S<<< [B<-port> <I<IP port>>] >>>
11     [B<-nodally>] [B<-allconnections>] [B<-rxstats>] [B<-onlyserver>]
12     [B<-onlyclient>] S<<< [B<-onlyport> <I<show only port>>] >>>
13     S<<< [B<-onlyhost> <I<show only host>>] >>>
14     S<<< [B<-onlyauth> <I<show only auth level>>] >>> [B<-version>]
15     [B<-noconns>] [B<-peers>] [B<-help>]
16
17 B<rxdebug> S<<< B<-s> <I<server machine>> >>> S<<< [B<-po> <I<IP port>>] >>> [B<-nod>]
18     [B<-a>] [B<-r>] [B<-onlys>] [B<-onlyc>] S<<< [B<-onlyp> <I<show only port>>] >>>
19     S<<< [B<-onlyh> <I<show only host>>] >>> S<<< [B<-onlya> <I<show only auth level>>] >>>
20     [B<-v>] [B<-noc>] [B<-pe>] [B<-h>]
21
22 =for html
23 </div>
24
25 =head1 DESCRIPTION
26
27 The B<rxdebug> command provides a trace of Rx activity for the server or
28 client machine named by the B<-servers> argument. Rx is AFS's proprietary
29 remote procedure call (RPC) protocol, so this command enables the issuer
30 to check the status of communication between the Cache Manager or an AFS
31 server process (as specified with the B<-port> argument) on the machine
32 and one or more processes on other machines.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-servers> <I<server machine>>
39
40 Specifies the machine that is running the Cache Manager or server process
41 for which to trace Rx activity. Provide the machine's IP address in dotted
42 decimal format, its fully qualified host name (for example,
43 C<fs1.abc.com>), or the shortest abbreviated form of its host name that
44 distinguishes it from other machines. Successful use of an abbreviated
45 form depends on the availability of a name resolution service (such as the
46 Domain Name Service or a local host table) at the time the command is
47 issued.
48
49 =item B<-port> <I<IP port>>
50
51 Specifies the process for which to trace Rx activity. Omit this argument
52 to specify the File Server (B<fileserver> process), or provide one of the
53 following values:
54
55 =over 4
56
57 =item C<7000> for the File Server (B<fileserver> process)
58
59 =item C<7001> for the Cache Manager (specifically, its callback interface)
60
61 =item C<7002> for the Protection Server (B<ptserver> process)
62
63 =item C<7003> for the Volume Location (VL) Server (B<vlserver> process)
64
65 =item C<7004> for the Authentication Server (B<kaserver> process)
66
67 =item C<7005> for the Volume Server (B<volserver> process)
68
69 =item C<7007> for the BOS Server (B<bosserver> process)
70
71 =item C<7008> for the Update Server (B<upserver> process)
72
73 =item C<7009> for the NFS/AFS Translator's B<rmtsysd> daemon
74
75 =item C<7021> for the Backup Server (B<buserver> process)
76
77 =back
78
79 Finally, specify C<7025> through C<65535> for the Backup Tape Coordinator
80 (B<butc> process) that has the port offset number derived by subtracting
81 7025 from this value.
82
83 =item B<-nodally>
84
85 Produces output only for connections that are not in dally mode.
86
87 =item B<-allconnections>
88
89 Produces output for all connections, even inactive ones. By default, the
90 output includes information only for connections that are active or in
91 dally mode when the B<rxdebug> command is issued.
92
93 =item B<-rxstats>
94
95 Produces detailed statistics about Rx history and performance (for
96 example, counts of the number of packets of various types the process has
97 read and sent, calculations of average and minimum roundtrip time, and so
98 on).
99
100 =item B<-onlyserver>
101
102 Produces output only for connections in which the process designated by
103 the B<-port> argument is acting as the server.
104
105 =item B<-onlyclient>
106
107 Produces output only for connections in which the process designated by
108 the B<-port> argument is acting as the client.
109
110 =item B<-onlyport> <I<port>>
111
112 Produces output only for connections between the process designated by the
113 B<-port> argument and the specified port on any another machine. Use the
114 same port identifiers as for the B<-port> argument.
115
116 =item B<-onlyhost> <I<host>>
117
118 Produces output only for connections between the process designated by the
119 B<-port> argument and any process on the specified machine. To identify
120 the machine, use the same notation as for the B<-servers> argument.
121
122 =item B<-onlyauth>
123
124 Produces output only for connections that are using the specified
125 authentication level. Provide one of the following values:
126
127 =over 4
128
129 =item auth
130
131 Cconnections at authentication level rxkad_auth
132
133 =item clear
134
135 Connections at authentication level rxkad_clear
136
137 =item crypt
138
139 Connections at authentication level rxkad_crypt
140
141 =item none
142
143 Unauthenticated connections (equivalents are C<null>, C<noauth>, and
144 C<unauth>)
145
146 =back
147
148 =item B<-version>
149
150 Reports the AFS build level of the binary file for the process designated
151 by the B<-port> argument (or of the kernel extensions file for port 7001,
152 the Cache Manager's callback interface). Any other options combined with
153 this one are ignored.
154
155 =item B<-noconns>
156
157 Produces only the standard statistics that begin the output produced by
158 every option (other than B<-version>), without reporting on any
159 connections. Any other options combined with this one are ignored.
160
161 =item B<-peers>
162
163 Outputs information from the I<peer structure> maintained for each port on
164 another machine to which the process designated by the B<-port> argument
165 has a connection. There is information about roundtrip time and numbers of
166 packets sent and received, for example.
167
168 =item B<-help>
169
170 Prints the online help for this command. All other valid options are
171 ignored.
172
173 =back
174
175 =head1 OUTPUT
176
177 If any options other than B<-version> or B<-help> are provided, the output
178 written to the standard output stream begins with basic statistics about
179 packet usage and availability, how many calls are waiting for a thread,
180 how many threads are free, and so on (this is the only information
181 provided by the B<-noconns> flag). Adding other options produces
182 additional information as described in L<OPTIONS>. The output is intended
183 for debugging purposes and is meaningful to someone familiar with the
184 implementation of Rx.
185
186 =head1 PRIVILEGE REQUIRED
187
188 None.
189
190 =head1 SEE ALSO
191
192 L<afsd(8)>,
193 L<bosserver(8)>,
194 L<buserver(8)>,
195 L<butc(8)>,
196 L<fileserver(8)>,
197 L<kaserver(8)>,
198 L<ptserver(8)>,
199 L<upclient(8)>,
200 L<upserver(8)>,
201 L<vlserver(8)>,
202 L<volserver(8)>
203
204 =head1 COPYRIGHT
205
206 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
207
208 This documentation is covered by the IBM Public License Version 1.0.  It was
209 converted from HTML to POD by software written by Chas Williams and Russ
210 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.