.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CMDEBUG 1"
.TH CMDEBUG 1 "2021-01-14" "OpenAFS" "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
cmdebug \- Reports the status of a host Cache Manager
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBcmdebug\fR \fB\-servers\fR\ <\fImachine\fR> [\fB\-port\fR\ <\fI\s-1IP\s0\ port\fR>]
    [\fB\-long\fR] [\fB\-refcounts\fR] [\fB\-callbacks\fR] [\fB\-ctime\fR] [\fB\-addrs\fR]
    [\fB\-cache\fR] [\fB\-cellservdb\fR] [\fB\-help\fR]
.PP
\&\fBcmdebug\fR \fB\-s\fR\ <\fImachine\fR> [\fB\-p\fR\ <\fI\s-1IP\s0\ port\fR>] [\fB\-l\fR] [\fB\-r\fR] [\fB\-cal\fR]
    [\fB\-ct\fR] [\fB\-a\fR] [\fB\-cac\fR] \fB\-ce\fR] [\fB\-h\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBcmdebug\fR command displays information about the Cache Manager
and client cache status on a local or remote \s-1AFS\s0 client machine.  By
default, it displays all locked cache entries, but other information
can be requested via various options.
.SH "CAUTIONS"
.IX Header "CAUTIONS"
The \fB\-ctime\fR option is only available with OpenAFS version 1.4.7 and
later or version 1.5.28 or later.  This option can be used to gather
information from any version of the Unix OpenAFS client, but can only
query Windows clients running OpenAFS version 1.5.28 or later.
.PP
The \fB\-cellservdb\fR option is only available with OpenAFS version 1.4.7
and later or version 1.5.31 or later.  This option can be used to gather
information from any version of the Unix OpenAFS client, but can only
query Windows clients running OpenAFS version 1.5.31 or later.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-servers\fR <\fImachine\fR>" 4
.IX Item "-servers <machine>"
Names the client machine for which to display Cache Manager status.
Provide the machine's \s-1IP\s0 address in dotted decimal format, its fully
qualified host name (for example, \fBfs1.example.com\fR), 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.
.IP "\fB\-port\fR <\fI\s-1IP\s0 port\fR>" 4
.IX Item "-port <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.
.IP "\fB\-long\fR" 4
.IX Item "-long"
Reports on all lock statuses and all cache entries, rather than only
locked cache entries.  Do not use this option with \fB\-refcounts\fR,
\&\fB\-callbacks\fR, \fB\-addrs\fR, \fB\-cache\fR, or \fB\-cellservdb\fR.
.IP "\fB\-refcounts\fR" 4
.IX Item "-refcounts"
Reports only those cache entries with non-zero reference counts.  Do not
use this option with \fB\-long\fR, \fB\-callbacks\fR, \fB\-addrs\fR, or \fB\-cache\fR.
.IP "\fB\-callbacks\fR" 4
.IX Item "-callbacks"
Reports only those cache entries with callbacks.  Do not use this option
with \fB\-long\fR, \fB\-refcounts\fR, \fB\-addrs\fR, or \fB\-cache\fR.
.IP "\fB\-ctime\fR" 4
.IX Item "-ctime"
Causes entry expiration times to be shown in human-readable format. Do
not use this option with \fB\-addrs\fR or \fB\-cache\fR.
.IP "\fB\-addrs\fR" 4
.IX Item "-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 \s-1MTU\s0 settings.  Do not use this option with \fB\-long\fR,
\&\fB\-refcounts\fR, \fB\-callbacks\fR, or \fB\-cache\fR.
.IP "\fB\-cache\fR" 4
.IX Item "-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 \fBafsd\fR.  Do not use
this option with \fB\-long\fR, \fB\-refcounts\fR, \fB\-callbacks\fR, or \fB\-addrs\fR.
.IP "\fB\-cellservdb\fR" 4
.IX Item "-cellservdb"
Lists all known volume location database records in a
CellServDB-compatible format. This includes all records in memory,
including those from the CellServDB file, \s-1DNS SRV\s0 or \s-1AFSDB\s0 records, and
the \fBfs newcell\fR command. This option could be used to see if a client
has the latest copy of the CellServDB file. Do not use this option
with \fB\-long\fR, \fB\-refcounts\fR, \fB\-callbacks\fR, or \fB\-cache\fR.
.IP "\fB\-help\fR" 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Displays all of the locked cache entries on \f(CW\*(C`client1\*(C'\fR:
.PP
.Vb 1
\&    % cmdebug client1
.Ve
.PP
Displays the cache configuration for \f(CW\*(C`client1.example.com\*(C'\fR:
.PP
.Vb 1
\&    % cmdebug client1.example.com \-cache
.Ve
.PP
Displays all cache entries for \f(CW\*(C`client2.example.com\*(C'\fR:
.PP
.Vb 1
\&    % cmdebug client2.example.com \-long
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
None
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBafsd\fR\|(8),
\&\fBCellServDB\fR\|(5),
\&\fBfs_newcell\fR\|(1)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2005 Russ Allbery <rra@stanford.edu>
.PP
This documentation is covered by the \s-1IBM\s0 Public License Version 1.0.  This
man page was written by Russ Allbery for OpenAFS.