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