8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man1 / kdestroy.1
blob7d37cf33dd0942270ffc1292e7c23f12b598a626
1 '\" te
2 .\" Copyright 1987, 1989 by the Student Information Processing Board of the Massachusetts Institute of Technology.  For copying and distribution information,  please see the file kerberosv5/mit-sipb-copyright.h.
3 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH KDESTROY 1 "Apr 30, 2004"
8 .SH NAME
9 kdestroy \- destroy Kerberos tickets
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/usr/bin/kdestroy\fR [\fB-q\fR] [\fB-c\fR \fIcache_name\fR]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fBkdestroy\fR utility destroys the user's active Kerberos authorization
20 tickets by writing zeros to the specified credentials cache that contains them.
21 If the credentials cache is not specified, the default credentials cache is
22 destroyed. If the credentials cache does not exist, \fBkdestroy\fR displays a
23 message to that effect.
24 .sp
25 .LP
26 After overwriting the cache, \fBkdestroy\fR removes the cache from the system.
27 The utility displays a message indicating the success or failure of the
28 operation. If \fBkdestroy\fR is unable to destroy the cache, it will warn you
29 by making your terminal beep.
30 .sp
31 .LP
32 If desired, you can place the \fBkdestroy\fR command in your \fB\&.logout\fR
33 file so that your tickets are destroyed automatically when you logout.
34 .SH OPTIONS
35 .sp
36 .LP
37 The following options are supported:
38 .sp
39 .ne 2
40 .na
41 \fB\fB-c\fR \fIcache_name\fR\fR
42 .ad
43 .RS 17n
44 Uses \fIcache_name\fR as the credentials (ticket) cache name and location. If
45 this option is not used, the default cache name and location are used.
46 .RE
48 .sp
49 .ne 2
50 .na
51 \fB\fB-q\fR\fR
52 .ad
53 .RS 17n
54 Runs quietly. Your terminal will not beep when \fBkdestroy\fR fails to destroy
55 the tickets.
56 .RE
58 .SH ENVIRONMENT VARIABLES
59 .sp
60 .LP
61 \fBkdestroy\fR uses the following environment variable:
62 .sp
63 .ne 2
64 .na
65 \fB\fBKRB5CCNAME\fR\fR
66 .ad
67 .RS 14n
68 Location of the credentials (ticket) cache. See \fBkrb5envvar\fR(5) for syntax
69 and details.
70 .RE
72 .SH FILES
73 .sp
74 .ne 2
75 .na
76 \fB\fB/tmp/krb5cc_\fIuid\fR\fR\fR
77 .ad
78 .RS 19n
79 Default credentials cache (\fIuid\fR is the decimal \fBUID\fR of the user).
80 .RE
82 .SH ATTRIBUTES
83 .sp
84 .LP
85 See \fBattributes\fR(5) for descriptions of the following attributes:
86 .sp
88 .sp
89 .TS
90 box;
91 c | c
92 l | l .
93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
95 Interface Stability     Evolving
97 Command arguments       Evolving
99 Command output  Unstable
102 .SH SEE ALSO
105 \fBkinit\fR(1), \fBklist\fR(1), \fBattributes\fR(5), \fBkerberos\fR(5),
106 \fBkrb5envvar\fR(5)
107 .SH BUGS
110 Only the tickets in the specified credentials cache are destroyed. Separate
111 ticket caches are used to hold root instance and password changing tickets.
112 These files should probably be destroyed too, or all of a user's tickets should
113 be kept in a single credential cache.