mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
fc5acc0151
Implement proper synopsis wrapping for HTML generation. This was done in three pieces. First, add HTML-specific tags to the POD to mark the synopsis for HTML purposes so that we can apply style information to it. Second, update the style sheet to indent all lines except for the first in the synopsis section. Third, add the appropriate S<> tags around option and argument pairs so that we don't wrap between the option and its argument. Unfortunately, due to the <I<foo>> style that looks nicer for other reasons, we have to use the very verbose S<<< >>>. Oh well.
111 lines
3.1 KiB
Plaintext
111 lines
3.1 KiB
Plaintext
=head1 NAME
|
|
|
|
cmdebug - Reports the status of a host Cache Manager
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<cmdebug> S<<< B<-servers> <I<machine>> >>> S<<< [B<-port> <I<IP port>>] >>>
|
|
[B<-long>] [B<-refcounts>] [B<-callbacks>] [B<-addrs>] [B<-cache>]
|
|
|
|
B<cmdebug> S<<< B<-s> <I<machine>> >>> S<<< [B<-p> <I<IP port>>] >>> [B<-l>] [B<-r>] [B<-c>]
|
|
[B<-a>] [B<-h>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<cmdebug> command displays information about the Cache Manager and
|
|
client cache status on an AFS client machine. By default, it displays all
|
|
locked cache entries, but other information can be requested via various
|
|
options.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-servers> <I<machine>>
|
|
|
|
Names the client machine for which to display Cache Manager status.
|
|
Provide the machine's IP address in dotted decimal format, its fully
|
|
qualified host name (for example, B<fs1.abc.com>), or the shortest
|
|
abbreviated form of its host name that distinguishes it from other
|
|
machines. Successful use of an abbreviated form depends on the
|
|
availability of a name resolution service (such as the Domain Name Service
|
|
or a local host table) at the time the command is issued.
|
|
|
|
=item B<-port> <I<IP port>>
|
|
|
|
Identifies the port on which to contact the Cache Manager. By default,
|
|
the standard port 7001 is used, so this option is very rarely needed.
|
|
|
|
=item B<-long>
|
|
|
|
Reports on all lock statuses and all cache entries, rather than only
|
|
locked cache entries. Do not use this option with B<-refcounts>,
|
|
B<-callbacks>, B<-addrs>, or B<-cache>.
|
|
|
|
=item B<-refcounts>
|
|
|
|
Reports only those cache entries with non-zero reference counts. Do not
|
|
use this option with B<-long>, B<-callbacks>, B<-addrs>, or B<-cache>.
|
|
|
|
=item B<-callbacks>
|
|
|
|
Reports only those cache entries with callbacks. Do not use this option
|
|
with B<-long>, B<-refcounts>, B<-addrs>, or B<-cache>.
|
|
|
|
=item B<-addrs>
|
|
|
|
Rather than showing any cache entries, displays the interfaces the Cache
|
|
Manager answers on, including their netmasks and MTUs. This is useful for
|
|
analyzing clients that are multihomed and identifying problems with
|
|
netmasks or MTU settings. Do not use this option with B<-long>,
|
|
B<-refcounts>, B<-callbacks>, or B<-cache>.
|
|
|
|
=item B<-cache>
|
|
|
|
Rather than showing any cache entries, displays the cache configuration
|
|
for the client machine. The information displayed is essentially the
|
|
information that can be configured via parameters to B<afsd>. Do not use
|
|
this option with B<-long>, B<-refcounts>, B<-callbacks>, or B<-addrs>.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Displays all of the locked cache entries on C<client1>:
|
|
|
|
% cmdebug client1
|
|
|
|
Displays the cache configuration for C<client1.abc.com>:
|
|
|
|
% cmdebug client1.abc.com -cache
|
|
|
|
Displays all cache entries for C<client2.abc.com>:
|
|
|
|
% cmdebug client2.abc.com -long
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<afsd(8)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2005 Russ Allbery <rra@stanford.edu>
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. This
|
|
man page was written by Russ Allbery for OpenAFS.
|