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