From: Andrew Deason <adeason@sinenomine.net>
Date: Wed, 24 Jul 2013 23:00:25 +0000 (-0500)
Subject: doc: vldb_check manpage fixes
X-Git-Tag: openafs-stable-1_8_0pre1~926
X-Git-Url: https://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=374593ca5790203cd856ea1705dbda721d3c3f3a

doc: vldb_check manpage fixes

 - Add missing option -fix

 - Don't use brackets in the option list; we don't do this in most
   other manpages.

Change-Id: Ifd87dd749aaab2987b2f9c3224b8e931b7bc221c
Reviewed-on: http://gerrit.openafs.org/10403
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
---

diff --git a/doc/man-pages/pod8/vldb_check.pod b/doc/man-pages/pod8/vldb_check.pod
index e5d76a9..c859e8a 100644
--- a/doc/man-pages/pod8/vldb_check.pod
+++ b/doc/man-pages/pod8/vldb_check.pod
@@ -8,10 +8,11 @@ vldb_check - Checks the integrity of the VLDB
 <div class="synopsis">
 
 B<vldb_check> S<<< B<-database> <I<vldb file>> >>> [B<-uheader>] [B<-vheader>]
-    [B<-servers>] [B<-entries>] [B<-quiet> | B<-verbose>] [B<-help>]
+    [B<-servers>] [B<-entries>] [B<-quiet> | B<-verbose>] [B<-fix>]
+    [B<-help>]
 
 B<vldb_check> S<<< B<-d> <I<vldb file>> >>> [B<-u>] [B<-vh>] [B<-s>] [B<-e>]
-    [B<-ve>] [B<-h>]
+    [B<-ve>] [B<-f>] [B<-h>]
 
 =for html
 </div>
@@ -70,6 +71,14 @@ be used with -verbose, -uheader, -servers or -entries.
 Reports additional information about the database, including the number of
 entries for each type of volume. Cannot be used with -quiet.
 
+=item B<-fix>
+
+Try to fix errors in the database. If this option is given, B<vldb_check> will
+open the given database file read-write, and will update the database file
+in-place. It is recommended that you backup the database file before running
+with this option, in case B<vldb_check> removes data in order to fix the
+database.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
diff --git a/doc/man-pages/pod8/vldb_convert.pod b/doc/man-pages/pod8/vldb_convert.pod
index d5d5021..d3a3f11 100644
--- a/doc/man-pages/pod8/vldb_convert.pod
+++ b/doc/man-pages/pod8/vldb_convert.pod
@@ -81,22 +81,22 @@ relaxed in OpenAFS.
 
 =over 4
 
-=item [B<initcmd>]
+=item B<initcmd>
 
 This is an optional string that does nothing.
 
-=item [B<-to>] <I<AFS version goal>>
+=item B<-to> <I<AFS version goal>>
 
 This option is required when downgrading or when upgrading to a version
 less than 3.4.  Specify 1, 2, 3, or 4 to choose version 3.1, 3.2, 3.3, or
 3,4 respectively. This defaults to version 3.4.
 
-=item [B<-from>] <I<current AFS version>>
+=item B<-from> <I<current AFS version>>
 
 This option is required when downgrading. Specify 1, 2, 3, or 4 to choose
 version 3.1, 3.2, 3.3, or 3.4 respectively.
 
-=item [B<-path>] <I<path to VLDB file>>
+=item B<-path> <I<path to VLDB file>>
 
 Specifies the path the VLDB file. This defaults to F</usr/afs/db/vldb.DB0>
 and only needs to be used if the VLDB file is not in the default path..