xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect1 / unlog.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="unlog1">
3   <refmeta>
4     <refentrytitle>unlog</refentrytitle>
5     <manvolnum>1</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>unlog</refname>
9     <refpurpose>Discards all of the issuer's tokens</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">unlog</emphasis> [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;+] [<emphasis role="bold">-help</emphasis>]</para>
14
15     <para><emphasis role="bold">unlog</emphasis> [<emphasis role="bold">-c </emphasis>&lt;<emphasis>cell name</emphasis>&gt;+] [<emphasis role="bold">-h</emphasis>]</para>
16
17   </refsect1>
18   <refsect1>
19     <title>Description</title>
20     <para>The <emphasis role="bold">unlog</emphasis> command by default discards all tokens that the issuer
21     currently holds. To discard tokens for certain cells only, name them with
22     the <emphasis role="bold">-cell</emphasis> argument.</para>
23
24     <para>Since a token pertains to one client machine only, destroying tokens on
25     one machine has no effect on tokens on another machine.</para>
26
27   </refsect1>
28   <refsect1>
29     <title>Cautions</title>
30     <para>Specifying one or more cell names can cause a brief authentication outage
31     during which the issuer has no valid tokens in any cell. This is because
32     the command actually discards all tokens and then restores the ones for
33     cells not named by the <emphasis role="bold">-cell</emphasis> argument. The outage can sometimes
34     interrupt the operation of jobs that require authentication.</para>
35
36   </refsect1>
37   <refsect1>
38     <title>Options</title>
39     <variablelist>
40       <varlistentry>
41         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;+</term>
42         <listitem>
43           <para>Specifies each cell for to discard the token. If this argument is omitted,
44           the Cache Manager discards all tokens. Provide the fully qualified domain
45           name, or a shortened form, in which case successful resolution depends on
46           the availability of a name resolution service (such as the Domain Name
47           Service or a local host table) at the time the command is issued.</para>
48
49         </listitem>
50       </varlistentry>
51       <varlistentry>
52         <term><emphasis role="bold">-help</emphasis></term>
53         <listitem>
54           <para>Prints the online help for this command. All other valid options are
55           ignored.</para>
56
57         </listitem>
58       </varlistentry>
59     </variablelist>
60   </refsect1>
61   <refsect1>
62     <title>Examples</title>
63     <para>The following command discards all tokens.</para>
64
65 <programlisting>
66    % unlog
67
68 </programlisting>
69       <para>The following command discards only the tokens for the <computeroutput>abc.com</computeroutput> and
70       <computeroutput>stateu.edu</computeroutput> cells.</para>
71
72 <programlisting>
73    % unlog -cell abc.com stateu
74
75 </programlisting>
76       </refsect1>
77       <refsect1>
78         <title>Privilege Required</title>
79         <para>None</para>
80
81       </refsect1>
82       <refsect1>
83         <title>See Also</title>
84         <para><link linkend="klog1">klog(1)</link>,
85         <link linkend="tokens1">tokens(1)</link></para>
86
87       </refsect1>
88       <refsect1>
89         <title>Copyright</title>
90         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
91
92         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
93         converted from HTML to POD by software written by Chas Williams and Russ
94         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
95
96       </refsect1>
97     </refentry>