doc/xml/AdminReference/sect8/bos_prune.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_prune8">
   3   <refmeta>
   4     <refentrytitle>bos prune</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos prune</refname>
   9     <refpurpose>Removes obsolete files from /usr/afs/bin and /usr/afs/logs</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos prune</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-bak</emphasis>] [<emphasis role="bold">-old</emphasis>] [<emphasis role="bold">-core</emphasis>]
  14         [<emphasis role="bold">-all</emphasis>] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>]
  15         [<emphasis role="bold">-help</emphasis>]</para>
  16
  17     <para><emphasis role="bold">bos p</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-b</emphasis>] [<emphasis role="bold">-o</emphasis>] [<emphasis role="bold">-co</emphasis>] [<emphasis role="bold">-a</emphasis>]
  18         [<emphasis role="bold">-ce</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  19
  20   </refsect1>
  21   <refsect1>
  22     <title>Description</title>
  23     <para>The <emphasis role="bold">bos prune</emphasis> command removes files from the local disk of the server
  24     machine named by the <emphasis role="bold">-server</emphasis> argument, as specified by one or more of
  25     the following flags provided on the command line:</para>
  26
  27     <itemizedlist>
  28       <listitem>
  29         <para>The <emphasis role="bold">-bak</emphasis> flag removes all files from the <replaceable>/usr/afs/bin</replaceable> directory that
  30         have a <computeroutput>.BAK</computeroutput> extension.</para>
  31
  32       </listitem>
  33       <listitem>
  34         <para>The <emphasis role="bold">-old</emphasis> flag removes all files from the <replaceable>/usr/afs/bin</replaceable> directory that
  35         have a <computeroutput>.OLD</computeroutput> extension.</para>
  36
  37       </listitem>
  38       <listitem>
  39         <para>The <emphasis role="bold">-core</emphasis> flag removes all files from the <replaceable>/usr/afs/logs</replaceable> directory
  40         that have a <computeroutput>core.</computeroutput> prefix.</para>
  41
  42       </listitem>
  43       <listitem>
  44         <para>The <emphasis role="bold">-all</emphasis> flag removes all three types of files at once.</para>
  45
  46       </listitem>
  47     </itemizedlist>
  48     <para>(If none of these flags are included, the command appears to succeed, but
  49     removes no files at all.)</para>
  50
  51     <para>To display the timestamp on the current, <computeroutput>.BAK</computeroutput>, and <computeroutput>.OLD</computeroutput> versions of
  52     one or more files, use the <emphasis role="bold">bos getdate</emphasis> command.</para>
  53
  54   </refsect1>
  55   <refsect1>
  56     <title>Options</title>
  57     <variablelist>
  58       <varlistentry>
  59         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
  60         <listitem>
  61           <para>Indicates the server machine from which to remove files. Identify the
  62           machine by IP address or its host name (either fully-qualified or
  63           abbreviated unambiguously). For details, see <link linkend="bos8">bos(8)</link>.</para>
  64
  65         </listitem>
  66       </varlistentry>
  67       <varlistentry>
  68         <term><emphasis role="bold">-bak</emphasis></term>
  69         <listitem>
  70           <para>Removes all files from the <replaceable>/usr/afs/bin</replaceable> directory that have a <computeroutput>.BAK</computeroutput>
  71           extension. Do not combine this flag and the <emphasis role="bold">-all</emphasis> flag.</para>
  72
  73         </listitem>
  74       </varlistentry>
  75       <varlistentry>
  76         <term><emphasis role="bold">-old</emphasis></term>
  77         <listitem>
  78           <para>Removes all files from the <replaceable>/usr/afs/bin</replaceable> directory that have a <computeroutput>.OLD</computeroutput>
  79           extension. Do not combine this flag and the <emphasis role="bold">-all</emphasis> flag.</para>
  80
  81         </listitem>
  82       </varlistentry>
  83       <varlistentry>
  84         <term><emphasis role="bold">-core</emphasis></term>
  85         <listitem>
  86           <para>Removes all files from the <replaceable>/usr/afs/logs</replaceable> directory that have a <computeroutput>core.</computeroutput>
  87           prefix. Do not combine this flag and the <emphasis role="bold">-all</emphasis> flag.</para>
  88
  89         </listitem>
  90       </varlistentry>
  91       <varlistentry>
  92         <term><emphasis role="bold">-all</emphasis></term>
  93         <listitem>
  94           <para>Combines the effect of the <emphasis role="bold">-bak</emphasis>, <emphasis role="bold">-old</emphasis>, and <emphasis role="bold">-core</emphasis> flags. Do not
  95           combine this flag with any of those three.</para>
  96
  97         </listitem>
  98       </varlistentry>
  99       <varlistentry>
 100         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
 101         <listitem>
 102           <para>Names the cell in which to run the command. Do not combine this argument
 103           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
 104
 105         </listitem>
 106       </varlistentry>
 107       <varlistentry>
 108         <term><emphasis role="bold">-noauth</emphasis></term>
 109         <listitem>
 110           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
 111           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
 112           <link linkend="bos8">bos(8)</link>.</para>
 113
 114         </listitem>
 115       </varlistentry>
 116       <varlistentry>
 117         <term><emphasis role="bold">-localauth</emphasis></term>
 118         <listitem>
 119           <para>Constructs a server ticket using a key from the local
 120           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
 121           ticket to the BOS Server during mutual authentication. Do not combine this
 122           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
 123           <link linkend="bos8">bos(8)</link>.</para>
 124
 125         </listitem>
 126       </varlistentry>
 127       <varlistentry>
 128         <term><emphasis role="bold">-help</emphasis></term>
 129         <listitem>
 130           <para>Prints the online help for this command. All other valid options are
 131           ignored.</para>
 132
 133         </listitem>
 134       </varlistentry>
 135     </variablelist>
 136   </refsect1>
 137   <refsect1>
 138     <title>Examples</title>
 139     <para>The following example removes all files from the <replaceable>/usr/afs/bin</replaceable> directory
 140     on the machine <computeroutput>fs3.abc.com</computeroutput> that have a <computeroutput>.BAK</computeroutput> or <computeroutput>.OLD</computeroutput> extension.</para>
 141
 142 <programlisting>
 143    % bos prune -server fs3.abc.com -bak -old
 144
 145 </programlisting>
 146       <para>The following example removes all files from the <replaceable>/usr/afs/bin</replaceable> directory
 147       on the machine <computeroutput>db2.abc.com</computeroutput> that have a <computeroutput>.BAK</computeroutput> or <computeroutput>.OLD</computeroutput> extension,
 148       and all files from the <replaceable>/usr/afs/logs</replaceable> directory that have a <computeroutput>core.</computeroutput>
 149       prefix.</para>
 150
 151 <programlisting>
 152    % bos prune -server db2.abc.com -all
 153
 154 </programlisting>
 155       </refsect1>
 156       <refsect1>
 157         <title>Privilege Required</title>
 158         <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 159         machine named by the <emphasis role="bold">-server</emphasis> argument, or must be logged onto a server
 160         machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 161         included.</para>
 162
 163       </refsect1>
 164       <refsect1>
 165         <title>See Also</title>
 166         <para><link linkend="KeyFile5">KeyFile(5)</link>,
 167         <link linkend="UserList5">UserList(5)</link>,
 168         <link linkend="bos8">bos(8)</link>,
 169         <link linkend="bos_getdate8">bos_getdate(8)</link></para>
 170
 171       </refsect1>
 172       <refsect1>
 173         <title>Copyright</title>
 174         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 175
 176         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 177         converted from HTML to POD by software written by Chas Williams and Russ
 178         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 179
 180       </refsect1>
 181     </refentry>