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