doc/man-pages/pod8/vldb_check.pod

   1 =head1 NAME
   2
   3 vldb_check - Checks the integrity of the VLDB
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vldb_check> S<<< B<-database> <I<vldb file>> >>> [B<-uheader>] [B<-vheader>]
  11     [B<-servers>] [B<-entries>] [B<-quiet> | B<-verbose>] [B<-fix>]
  12     [B<-help>]
  13
  14 B<vldb_check> S<<< B<-d> <I<vldb file>> >>> [B<-u>] [B<-vh>] [B<-s>] [B<-e>]
  15     [B<-ve>] [B<-f>] [B<-h>]
  16
  17 =for html
  18 </div>
  19
  20 =head1 DESCRIPTION
  21
  22 The B<vldb_check> command checks the integrity of the Volume Location
  23 Database (VLDB), reporting any errors or corruption it finds.  If there
  24 are problems, do not issue any B<vos> commands until the database is
  25 repaired.
  26
  27 =head1 CAUTIONS
  28
  29 The results can be unpredictable if the Volume Location (VL) Server makes
  30 changes to the VLDB while this command is running. Use the B<bos shutdown>
  31 command to shutdown the local B<vlserver> process before running this
  32 command, or before creating a second copy of the F<vldb.DB0> file (with a
  33 different name) on which to run the command.
  34
  35 =head1 OPTIONS
  36
  37 =over 4
  38
  39 =item B<-database> <I<vldb file>>
  40
  41 Names the VLDB (copy of the F<vldb.DB0> file) to check. If the current
  42 working directory is not the location of the file, provide a pathname,
  43 either full or relative to the current working directory.
  44
  45 =item B<-uheader>
  46
  47 Displays information which Ubik maintains in the database's header.
  48
  49 =item B<-vheader>
  50
  51 Displays information which the VL Server maintains in the database's
  52 header.
  53
  54 =item B<-servers> <I<authentication servers>>+
  55
  56 Outputs the server entries from the VLDB, which list the IP addresses
  57 registered for each file server machine in the cell.
  58
  59 =item B<-entries>
  60
  61 Outputs every volume entry in the database. The information includes the
  62 volume's name and the volume ID number for each of its versions.
  63
  64 =item B<-quiet>
  65
  66 Blocks output from going to stdout. Output to stderr is not blocked. Cannot
  67 be used with -verbose, -uheader, -servers or -entries.
  68
  69 =item B<-verbose>
  70
  71 Reports additional information about the database, including the number of
  72 entries for each type of volume. Cannot be used with -quiet.
  73
  74 =item B<-fix>
  75
  76 Try to fix errors in the database. If this option is given, B<vldb_check> will
  77 open the given database file read-write, and will update the database file
  78 in-place. It is recommended that you backup the database file before running
  79 with this option, in case B<vldb_check> removes data in order to fix the
  80 database.
  81
  82 =item B<-help>
  83
  84 Prints the online help for this command. All other valid options are
  85 ignored.
  86
  87 =back
  88
  89 =head1 OUTPUT
  90
  91 If there are errors in the database, the output always reports them on the
  92 standard error stream. If any options other than B<-database> or B<-help>
  93 are provided, the output written to the standard output stream includes
  94 additional information as described for each option in L</OPTIONS>.  The
  95 output is intended for debugging purposes and is meaningful to someone
  96 familiar with the internal structure of the VLDB.
  97
  98 The B<-quiet> option can be used to suppress the standard output stream
  99 so that the command can be used more easily inside scripts.
 100
 101 The command exits with one of the following completion codes:
 102
 103 0: No errors or warnings have been encountered.
 104 1: One or more warnings encountered.
 105 2: One or more warnings and/or errors encountered.
 106 4: A fatal or internal error has occurred and the program cannot proceed.
 107
 108 =head1 PRIVILEGE REQUIRED
 109
 110 The issuer must be logged in as the local superuser C<root>.
 111
 112 =head1 SEE ALSO
 113
 114 L<vldb.DB0(5)>,
 115 L<bos_shutdown(8)>,
 116 L<vlserver(8)>
 117
 118 =head1 COPYRIGHT
 119
 120 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 121
 122 This documentation is covered by the IBM Public License Version 1.0.  It was
 123 converted from HTML to POD by software written by Chas Williams and Russ
 124 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.