man8-editing-pass-20051213
[openafs.git] / 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 B<vldb_check> B<-database> <I<vldb file>> [B<-uheader>] [B<-vheader>]
8     [B<-servers>] [B<-entries>] [B<-verbose>] [B<-help>]
9
10 B<vldb_check> B<-d> <I<vldb file>> [B<-u>] [B<-vh>] [B<-s>] [B<-e>]
11     [B<-ve>] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The B<vldb_check> command checks the integrity of the Volume Location
16 Database (VLDB), reporting any errors or corruption it finds.  If there
17 are problems, do not issue any B<vos> commands until the database is
18 repaired.
19
20 =head1 CAUTIONS
21
22 The results can be unpredictable if the Volume Location (VL) Server makes
23 changes to the VLDB while this command is running. Use the B<bos shutdown>
24 command to shutdown the local B<vlserver> process before running this
25 command, or before creating a second copy of the F<vldb.DB0> file (with a
26 different name) on which to run the command.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-database> <I<vldb file>>
33
34 Names the VLDB (copy of the F<vldb.DB0> file) to check. If the current
35 working directory is not the location of the file, provide a pathname,
36 either full or relative to the current working directory.
37
38 =item B<-uheader>
39
40 Displays information which Ubik maintains in the database's header.
41
42 =item B<-pheader>
43
44 Displays information which the VL Server maintains in the database's
45 header.
46
47 =item B<-servers> <I<authentication servers>>+
48
49 Outputs the server entries from the VLDB, which list the IP addresses
50 registered for each file server machine in the cell.
51
52 =item B<-entries>
53
54 Outputs every volume entry in the database. The information includes the
55 volume's name and the volume ID number for each of its versions.
56
57 =item B<-verbose>
58
59 Reports additional information about the database, including the number of
60 entries for each type of volume.
61
62 =item B<-help>
63
64 Prints the online help for this command. All other valid options are
65 ignored.
66
67 =back
68
69 =head1 OUTPUT
70
71 If there are errors in the database, the output always reports them on the
72 standard error stream. If any options other than B<-database> or B<-help>
73 are provided, the output written to the standard output stream includes
74 additional information as described for each option in L<OPTIONS>.  The
75 output is intended for debugging purposes and is meaningful to someone
76 familiar with the internal structure of the VLDB.
77
78 =head1 PRIVILEGE REQUIRED
79
80 The issuer must be logged in as the local superuser C<root>.
81
82 =head1 SEE ALSO
83
84 L<vldb.DB0(5)>,
85 L<bos_shutdown(8)>,
86 L<vlserver(8)>
87
88 =head1 COPYRIGHT
89
90 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
91
92 This documentation is covered by the IBM Public License Version 1.0.  It was
93 converted from HTML to POD by software written by Chas Williams and Russ
94 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.