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