a45d00bcc1f5121950984bd2a11f257286e31a71
[platform/upstream/krb5.git] / src / man / klist.man
1 .\" Man page generated from reStructuredText.
2 .
3 .TH "KLIST" "1" " " "1.17" "MIT Kerberos"
4 .SH NAME
5 klist \- list cached Kerberos tickets
6 .
7 .nr rst2man-indent-level 0
8 .
9 .de1 rstReportMargin
10 \\$1 \\n[an-margin]
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13 -
14 \\n[rst2man-indent0]
15 \\n[rst2man-indent1]
16 \\n[rst2man-indent2]
17 ..
18 .de1 INDENT
19 .\" .rstReportMargin pre:
20 . RS \\$1
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
24 ..
25 .de UNINDENT
26 . RE
27 .\" indent \\n[an-margin]
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .nr rst2man-indent-level -1
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
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\-C\fP]
39 [\fB\-k\fP [\fB\-t\fP] [\fB\-K\fP]]
40 [\fB\-V\fP]
41 [\fIcache_name\fP|\fIkeytab_name\fP]
42 .SH DESCRIPTION
43 .sp
44 klist lists the Kerberos principal and Kerberos tickets held in a
45 credentials cache, or the keys held in a keytab file.
46 .SH OPTIONS
47 .INDENT 0.0
48 .TP
49 \fB\-e\fP
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 \fB\-l\fP
55 If a cache collection is available, displays a table summarizing
56 the caches present in the collection.
57 .TP
58 \fB\-A\fP
59 If a cache collection is available, displays the contents of all
60 of the caches in the collection.
61 .TP
62 \fB\-c\fP
63 List tickets held in a credentials cache. This is the default if
64 neither \fB\-c\fP nor \fB\-k\fP is specified.
65 .TP
66 \fB\-f\fP
67 Shows the flags present in the credentials, using the following
68 abbreviations:
69 .INDENT 7.0
70 .INDENT 3.5
71 .sp
72 .nf
73 .ft C
74 F    Forwardable
75 f    forwarded
76 P    Proxiable
77 p    proxy
78 D    postDateable
79 d    postdated
80 R    Renewable
81 I    Initial
82 i    invalid
83 H    Hardware authenticated
84 A    preAuthenticated
85 T    Transit policy checked
86 O    Okay as delegate
87 a    anonymous
88 .ft P
89 .fi
90 .UNINDENT
91 .UNINDENT
92 .TP
93 \fB\-s\fP
94 Causes klist to run silently (produce no output).  klist will exit
95 with status 1 if the credentials cache cannot be read or is
96 expired, and with status 0 otherwise.
97 .TP
98 \fB\-a\fP
99 Display list of addresses in credentials.
100 .TP
101 \fB\-n\fP
102 Show numeric addresses instead of reverse\-resolving addresses.
103 .TP
104 \fB\-C\fP
105 List configuration data that has been stored in the credentials
106 cache when klist encounters it.  By default, configuration data
107 is not listed.
108 .TP
109 \fB\-k\fP
110 List keys held in a keytab file.
111 .TP
112 \fB\-i\fP
113 In combination with \fB\-k\fP, defaults to using the default client
114 keytab instead of the default acceptor keytab, if no name is
115 given.
116 .TP
117 \fB\-t\fP
118 Display the time entry timestamps for each keytab entry in the
119 keytab file.
120 .TP
121 \fB\-K\fP
122 Display the value of the encryption key in each keytab entry in
123 the keytab file.
124 .TP
125 \fB\-V\fP
126 Display the Kerberos version number and exit.
127 .UNINDENT
128 .sp
129 If \fIcache_name\fP or \fIkeytab_name\fP is not specified, klist will display
130 the credentials in the default credentials cache or keytab file as
131 appropriate.  If the \fBKRB5CCNAME\fP environment variable is set, its
132 value is used to locate the default ticket cache.
133 .SH ENVIRONMENT
134 .sp
135 See kerberos(7) for a description of Kerberos environment
136 variables.
137 .SH FILES
138 .INDENT 0.0
139 .TP
140 .B \fB@CCNAME@\fP
141 Default location of Kerberos 5 credentials cache
142 .TP
143 .B \fB@KTNAME@\fP
144 Default location for the local host\(aqs keytab file.
145 .UNINDENT
146 .SH SEE ALSO
147 .sp
148 kinit(1), kdestroy(1), kerberos(7)
149 .SH AUTHOR
150 MIT
151 .SH COPYRIGHT
152 1985-2019, MIT
153 .\" Generated by docutils manpage writer.
154 .