man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod8 / kadb_check.pod
1 =head1 NAME
2
3 kadb_check - Checks the integrity of the Authentication Database
4
5 =head1 SYNOPSIS
6
7 B<kadb_check -database> <I<kadb_file>>  [B<-uheader>]  [B<-kheader>]  [-entries]  
8 [B<-verbose>]  [B<-rebuild> <I<out_file>>]  [B<-help>]
9
10 B<kadb_check -d> <I<kadb_file>>  [B<-u>]  [B<-k>]  [B<-e>]  [B<-v>]  [B<-r> <I<out_file>>]  [-h]
11
12 =head1 DESCRIPTION
13
14 The kadb_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<kas> commands until the database is
17 repaired.
18
19 =head1 CAUTIONS
20
21 The results can be unpredictable if the Authentication Server makes changes
22 to the Authentication Database while this command is running. Use the
23 B<bos shutdown> command to shutdown the local B<kaserver>
24 process before running this command, or before creating a second copy of the
25 B<kaserver.DB0> file (with a different name) on which to run
26 the command.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item -database
33
34 Names the Authentication Database (copy of the
35 B<kaserver.DB0> file) to check. If the current working
36 directory is not the location of the file, provide a pathname, either full or
37 relative to the current working directory.
38
39 =item -uheader
40
41 Displays information which Ubik maintains in the database's
42 header.
43
44 =item -kheader
45
46 Displays information which the Authentication Server maintains in the
47 database's header.
48
49 =item -entries
50
51 Outputs every entry in the database, providing information similar to that
52 returned by the B<kas examine> command.
53
54 =item -verbose
55
56 Reports additional information about the database, including the number of
57 free (allocated but unused) entries in the database.
58
59 =item -rebuild
60
61 Names the file in which to record a list of kas commands which,
62 if issued in the command shell, recreate the current state of the database
63 being verified. Partial pathnames are interpreted relative to the
64 current working directory.
65
66 =item -help
67
68 Prints the online help for this command. All other valid options
69 are ignored.
70
71 =back
72
73 =head1 OUTPUT
74
75 If there are errors in the database, the output always reports them on the
76 standard error stream. If any options other than B<-database>
77 or B<-help> are provided, the output written to the standard output
78 stream includes additional information as described for each option in the
79 preceding B<Options> section of this reference page. The output
80 is intended for debugging purposes and is meaningful to someone familiar with
81 the internal structure of the Authentication Database.
82
83 =head1 PRIVILEGE REQUIRED
84
85 The issuer must be logged in as the local superuser root.
86
87 =head1 SEE ALSO
88
89 L<kaserver.DB0 and kaserver.DBSYS1(1)>
90
91 L<bos_shutdown(1)>,
92 L<kas_examine(1)>,
93 L<kaserver(1)>
94
95 =head1 COPYRIGHT
96
97 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
98
99 This documentation is covered by the IBM Public License Version 1.0.  It was
100 converted from HTML to POD by software written by Chas Williams and Russ
101 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.