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