man-page-reorg-20051209
[openafs.git] / doc / man-pages / pod1 / tokens.pod
1 =head1 NAME
2
3 tokens - Displays the issuer's tokens
4
5 =head1 SYNOPSIS
6
7 B<tokens> [B<-help>]
8
9 B<tokens> [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The tokens command displays all tokens (tickets) cached on the local
14 machine for the issuer. AFS server processes require that their clients
15 present a token as evidence that they have authenticated in the server's
16 local cell.
17
18 =head1 OPTIONS
19
20 =over 4
21
22 =item B<-help>
23
24 Prints the online help for this command. All other valid options are
25 ignored.
26
27 =back
28
29 =head1 OUTPUT
30
31 The output lists one token for each cell in which the user is
32 authenticated. The output indicates the
33
34 =over 4
35
36 =item *
37
38 User's AFS UID, if it is available for display.
39
40 =item *
41
42 Server for which the token is valid (normally, afs).  This includes a cell
43 specification.
44
45 =item *
46
47 Day and time the token expires.
48
49 =back
50
51 The output of the Kerberos version of this command, B<tokens.krb>, also
52 reports the following about the Kerberos ticket-granting ticket: the
53 ticket owner, which Kerberos ticket-granting service that issued the
54 ticket (for example, C<krbtgt.ABC.COM>), and ticket's expiration date.
55
56 The string C<--End of list--> appears at the end of the output. If the
57 user is not authenticated in any cell, this line is all that appears.
58
59 =head1 EXAMPLES
60
61 The following example shows the output when the issuer is not
62 authenticated in any cell.
63
64    % tokens
65    Tokens held by the Cache Manager:
66
67       --End of list--
68    
69 The following example shows the output when the issuer is authenticated in
70 ABC Corporation cell, where he or she has AFS UID 1000.
71
72    % tokens
73    Tokens held by the Cache Manager:
74
75    User's (AFS ID 1000) tokens for afs@abc.com [Expires Jan 2 10:00]
76       --End of list--
77
78 The following example shows the output when the issuer is authenticated in
79 the ABC Corporation cell, the State University cell, and the XYZ Company
80 cell. The user has different AFS UIDs in the three cells. Tokens for last
81 cell are expired:
82
83    % tokens
84    Tokens held by the Cache Manager:
85
86    User's (AFS ID 1000) tokens for afs@abc.com [Expires Jan 3 10:00]
87    User's (AFS ID 4286) tokens for afs@stateu.edu [Expires Jan 3 1:34]
88    User's (AFS ID 22) tokens for afs@xyz.com [>>Expired<]
89       --End of list--
90
91 The following example shows the output when the issuer uses the
92 B<tokens.krb> version of the command after authenticating in the ABC
93 Corporation cell using the B<klog.krb> command.
94
95    % tokens.krb
96    Tokens held by the Cache Manager:
97
98    User's (AFS ID 1000) tokens for afs@abc.com [Expires Jan 31 00:09]
99    User smiths tokens for krbtgt.ABC.COM@abc.com [Expires Jan 31 00:09]
100       --End of list--
101
102 =head1 PRIVILEGE REQUIRED
103
104 None
105
106 =head1 SEE ALSO
107
108 L<klog(1)>,
109 L<unlog(1)>
110
111 =head1 COPYRIGHT
112
113 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
114
115 This documentation is covered by the IBM Public License Version 1.0.  It was
116 converted from HTML to POD by software written by Chas Williams and Russ
117 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.