doc: volinfo manpage fixes
[openafs.git] / doc / man-pages / pod8 / volinfo.pod
index 1c6e84d..9131b36 100644 (file)
@@ -7,9 +7,9 @@ volinfo - Produces detailed statistics about AFS volume headers
 =for html
 <div class="synopsis">
 
-B<volinfo> [B<-online>] [B<-vnode>] [B<-date>] [B<-inode>] [B<-itime>]
+B<volinfo> [B<-checkout>] [B<-vnode>] [B<-date>] [B<-inode>] [B<-itime>]
     S<<< [B<-part> <I<AFS partition name (default current partition)>>+] >>>
-    S<<< [B<-volumeid> <I<volume id>>+] >>> [B<-header>] [B<-sizeOnly>]
+    S<<< [B<-volumeid> <I<volume id>>+] >>> [B<-header>] [B<-sizeonly>]
     [B<-fixheader>] [B<-saveinodes>] [B<-orphaned>] [B<-filenames>] [B<-help>]
 
 =for html
@@ -28,9 +28,11 @@ display output for one volume only, include the B<-volumeid> argument.
 
 =over 4
 
-=item B<-online>
+=item B<-checkout>
 
-Is nonoperational.
+Checkout the specified volume from the running fileserver. This ensures that
+the fileserver or other processes will not be modifying volume metadata at the
+same time we are trying to read it, leading to invalid or incorrect results.
 
 =item B<-vnode>
 
@@ -75,7 +77,7 @@ houses the volume.
 Displays statistics about the volume header of each volume, in addition to
 the default output.
 
-=item B<-sizeOnly>
+=item B<-sizeonly>
 
 Displays a single line of output for each volume, reporting the size of
 various structures associated with it. The default output is suppressed
@@ -118,7 +120,7 @@ ignored.
 
 By default, the command produces several line of statistics for each
 volume. Adding other options produces or substitutes additional
-information as described in L<OPTIONS>.  The output is intended for
+information as described in L</OPTIONS>.  The output is intended for
 debugging purposes and is meaningful to someone familiar with the internal
 structure of volume headers.