pretty-html-synopsis-20060228
[openafs.git] / doc / man-pages / pod1 / cmdebug.pod
1 =head1 NAME
2
3 cmdebug - Reports the status of a host Cache Manager
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<cmdebug> S<<< B<-servers> <I<machine>> >>> S<<< [B<-port> <I<IP port>>] >>>
11     [B<-long>] [B<-refcounts>] [B<-callbacks>] [B<-addrs>] [B<-cache>]
12
13 B<cmdebug> S<<< B<-s> <I<machine>> >>> S<<< [B<-p> <I<IP port>>] >>> [B<-l>] [B<-r>] [B<-c>]
14     [B<-a>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<cmdebug> command displays information about the Cache Manager and
22 client cache status on an AFS client machine.  By default, it displays all
23 locked cache entries, but other information can be requested via various
24 options.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-servers> <I<machine>>
31
32 Names the client machine for which to display Cache Manager status.
33 Provide the machine's IP address in dotted decimal format, its fully
34 qualified host name (for example, B<fs1.abc.com>), or the shortest
35 abbreviated form of its host name that distinguishes it from other
36 machines. Successful use of an abbreviated form depends on the
37 availability of a name resolution service (such as the Domain Name Service
38 or a local host table) at the time the command is issued.
39
40 =item B<-port> <I<IP port>>
41
42 Identifies the port on which to contact the Cache Manager.  By default,
43 the standard port 7001 is used, so this option is very rarely needed.
44
45 =item B<-long>
46
47 Reports on all lock statuses and all cache entries, rather than only
48 locked cache entries.  Do not use this option with B<-refcounts>,
49 B<-callbacks>, B<-addrs>, or B<-cache>.
50
51 =item B<-refcounts>
52
53 Reports only those cache entries with non-zero reference counts.  Do not
54 use this option with B<-long>, B<-callbacks>, B<-addrs>, or B<-cache>.
55
56 =item B<-callbacks>
57
58 Reports only those cache entries with callbacks.  Do not use this option
59 with B<-long>, B<-refcounts>, B<-addrs>, or B<-cache>.
60
61 =item B<-addrs>
62
63 Rather than showing any cache entries, displays the interfaces the Cache
64 Manager answers on, including their netmasks and MTUs.  This is useful for
65 analyzing clients that are multihomed and identifying problems with
66 netmasks or MTU settings.  Do not use this option with B<-long>,
67 B<-refcounts>, B<-callbacks>, or B<-cache>.
68
69 =item B<-cache>
70
71 Rather than showing any cache entries, displays the cache configuration
72 for the client machine.  The information displayed is essentially the
73 information that can be configured via parameters to B<afsd>.  Do not use
74 this option with B<-long>, B<-refcounts>, B<-callbacks>, or B<-addrs>.
75
76 =item B<-help>
77
78 Prints the online help for this command. All other valid options are
79 ignored.
80
81 =back
82
83 =head1 EXAMPLES
84
85 Displays all of the locked cache entries on C<client1>:
86
87     % cmdebug client1
88
89 Displays the cache configuration for C<client1.abc.com>:
90
91     % cmdebug client1.abc.com -cache
92
93 Displays all cache entries for C<client2.abc.com>:
94
95     % cmdebug client2.abc.com -long
96
97 =head1 PRIVILEGE REQUIRED
98
99 None
100
101 =head1 SEE ALSO
102
103 L<afsd(8)>
104
105 =head1 COPYRIGHT
106
107 Copyright 2005 Russ Allbery <rra@stanford.edu>
108
109 This documentation is covered by the IBM Public License Version 1.0.  This
110 man page was written by Russ Allbery for OpenAFS.