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