Update NEWS for 1.8.0pre3
[pkg-k5-afs_openafs.git] / doc / man-pages / pod1 / tokens.pod
blobd7cf16dd0ddd4a706d74220046226228d847be8e
1 =head1 NAME
3 tokens, tokens.krb - Displays the issuer's tokens
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<tokens> [B<-help>]
12 B<tokens> [B<-h>]
14 B<tokens.krb> [B<-help>]
16 B<tokens.krb> [B<-h>]
18 =for html
19 </div>
21 =head1 DESCRIPTION
23 The B<tokens> command displays all tokens (tickets) cached on the local
24 machine for the issuer. AFS server processes require that their clients
25 present a token as evidence that they have authenticated in the server's
26 local cell.
28 The (mostly obsolete) B<tokens.krb> command is the same as B<tokens>
29 except that it also displays the user's Kerberos v4 ticket cache.
31 =head1 OPTIONS
33 =over 4
35 =item B<-help>
37 Prints the online help for this command. All other valid options are
38 ignored.
40 =back
42 =head1 OUTPUT
44 The output lists one token for each cell in which the user is
45 authenticated. The output indicates the
47 =over 2
49 =item *
51 User's AFS UID, if it is available for display.
53 =item *
55 Server for which the token is valid (normally, afs).  This includes a cell
56 specification.
58 =item *
60 Day and time the token expires.
62 =back
64 The output of the Kerberos version of this command, B<tokens.krb>, also
65 reports the following about the Kerberos ticket-granting ticket: the
66 ticket owner, which Kerberos ticket-granting service that issued the
67 ticket (for example, C<krbtgt.EXAMPLE.COM>), and ticket's expiration date.
69 The string C<--End of list--> appears at the end of the output. If the
70 user is not authenticated in any cell, this line is all that appears.
72 =head1 EXAMPLES
74 The following example shows the output when the issuer is not
75 authenticated in any cell.
77    % tokens
78    Tokens held by the Cache Manager:
80       --End of list--
82 The following example shows the output when the issuer is authenticated in
83 Example Corporation cell, where he or she has AFS UID 1000.
85    % tokens
86    Tokens held by the Cache Manager:
88    User's (AFS ID 1000) tokens for afs@example.com [Expires Jan 2 10:00]
89       --End of list--
91 The following example shows the output when the issuer is authenticated in
92 the Example Corporation cell, the Example Organization cell, and the Example
93 Network cell. The user has different AFS UIDs in the three cells. Tokens for
94 last cell are expired:
96    % tokens
97    Tokens held by the Cache Manager:
99    User's (AFS ID 1000) tokens for afs@example.com [Expires Jan 3 10:00]
100    User's (AFS ID 4286) tokens for afs@example.org [Expires Jan 3 1:34]
101    User's (AFS ID 22) tokens for afs@example.net [>>Expired<]
102       --End of list--
104 The following example shows the output when the issuer uses the
105 B<tokens.krb> version of the command after authenticating in the Example
106 Corporation cell using the B<klog.krb> command.
108    % tokens.krb
109    Tokens held by the Cache Manager:
111    User's (AFS ID 1000) tokens for afs@example.com [Expires Jan 31 00:09]
112    User smiths tokens for krbtgt.EXAMPLE.COM@example.com [Expires Jan 31 00:09]
113       --End of list--
115 =head1 PRIVILEGE REQUIRED
117 None
119 =head1 SEE ALSO
121 L<klog(1)>,
122 L<unlog(1)>
124 =head1 COPYRIGHT
126 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
128 This documentation is covered by the IBM Public License Version 1.0.  It was
129 converted from HTML to POD by software written by Chas Williams and Russ
130 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.