man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod1 / unlog.pod
1 =head1 NAME
2
3 unlog - Discards all of the issuer's tokens
4
5 =head1 SYNOPSIS
6
7 B<unlog> [B<-cell> <I<cell name>>+] [B<-help>]
8
9 B<unlog> [B<-c ><I<cell name>>+] [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The B<unlog> command by default discards all tokens that the issuer
14 currently holds. To discard tokens for certain cells only, name them with
15 the B<-cell> argument.
16
17 Since a token pertains to one client machine only, destroying tokens on
18 one machine has no effect on tokens on another machine.
19
20 =head1 CAUTIONS
21
22 Specifying one or more cell names can cause a brief authentication outage
23 during which the issuer has no valid tokens in any cell. This is because
24 the command actually discards all tokens and then restores the ones for
25 cells not named by the B<-cell> argument. The outage can sometimes
26 interrupt the operation of jobs that require authentication.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-cell> <I<cell name>>+
33
34 Specifies each cell for to discard the token. If this argument is omitted,
35 the Cache Manager discards all tokens. Provide the fully qualified domain
36 name, or a shortened form, in which case successful resolution depends on
37 the availability of a name resolution service (such as the Domain Name
38 Service or a local host table) at the time the command is issued.
39
40 =item B<-help>
41
42 Prints the online help for this command. All other valid options are
43 ignored.
44
45 =back
46
47 =head1 EXAMPLES
48
49 The following command discards all tokens.
50
51    % unlog
52
53 The following command discards only the tokens for the C<abc.com> and
54 C<stateu.edu> cells.
55
56    % unlog -cell abc.com stateu
57
58 =head1 PRIVILEGE REQUIRED
59
60 None
61
62 =head1 SEE ALSO
63
64 L<klog(1)>,
65 L<tokens(1)>
66
67 =head1 COPYRIGHT
68
69 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
70
71 This documentation is covered by the IBM Public License Version 1.0.  It was
72 converted from HTML to POD by software written by Chas Williams and Russ
73 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.