Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / prdb_check.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3prdb_check - Checks the integrity of the Protection Database
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<prdb_check> S<<< B<-database> <I<ptdb file>> >>> [B<-uheader>] [B<-pheader>]
11 [B<-entries>] [B<-verbose>] [B<-help>]
12
13B<prdb_check> S<<< B<-d> <I<ptdb file>> >>> [B<-u>] [B<-p>] [B<-e>] [B<-v>] [B<-h>]
14
15=for html
16</div>
17
18=head1 DESCRIPTION
19
20The B<prdb_check> command checks the integrity of the Protection Database,
21reporting any errors or corruption it finds. If there are problems, do not
22issue any B<pts> commands until the database is repaired.
23
24=head1 CAUTIONS
25
26The results can be unpredictable if the Protection Server makes changes to
27the Protection Database while this command is running. Use the B<bos
28shutdown> command to shutdown the local B<ptserver> process before running
29this command, or before creating a second copy of the F<prdb.DB0> file
30(with a different name) on which to run the command.
31
32=head1 OPTIONS
33
34=over 4
35
36=item B<-database> <I<ptdb file>>
37
38Names the Protection Database (copy of the F<prdb.DB0> file) to check. If
39the current working directory is not the location of the file, provide a
40pathname, either full or relative to the current working directory.
41
42=item B<-uheader>
43
44Displays information which Ubik maintains in the database's header.
45
46=item B<-pheader>
47
48Displays information which the Protection Server maintains in the
49database's header.
50
51=item B<-entries>
52
53Outputs every entry in the database. Some of the information is similar to
54that returned by the B<pts examine> command.
55
56=item B<-verbose>
57
58Reports additional information about the database, including the number of
59entries in the database and a trace of the internal database structures
60the command is verifying.
61
62=item B<-help>
63
64Prints the online help for this command. All other valid options are
65ignored.
66
67=back
68
69=head1 OUTPUT
70
71If there are errors in the database, the output always reports them on the
72standard error stream. If any options other than B<-database> or B<-help>
73are provided, the output written to the standard output stream includes
74additional information as described for each option in L</OPTIONS>. The
75output is intended for debugging purposes and is meaningful to someone
76familiar with the internal structure of the Protection Database.
77
78=head1 PRIVILEGE REQUIRED
79
80The issuer must be logged in as the local superuser C<root>.
81
82=head1 SEE ALSO
83
84L<prdb.DB0(5)>,
85L<bos_shutdown(8)>,
86L<pts_examine(1)>,
87L<ptserver(8)>
88
89=head1 COPYRIGHT
90
91IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
92
93This documentation is covered by the IBM Public License Version 1.0. It was
94converted from HTML to POD by software written by Chas Williams and Russ
95Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.