doc: fix some broken link specifications
[openafs.git] / doc / man-pages / pod8 / prdb_check.pod
1 =head1 NAME
2
3 prdb_check - Checks the integrity of the Protection Database
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<prdb_check> S<<< B<-database> <I<ptdb file>> >>> [B<-uheader>] [B<-pheader>]
11     [B<-entries>] [B<-verbose>] [B<-help>]
12
13 B<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
20 The B<prdb_check> command checks the integrity of the Protection Database,
21 reporting any errors or corruption it finds. If there are problems, do not
22 issue any B<pts> commands until the database is repaired.
23
24 =head1 CAUTIONS
25
26 The results can be unpredictable if the Protection Server makes changes to
27 the Protection Database while this command is running. Use the B<bos
28 shutdown> command to shutdown the local B<ptserver> process before running
29 this 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
38 Names the Protection Database (copy of the F<prdb.DB0> file) to check. If
39 the current working directory is not the location of the file, provide a
40 pathname, either full or relative to the current working directory.
41
42 =item B<-uheader>
43
44 Displays information which Ubik maintains in the database's header.
45
46 =item B<-pheader>
47
48 Displays information which the Protection Server maintains in the
49 database's header.
50
51 =item B<-entries>
52
53 Outputs every entry in the database. Some of the information is similar to
54 that returned by the B<pts examine> command.
55
56 =item B<-verbose>
57
58 Reports additional information about the database, including the number of
59 entries in the database and a trace of the internal database structures
60 the command is verifying.
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 Protection Database.
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<prdb.DB0(5)>,
85 L<bos_shutdown(8)>,
86 L<pts_examine(1)>,
87 L<ptserver(8)>
88
89 =head1 COPYRIGHT
90
91 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
92
93 This documentation is covered by the IBM Public License Version 1.0.  It was
94 converted from HTML to POD by software written by Chas Williams and Russ
95 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.