doc/xml/AdminReference/sect8/volinfo.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="volinfo8">
   3   <refmeta>
   4     <refentrytitle>volinfo</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>volinfo</refname>
   9     <refpurpose>Produces detailed statistics about AFS volume headers</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">volinfo</emphasis> [<emphasis role="bold">-online</emphasis>] [<emphasis role="bold">-vnode</emphasis>] [<emphasis role="bold">-date</emphasis>] [<emphasis role="bold">-inode</emphasis>] [<emphasis role="bold">-itime</emphasis>]
  14         [<emphasis role="bold">-part</emphasis> &lt;<emphasis>AFS partition name (default current partition)</emphasis>&gt;+]
  15         [<emphasis role="bold">-volumeid</emphasis> &lt;<emphasis>volume id</emphasis>&gt;+] [<emphasis role="bold">-header</emphasis>] [<emphasis role="bold">-sizeOnly</emphasis>]
  16         [<emphasis role="bold">-fixheader</emphasis>] [<emphasis role="bold">-saveinodes</emphasis>] [<emphasis role="bold">-orphaned</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  17
  18   </refsect1>
  19   <refsect1>
  20     <title>Description</title>
  21     <para>The <emphasis role="bold">volinfo</emphasis> command displays detailed statistics about one or more
  22     volume headers and the partition that houses them. The command must be
  23     issued on a file server machine and by default produces output for every
  24     volume on every AFS server partition on the machine. To display output for
  25     the volumes on one partition only, include the <emphasis role="bold">-part</emphasis> argument. To
  26     display output for one volume only, include the <emphasis role="bold">-volumeid</emphasis> argument.</para>
  27
  28   </refsect1>
  29   <refsect1>
  30     <title>Options</title>
  31     <variablelist>
  32       <varlistentry>
  33         <term><emphasis role="bold">-online</emphasis></term>
  34         <listitem>
  35           <para>Is nonoperational.</para>
  36
  37         </listitem>
  38       </varlistentry>
  39       <varlistentry>
  40         <term><emphasis role="bold">-vnode</emphasis></term>
  41         <listitem>
  42           <para>Displays a table for each volume which lists the large (directory) and
  43           small (file) vnodes in it, in addition to the default output.</para>
  44
  45         </listitem>
  46       </varlistentry>
  47       <varlistentry>
  48         <term><emphasis role="bold">-date</emphasis></term>
  49         <listitem>
  50           <para>When combined with the <emphasis role="bold">-vnode</emphasis> flag, adds the <computeroutput>ServerModTime</computeroutput> field to
  51           each vnode entry in the large vnode and small vnode tables, reporting its
  52           most recent modification time.</para>
  53
  54         </listitem>
  55       </varlistentry>
  56       <varlistentry>
  57         <term><emphasis role="bold">-inode</emphasis></term>
  58         <listitem>
  59           <para>When combined with the <emphasis role="bold">-vnode</emphasis> flag, adds the <computeroutput>inode</computeroutput> field to each
  60           vnode entry in the large vnode and small vnode tables, reporting the
  61           associated inode number.</para>
  62
  63         </listitem>
  64       </varlistentry>
  65       <varlistentry>
  66         <term><emphasis role="bold">-itime</emphasis></term>
  67         <listitem>
  68           <para>When combined with the <emphasis role="bold">-vnode</emphasis> flag, displays a change, modification,
  69           and access timestamp for each of the large vnode and small vnode tables.</para>
  70
  71         </listitem>
  72       </varlistentry>
  73       <varlistentry>
  74         <term><emphasis role="bold">-part</emphasis> &lt;<emphasis>partition name</emphasis>&gt;+</term>
  75         <listitem>
  76           <para>Specifies the partition that houses each volume for which to produce
  77           output. Use the format <replaceable>/vicep</replaceable><emphasis>xx</emphasis><replaceable></replaceable>, where <emphasis>xx</emphasis> is one or two lowercase
  78           letters. This argument can be omitted if the current working directory is
  79           the mount location for an AFS server partition; it is not the mount
  80           location for an AFS server partition, the command produces output for
  81           every volume on all local AFS server partitions.</para>
  82
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term><emphasis role="bold">-volumeid</emphasis> &lt;<emphasis>volume id</emphasis>&gt;+</term>
  87         <listitem>
  88           <para>Specifies the ID number of one volume for which to produce output.  The
  89           <emphasis role="bold">-part</emphasis> argument must be provided along with this one unless the current
  90           working directory is the mount location for the AFS server partition that
  91           houses the volume.</para>
  92
  93         </listitem>
  94       </varlistentry>
  95       <varlistentry>
  96         <term><emphasis role="bold">-header</emphasis></term>
  97         <listitem>
  98           <para>Displays statistics about the volume header of each volume, in addition to
  99           the default output.</para>
 100
 101         </listitem>
 102       </varlistentry>
 103       <varlistentry>
 104         <term><emphasis role="bold">-sizeOnly</emphasis></term>
 105         <listitem>
 106           <para>Displays a single line of output for each volume, reporting the size of
 107           various structures associated with it. The default output is suppressed
 108           and any flags that modify it (such as <emphasis role="bold">-vnode</emphasis>) are ignored.</para>
 109
 110         </listitem>
 111       </varlistentry>
 112       <varlistentry>
 113         <term><emphasis role="bold">-fixheader</emphasis></term>
 114         <listitem>
 115           <para>Repairs damaged inodes in each volume if possible. If there are any, it
 116           reports the action it is taking to repair them. Otherwise, it produces no
 117           output in addition to the default output.</para>
 118
 119         </listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term><emphasis role="bold">-saveinodes</emphasis></term>
 123         <listitem>
 124           <para>Creates a file in the current working directory for each inode in each
 125           volume. Each file is called <replaceable>TmpInode.</replaceable><emphasis>vnode_number</emphasis><replaceable></replaceable> and contains the
 126           inode's contents. The default output is suppressed and any flags that
 127           modify it (such as <emphasis role="bold">-vnode</emphasis>) are ignored.</para>
 128
 129         </listitem>
 130       </varlistentry>
 131       <varlistentry>
 132         <term><emphasis role="bold">-orphaned</emphasis></term>
 133         <listitem>
 134           <para>Displays a large vnode and small vnode table for each volume, which lists
 135           only orphaned vnodes (vnodes that have no parent). If there are none, the
 136           tables are empty (only the headers appear).</para>
 137
 138         </listitem>
 139       </varlistentry>
 140       <varlistentry>
 141         <term><emphasis role="bold">-help</emphasis></term>
 142         <listitem>
 143           <para>Prints the online help for this command. All other valid options are
 144           ignored.</para>
 145
 146         </listitem>
 147       </varlistentry>
 148     </variablelist>
 149   </refsect1>
 150   <refsect1>
 151     <title>Output</title>
 152     <para>By default, the command produces several line of statistics for each
 153     volume. Adding other options produces or substitutes additional
 154     information as described in <link linkend="OPTIONS">OPTIONS</link>.  The output is intended for
 155     debugging purposes and is meaningful to someone familiar with the internal
 156     structure of volume headers.</para>
 157
 158   </refsect1>
 159   <refsect1>
 160     <title>Privilege Required</title>
 161     <para>The issuer must be logged in as the local superuser <computeroutput>root</computeroutput>.</para>
 162
 163   </refsect1>
 164   <refsect1>
 165     <title>See Also</title>
 166     <para><link linkend="vldb_DB05">vldb.DB0(5)</link>,
 167     <link linkend="volserver8">volserver(8)</link></para>
 168
 169   </refsect1>
 170   <refsect1>
 171     <title>Copyright</title>
 172     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 173
 174     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 175     converted from HTML to POD by software written by Chas Williams and Russ
 176     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 177
 178   </refsect1>
 179 </refentry>