doc/man-pages/pod8/volinfo.pod

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