Install path-substituted man pages
[krb5.git] / src / man / kdestroy.man
1 .TH "KDESTROY" "1" " " "0.0.1" "MIT Kerberos"
2 .SH NAME
3 kdestroy \- destroy 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 \fBkdestroy\fP
36 [\fB\-A\fP]
37 [\fB\-q\fP]
38 [\fB\-c\fP \fIcache_name\fP]
39 .SH DESCRIPTION
40 .sp
41 The kdestroy utility destroys the user\(aqs active Kerberos authorization
42 tickets by overwriting and deleting the credentials cache that
43 contains them.  If the credentials cache is not specified, the default
44 credentials cache is destroyed.
45 .SH OPTIONS
46 .INDENT 0.0
47 .TP
48 .B \fB\-A\fP
49 .sp
50 Destroys all caches in the collection, if a cache collection is
51 available.
52 .TP
53 .B \fB\-q\fP
54 .sp
55 Run quietly.  Normally kdestroy beeps if it fails to destroy the
56 user\(aqs tickets.  The \fB\-q\fP flag suppresses this behavior.
57 .TP
58 .B \fB\-c\fP \fIcache_name\fP
59 .sp
60 Use \fIcache_name\fP as the credentials (ticket) cache name and
61 location; if this option is not used, the default cache name and
62 location are used.
63 .sp
64 The default credentials cache may vary between systems.  If the
65 \fBKRB5CCNAME\fP environment variable is set, its value is used to
66 name the default ticket cache.
67 .UNINDENT
68 .SH NOTE
69 .sp
70 Most installations recommend that you place the kdestroy command in
71 your .logout file, so that your tickets are destroyed automatically
72 when you log out.
73 .SH ENVIRONMENT
74 .sp
75 kdestroy uses the following environment variable:
76 .INDENT 0.0
77 .TP
78 .B \fBKRB5CCNAME\fP
79 .sp
80 Location of the default Kerberos 5 credentials (ticket) cache, in
81 the form \fItype\fP:\fIresidual\fP.  If no \fItype\fP prefix is present, the
82 \fBFILE\fP type is assumed.  The type of the default cache may
83 determine the availability of a cache collection; for instance, a
84 default cache of type \fBDIR\fP causes caches within the directory
85 to be present in the collection.
86 .UNINDENT
87 .SH FILES
88 .INDENT 0.0
89 .TP
90 .B \fB/tmp/krb5cc_[uid]\fP
91 .sp
92 Default location of Kerberos 5 credentials cache ([\fIuid\fP] is the
93 decimal UID of the user).
94 .UNINDENT
95 .SH SEE ALSO
96 .sp
97 \fIkinit(1)\fP, \fIklist(1)\fP
98 .SH AUTHOR
99 MIT
100 .SH COPYRIGHT
101 2011, MIT
102 .\" Generated by docutils manpage writer.
103 .