src/man/klist.man

   1 .TH "KLIST" "1" " " "0.0.1" "MIT Kerberos"
   2 .SH NAME
   3 klist \- list cached Kerberos tickets
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 \fBklist\fP
  36 [\fB\-e\fP]
  37 [[\fB\-c\fP] [\fB\-l\fP] [\fB\-A\fP] [\fB\-f\fP] [\fB\-s\fP] [\fB\-a\fP [\fB\-n\fP]]]
  38 [\fB\-k\fP [\fB\-t\fP] [\fB\-K\fP]]
  39 [\fB\-V\fP]
  40 [\fIcache_name\fP|\fIkeytab_name\fP]
  41 .SH DESCRIPTION
  42 .sp
  43 klist lists the Kerberos principal and Kerberos tickets held in a
  44 credentials cache, or the keys held in a keytab file.
  45 .SH OPTIONS
  46 .INDENT 0.0
  47 .TP
  48 .B \fB\-e\fP
  49 .sp
  50 Displays the encryption types of the session key and the ticket
  51 for each credential in the credential cache, or each key in the
  52 keytab file.
  53 .TP
  54 .B \fB\-l\fP
  55 .sp
  56 If a cache collection is available, displays a table summarizing
  57 the caches present in the collection.
  58 .TP
  59 .B \fB\-A\fP
  60 .sp
  61 If a cache collection is available, displays the contents of all
  62 of the caches in the collection.
  63 .TP
  64 .B \fB\-c\fP
  65 .sp
  66 List tickets held in a credentials cache. This is the default if
  67 neither \fB\-c\fP nor \fB\-k\fP is specified.
  68 .TP
  69 .B \fB\-f\fP
  70 .sp
  71 Shows the flags present in the credentials, using the following
  72 abbreviations:
  73 .INDENT 7.0
  74 .INDENT 3.5
  75 .sp
  76 .nf
  77 .ft C
  78 F    Forwardable
  79 f    forwarded
  80 P    Proxiable
  81 p    proxy
  82 D    postDateable
  83 d    postdated
  84 R    Renewable
  85 I    Initial
  86 i    invalid
  87 H    Hardware authenticated
  88 A    preAuthenticated
  89 T    Transit policy checked
  90 O    Okay as delegate
  91 a    anonymous
  92 .ft P
  93 .fi
  94 .UNINDENT
  95 .UNINDENT
  96 .TP
  97 .B \fB\-s\fP
  98 .sp
  99 Causes klist to run silently (produce no output), but to still set
 100 the exit status according to whether it finds the credentials
 101 cache.  The exit status is \(aq0\(aq if klist finds a credentials cache,
 102 and \(aq1\(aq if it does not or if the tickets are expired.
 103 .TP
 104 .B \fB\-a\fP
 105 .sp
 106 Display list of addresses in credentials.
 107 .TP
 108 .B \fB\-n\fP
 109 .sp
 110 Show numeric addresses instead of reverse\-resolving addresses.
 111 .TP
 112 .B \fB\-k\fP
 113 .sp
 114 List keys held in a keytab file.
 115 .TP
 116 .B \fB\-t\fP
 117 .sp
 118 Display the time entry timestamps for each keytab entry in the
 119 keytab file.
 120 .TP
 121 .B \fB\-K\fP
 122 .sp
 123 Display the value of the encryption key in each keytab entry in
 124 the keytab file.
 125 .TP
 126 .B \fB\-V\fP
 127 .sp
 128 Display the Kerberos version number and exit.
 129 .UNINDENT
 130 .sp
 131 If \fIcache_name\fP or \fIkeytab_name\fP is not specified, klist will display
 132 the credentials in the default credentials cache or keytab file as
 133 appropriate.  If the \fBKRB5CCNAME\fP environment variable is set, its
 134 value is used to locate the default ticket cache.
 135 .SH ENVIRONMENT
 136 .sp
 137 klist uses the following environment variable:
 138 .INDENT 0.0
 139 .TP
 140 .B \fBKRB5CCNAME\fP
 141 .sp
 142 Location of the default Kerberos 5 credentials (ticket) cache, in
 143 the form \fItype\fP:\fIresidual\fP.  If no \fItype\fP prefix is present, the
 144 \fBFILE\fP type is assumed.  The type of the default cache may
 145 determine the availability of a cache collection; for instance, a
 146 default cache of type \fBDIR\fP causes caches within the directory
 147 to be present in the collection.
 148 .UNINDENT
 149 .SH FILES
 150 .INDENT 0.0
 151 .TP
 152 .B \fB/tmp/krb5cc_[uid]\fP
 153 .sp
 154 Default location of Kerberos 5 credentials cache ([uid] is the
 155 decimal UID of the user).
 156 .TP
 157 .B \fB/etc/krb5.keytab\fP
 158 .sp
 159 Default location for the local host\(aqs keytab file.
 160 .UNINDENT
 161 .SH SEE ALSO
 162 .sp
 163 \fIkinit(1)\fP, \fIkdestroy(1)\fP
 164 .SH AUTHOR
 165 MIT
 166 .SH COPYRIGHT
 167 2011, MIT
 168 .\" Generated by docutils manpage writer.
 169 .