doc/man-pages/pod8/volinfo.pod

   1 =head1 NAME
   2
   3 volinfo - Produces detailed statistics about AFS volume headers
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<volinfo> [B<-online>] [B<-vnode>] [B<-date>] [B<-inode>] [B<-itime>]
  11     S<<< [B<-part> <I<AFS partition name (default current partition)>>+] >>>
  12     S<<< [B<-volumeid> <I<volume id>>+] >>> [B<-header>] [B<-sizeonly>]
  13     [B<-fixheader>] [B<-saveinodes>] [B<-orphaned>] [B<-filenames>] [B<-help>]
  14
  15 =for html
  16 </div>
  17
  18 =head1 DESCRIPTION
  19
  20 The B<volinfo> command displays detailed statistics about one or more
  21 volume headers and the partition that houses them. The command must be
  22 issued on a file server machine and by default produces output for every
  23 volume on every AFS server partition on the machine. To display output for
  24 the volumes on one partition only, include the B<-part> argument. To
  25 display output for one volume only, include the B<-volumeid> argument.
  26
  27 =head1 OPTIONS
  28
  29 =over 4
  30
  31 =item B<-online>
  32
  33 Is nonoperational.
  34
  35 =item B<-vnode>
  36
  37 Displays a table for each volume which lists the large (directory) and
  38 small (file) vnodes in it, in addition to the default output.
  39
  40 =item B<-date>
  41
  42 When combined with the B<-vnode> flag, adds the C<ServerModTime> field to
  43 each vnode entry in the large vnode and small vnode tables, reporting its
  44 most recent modification time.
  45
  46 =item B<-inode>
  47
  48 When combined with the B<-vnode> flag, adds the C<inode> field to each
  49 vnode entry in the large vnode and small vnode tables, reporting the
  50 associated inode number.
  51
  52 =item B<-itime>
  53
  54 When combined with the B<-vnode> flag, displays a change, modification,
  55 and access timestamp for each of the large vnode and small vnode tables.
  56
  57 =item B<-part> <I<partition name or id>>+
  58
  59 Specifies the partition that houses each volume for which to produce
  60 output. Use the format F</vicepI<xx>> or I<xx>, where I<xx> is one or two lowercase
  61 letters. This argument can be omitted if the current working directory is
  62 the mount location for an AFS server partition; it is not the mount
  63 location for an AFS server partition, the command produces output for
  64 every volume on all local AFS server partitions.
  65
  66 =item B<-volumeid> <I<volume id>>+
  67
  68 Specifies the ID number of one volume for which to produce output.  The
  69 B<-part> argument must be provided along with this one unless the current
  70 working directory is the mount location for the AFS server partition that
  71 houses the volume.
  72
  73 =item B<-header>
  74
  75 Displays statistics about the volume header of each volume, in addition to
  76 the default output.
  77
  78 =item B<-sizeonly>
  79
  80 Displays a single line of output for each volume, reporting the size of
  81 various structures associated with it. The default output is suppressed
  82 and any flags that modify it (such as B<-vnode>) are ignored.
  83
  84 =item B<-fixheader>
  85
  86 Repairs damaged inodes in each volume if possible. If there are any, it
  87 reports the action it is taking to repair them. Otherwise, it produces no
  88 output in addition to the default output.
  89
  90 =item B<-saveinodes>
  91
  92 Creates a file in the current working directory for each inode in each
  93 volume. Each file is called F<TmpInode.I<vnode_number>> and contains the
  94 inode's contents. The default output is suppressed and any flags that
  95 modify it (such as B<-vnode>) are ignored.
  96
  97 =item B<-orphaned>
  98
  99 Displays a large vnode and small vnode table for each volume, which lists
 100 only orphaned vnodes (vnodes that have no parent). If there are none, the
 101 tables are empty (only the headers appear).
 102
 103 =item B<-filenames>
 104
 105 When combined with the B<-vnode> flag, adds the full path and file name of the
 106 C<namei> file which stores the vnode data to each vnode entry in the large vnode
 107 and small vnode tables. This option is only available on fileservers which use
 108 the C<namei> storage format for storing data.
 109
 110 =item B<-help>
 111
 112 Prints the online help for this command. All other valid options are
 113 ignored.
 114
 115 =back
 116
 117 =head1 OUTPUT
 118
 119 By default, the command produces several line of statistics for each
 120 volume. Adding other options produces or substitutes additional
 121 information as described in L</OPTIONS>.  The output is intended for
 122 debugging purposes and is meaningful to someone familiar with the internal
 123 structure of volume headers.
 124
 125 =head1 PRIVILEGE REQUIRED
 126
 127 The issuer must be logged in as the local superuser C<root>.
 128
 129 =head1 SEE ALSO
 130
 131 L<vldb.DB0(5)>,
 132 L<volserver(8)>
 133
 134 =head1 COPYRIGHT
 135
 136 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 137
 138 This documentation is covered by the IBM Public License Version 1.0.  It was
 139 converted from HTML to POD by software written by Chas Williams and Russ
 140 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.