Miscellaneous small edits to RST docs
[krb5.git] / src / man / klist.1
1 .TH "KLIST" "1" "January 06, 2012" "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 .INDENT 0.0
35 .TP
36 .B \fBklist\fP
37 .sp
38 [\fB\-e\fP]
39 [[\fB\-c\fP] [\fB\-l\fP] [\fB\-A\fP] [\fB\-f\fP] [\fB\-s\fP] [\fB\-a\fP [\fB\-n\fP]]]
40 [\fB\-k\fP  [\fB\-t\fP]  [\fB\-K\fP]]
41 [\fB\-V\fP]
42 [\fIcache_name\fP | \fIkeytab_name\fP]
43 .UNINDENT
44 .SH DESCRIPTION
45 .sp
46 \fIklist\fP lists the Kerberos principal and Kerberos tickets held in a credentials cache, or the keys held in a \fIkeytab\fP file.
47 .SH OPTIONS
48 .INDENT 0.0
49 .INDENT 3.5
50 .INDENT 0.0
51 .TP
52 .B \fB\-e\fP
53 .sp
54 Displays the encryption types of the session key and the ticket for each credential in the credential cache,
55 or each key in the keytab file.
56 .TP
57 .B \fB\-l\fP
58 .sp
59 If a cache collection is available, displays a table
60 summarizing the caches present in the collection.
61 .TP
62 .B \fB\-A\fP
63 .sp
64 If a cache collection is available, displays the contents of
65 all of the caches in the collection.
66 .TP
67 .B \fB\-c\fP
68 .sp
69 List tickets held in a credentials cache. This is the default if neither \fI\-c\fP nor \fI\-k\fP is specified.
70 .TP
71 .B \fB\-f\fP
72 .sp
73 Shows the flags present in the credentials, using the following abbreviations:
74 .sp
75 .nf
76 .ft C
77 F    Forwardable
78 f    forwarded
79 P    Proxiable
80 p    proxy
81 D    postDateable
82 d    postdated
83 R    Renewable
84 I    Initial
85 i    invalid
86 H    Hardware authenticated
87 A    preAuthenticated
88 T    Transit policy checked
89 O    Okay as delegate
90 a    anonymous
91 .ft P
92 .fi
93 .TP
94 .B \fB\-s\fP
95 .sp
96 Causes \fIklist\fP to run silently (produce no output), but to still set the exit status according to whether it
97 finds the credentials cache. The exit status is \(aq0\(aq if \fIklist\fP finds a credentials cache, and \(aq1\(aq if it does not
98 or if the tickets are expired.
99 .TP
100 .B \fB\-a\fP
101 .sp
102 Display list of addresses in credentials.
103 .TP
104 .B \fB\-n\fP
105 .sp
106 Show numeric addresses instead of reverse\-resolving addresses.
107 .TP
108 .B \fB\-k\fP
109 .sp
110 List keys held in a keytab file.
111 .TP
112 .B \fB\-t\fP
113 .sp
114 Display the time entry timestamps for each keytab entry in the keytab file.
115 .TP
116 .B \fB\-K\fP
117 .sp
118 Display the value of the encryption key in each \fIkeytab\fP entry in the \fIkeytab\fP file.
119 .TP
120 .B \fB\-V\fP
121 .sp
122 Display the Kerberos version number and exit.
123 .UNINDENT
124 .sp
125 If \fBcache_name\fP or \fBkeytab_name\fP is not specified, \fIklist\fP will display the credentials in the default credentials cache or
126 \fIkeytab\fP file as appropriate. If the \fIKRB5CCNAME\fP environment variable is set, its value is used to name the default ticket cache.
127 .UNINDENT
128 .UNINDENT
129 .SH ENVIRONMENT
130 .sp
131 \fIklist\fP uses the following environment variable:
132 .INDENT 0.0
133 .INDENT 3.5
134 .INDENT 0.0
135 .TP
136 .B \fBKRB5CCNAME\fP
137 .sp
138 Location of the default Kerberos 5 credentials (ticket)
139 cache, in the form \fItype\fP:\fIresidual\fP.  If no type prefix is
140 present, the \fBFILE\fP type is assumed.  The type of the
141 default cache may determine the availability of a cache
142 collection; for instance, a default cache of type \fBDIR\fP
143 causes caches within the directory to be present in the
144 collection.
145 .UNINDENT
146 .UNINDENT
147 .UNINDENT
148 .SH FILES
149 .sp
150 /tmp/krb5cc_[uid] \- Default location of Kerberos 5 credentials cache ([uid] is the decimal UID of the user).
151 .sp
152 /etc/krb5.keytab \- Default location for the local host\(aqs keytab file.
153 .SH SEE ALSO
154 .sp
155 kinit(1), kdestroy(1)
156 .SH AUTHOR
157 MIT
158 .SH COPYRIGHT
159 2011, MIT
160 .\" Generated by docutils manpage writer.
161 .