~ubuntu-branches/ubuntu/oneiric/openafs/oneiric-201305130334

« back to all changes in this revision

Viewing changes to doc/man-pages/man1/cmdebug.1

  • Committer: Bazaar Package Importer
  • Author(s): Russ Allbery
  • Date: 2008-09-22 19:07:02 UTC
  • mfrom: (12.1.14 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080922190702-59m13d7kn6gkw32d
Tags: 1.4.7.dfsg1-6
* Apply upstream patch to free /proc entries in the correct order.
  Thanks, Marc Dionne.  (Closes: #493914)
* Apply upstream deltas to support 2.6.27 kernels and to stop using
  COMMON_KERN_CFLAGS for all 2.6 kernels uniformly, which fixes
  problems on amd64 with newer kernels.  Thanks, Björn Torkelsson.
  (LP: #267504)
* Translation updates:
  - Swedish, thanks Martin Bagge.  (Closes: #493120)

Show diffs side-by-side

added added

removed removed

Lines of Context:
93
93
.nr % 0
94
94
.rr F
95
95
.\}
96
 
.TH CMDEBUG 1 "OpenAFS" "1/Mar/2006" "AFS Command Reference"
 
96
.TH CMDEBUG 1 "OpenAFS" "14/Jan/2008" "AFS Command Reference"
97
97
.UC
98
98
.if n .hy 0
99
99
.if n .na
191
191
cmdebug \- Reports the status of a host Cache Manager
192
192
.SH "SYNOPSIS"
193
193
\fBcmdebug\fR <<\ \fB\-servers\fR\ <\fImachine\fR >>> <<\ [\fB\-port\fR\ <\fIIP\ port\fR] >>>
194
 
    [\fB\-long\fR] [\fB\-refcounts\fR] [\fB\-callbacks\fR] [\fB\-addrs\fR] [\fB\-cache\fR]
 
194
    [\fB\-long\fR] [\fB\-refcounts\fR] [\fB\-callbacks\fR] [\fB\-ctime\fR] [\fB\-addrs\fR]
 
195
    [\fB\-cache\fR] [\fB\-cellservdb\fR] [\fB\-help\fR]
195
196
.PP
196
 
\fBcmdebug\fR <<\ \fB\-s\fR\ <\fImachine\fR >>> <<\ [\fB\-p\fR\ <\fIIP\ port\fR] >>> [\fB\-l\fR] [\fB\-r\fR] [\fB\-c\fR]
197
 
    [\fB\-a\fR] [\fB\-h\fR]
 
197
\fBcmdebug\fR <<\ \fB\-s\fR\ <\fImachine\fR >>> <<\ [\fB\-p\fR\ <\fIIP\ port\fR] >>> [\fB\-l\fR] [\fB\-r\fR] [\fB\-cal\fR]
 
198
    [\fB\-ct\fR] [\fB\-a\fR] [\fB\-cac\fR] \fB\-ce\fR] [\fB\-h\fR]
198
199
.SH "DESCRIPTION"
199
 
The \fBcmdebug\fR command displays information about the Cache Manager and
200
 
client cache status on an AFS client machine.  By default, it displays all
201
 
locked cache entries, but other information can be requested via various
202
 
options.
 
200
The \fBcmdebug\fR command displays information about the Cache Manager
 
201
and client cache status on a local or remote AFS client machine.  By
 
202
default, it displays all locked cache entries, but other information
 
203
can be requested via various options.
 
204
.SH "CAUTIONS"
 
205
The \fB\-ctime\fR option is only available with OpenAFS version 1.4.7 and
 
206
later or version 1.5.28 or later.  This option can be used to gather
 
207
information from any version of the Unix OpenAFS client, but can only
 
208
query Windows clients running OpenAFS version 1.5.28 or later.
 
209
.PP
 
210
The \fB\-cellservdb\fR option is only available with OpenAFS version 1.4.7
 
211
and later or version 1.5.31 or later.  This option can be used to gather
 
212
information from any version of the Unix OpenAFS client, but can only
 
213
query Windows clients running OpenAFS version 1.5.31 or later.
203
214
.SH "OPTIONS"
204
215
.Ip "\fB\-servers\fR <\fImachine\fR>" 4
205
216
Names the client machine for which to display Cache Manager status.
206
217
Provide the machine's \s-1IP\s0 address in dotted decimal format, its fully
207
 
qualified host name (for example, \fBfs1.abc.com\fR), or the shortest
 
218
qualified host name (for example, \fBfs1.example.com\fR), or the shortest
208
219
abbreviated form of its host name that distinguishes it from other
209
220
machines. Successful use of an abbreviated form depends on the
210
 
availability of a name resolution service (such as the Domain Name Service
211
 
or a local host table) at the time the command is issued.
 
221
availability of a name resolution service (such as the Domain Name
 
222
Service or a local host table) at the time the command is issued.
212
223
.Ip "\fB\-port\fR <\fI\s-1IP\s0 port\fR>" 4
213
224
Identifies the port on which to contact the Cache Manager.  By default,
214
225
the standard port 7001 is used, so this option is very rarely needed.
215
226
.Ip "\fB\-long\fR" 4
216
227
Reports on all lock statuses and all cache entries, rather than only
217
228
locked cache entries.  Do not use this option with \fB\-refcounts\fR,
218
 
\fB\-callbacks\fR, \fB\-addrs\fR, or \fB\-cache\fR.
 
229
\fB\-callbacks\fR, \fB\-addrs\fR, \fB\-cache\fR, or \fB\-cellservdb\fR.
219
230
.Ip "\fB\-refcounts\fR" 4
220
231
Reports only those cache entries with non-zero reference counts.  Do not
221
232
use this option with \fB\-long\fR, \fB\-callbacks\fR, \fB\-addrs\fR, or \fB\-cache\fR.
222
233
.Ip "\fB\-callbacks\fR" 4
223
234
Reports only those cache entries with callbacks.  Do not use this option
224
235
with \fB\-long\fR, \fB\-refcounts\fR, \fB\-addrs\fR, or \fB\-cache\fR.
 
236
.Ip "\fB\-ctime\fR" 4
 
237
Causes entry expiration times to be shown in human-readable format. Do
 
238
not use this option with \fB\-addrs\fR or \fB\-cache\fR.
225
239
.Ip "\fB\-addrs\fR" 4
226
240
Rather than showing any cache entries, displays the interfaces the Cache
227
241
Manager answers on, including their netmasks and MTUs.  This is useful for
233
247
for the client machine.  The information displayed is essentially the
234
248
information that can be configured via parameters to \fBafsd\fR.  Do not use
235
249
this option with \fB\-long\fR, \fB\-refcounts\fR, \fB\-callbacks\fR, or \fB\-addrs\fR.
 
250
.Ip "\fB\-cellservdb\fR" 4
 
251
Lists all known volume location database records in a
 
252
CellServDB\-compatible format. This includes all records in memory,
 
253
including those from the CellServDB file, \s-1AFSDB\s0 \s-1DNS\s0 records, and the
 
254
\fBfs newcell\fR command. This option could be used to see if a client
 
255
has the latest copy of the CellServDB file. Do not use this option
 
256
with \fB\-long\fR, \fB\-refcounts\fR, \fB\-callbacks\fR, or \fB\-cache\fR.
236
257
.Ip "\fB\-help\fR" 4
237
258
Prints the online help for this command. All other valid options are
238
259
ignored.
242
263
.Vb 1
243
264
\&    % cmdebug client1
244
265
.Ve
245
 
Displays the cache configuration for \f(CWclient1.abc.com\fR:
 
266
Displays the cache configuration for \f(CWclient1.example.com\fR:
246
267
.PP
247
268
.Vb 1
248
 
\&    % cmdebug client1.abc.com -cache
 
269
\&    % cmdebug client1.example.com -cache
249
270
.Ve
250
 
Displays all cache entries for \f(CWclient2.abc.com\fR:
 
271
Displays all cache entries for \f(CWclient2.example.com\fR:
251
272
.PP
252
273
.Vb 1
253
 
\&    % cmdebug client2.abc.com -long
 
274
\&    % cmdebug client2.example.com -long
254
275
.Ve
255
276
.SH "PRIVILEGE REQUIRED"
256
277
None
257
278
.SH "SEE ALSO"
258
 
the \fIafsd(8)\fR manpage
 
279
the \fIafsd(8)\fR manpage,
 
280
the \fICellServDB(5)\fR manpage,
 
281
the \fIfs_newcell(1)\fR manpage
259
282
.SH "COPYRIGHT"
260
283
Copyright 2005 Russ Allbery <rra@stanford.edu>
261
284
.PP
272
295
 
273
296
.IX Header "DESCRIPTION"
274
297
 
 
298
.IX Header "CAUTIONS"
 
299
 
275
300
.IX Header "OPTIONS"
276
301
 
277
302
.IX Item "\fB\-servers\fR <\fImachine\fR>"
284
309
 
285
310
.IX Item "\fB\-callbacks\fR"
286
311
 
 
312
.IX Item "\fB\-ctime\fR"
 
313
 
287
314
.IX Item "\fB\-addrs\fR"
288
315
 
289
316
.IX Item "\fB\-cache\fR"
290
317
 
 
318
.IX Item "\fB\-cellservdb\fR"
 
319
 
291
320
.IX Item "\fB\-help\fR"
292
321
 
293
322
.IX Header "EXAMPLES"