=head1 SYNOPSIS
-B<kadb_check -database> <I<kadb_file>> [B<-uheader>] [B<-kheader>] [-entries]
-[B<-verbose>] [B<-rebuild> <I<out_file>>] [B<-help>]
+=for html
+<div class="synopsis">
-B<kadb_check -d> <I<kadb_file>> [B<-u>] [B<-k>] [B<-e>] [B<-v>] [B<-r> <I<out_file>>] [-h]
+B<kadb_check> S<<< B<-database> <I<kadb file>> >>> [B<-uheader>] [B<-kheader>]
+ [B<-entries>] [B<-verbose>] S<<< [B<-rebuild> <I<out file>>] >>> [B<-help>]
+
+B<kadb_check> S<<< B<-d> <I<kadb file>> >>> [B<-u>] [B<-k>] [B<-e>] [B<-v>]
+ S<<< [B<-r> <I<out file>>] >>> [B<-h>]
+
+=for html
+</div>
=head1 DESCRIPTION
-The kadb_check command checks the integrity of the Protection
+The B<kadb_check> command checks the integrity of the Authentication
Database, reporting any errors or corruption it finds. If there are
-problems, do not issue any B<kas> commands until the database is
-repaired.
+problems, do not issue any B<kas> commands until the database is repaired.
-=head1 CAVEATS
+=head1 CAUTIONS
-The results can be unpredictable if the Authentication Server makes changes
-to the Authentication Database while this command is running. Use the
-B<bos shutdown> command to shutdown the local B<kaserver>
-process before running this command, or before creating a second copy of the
-B<kaserver.DB0> file (with a different name) on which to run
-the command.
+The B<kadb_check> command is only used with the database used by the
+obsolete Authentication Server, which should no longer be used. It is
+provided for sites that have not yet migrated to a Kerberos version 5
+KDC. The Authentication Server and supporting commands, including B<kdb>,
+will be removed in a future version of OpenAFS.
+
+The results can be unpredictable if the Authentication Server makes
+changes to the Authentication Database while this command is running. Use
+the B<bos shutdown> command to shutdown the local B<kaserver> process
+before running this command, or before creating a second copy of the
+F<kaserver.DB0> file (with a different name) on which to run the command.
=head1 OPTIONS
=over 4
-=item -database
+=item B<-database> <I<kadb file>>
-Names the Authentication Database (copy of the
-B<kaserver.DB0> file) to check. If the current working
-directory is not the location of the file, provide a pathname, either full or
-relative to the current working directory.
+Names the Authentication Database (copy of the F<kaserver.DB0> file) to
+check. If the current working directory is not the location of the file,
+provide a pathname, either full or relative to the current working
+directory.
-=item -uheader
+=item B<-uheader>
-Displays information which Ubik maintains in the database's
-header.
+Displays information which Ubik maintains in the database's header.
-=item -kheader
+=item B<-kheader>
Displays information which the Authentication Server maintains in the
database's header.
-=item -entries
+=item B<-entries>
Outputs every entry in the database, providing information similar to that
returned by the B<kas examine> command.
-=item -verbose
+=item B<-verbose>
Reports additional information about the database, including the number of
free (allocated but unused) entries in the database.
-=item -rebuild
+=item B<-rebuild> <I<out file>>
-Names the file in which to record a list of kas commands which,
-if issued in the command shell, recreate the current state of the database
-being verified. Partial pathnames are interpreted relative to the
-current working directory.
+Names the file in which to record a list of B<kas> commands which, if
+issued in the command shell, recreate the current state of the database
+being verified. Partial pathnames are interpreted relative to the current
+working directory.
-=item -help
+=item B<-help>
-Prints the online help for this command. All other valid options
-are ignored.
+Prints the online help for this command. All other valid options are
+ignored.
=back
=head1 OUTPUT
If there are errors in the database, the output always reports them on the
-standard error stream. If any options other than B<-database>
-or B<-help> are provided, the output written to the standard output
-stream includes additional information as described for each option in the
-preceding B<Options> section of this reference page. The output
-is intended for debugging purposes and is meaningful to someone familiar with
-the internal structure of the Authentication Database.
+standard error stream. If any options other than B<-database> or B<-help>
+are provided, the output written to the standard output stream includes
+additional information as described for each option in L</OPTIONS>. The
+output is intended for debugging purposes and is meaningful to someone
+familiar with the internal structure of the Authentication Database.
=head1 PRIVILEGE REQUIRED
-The issuer must be logged in as the local superuser root.
+The issuer must be logged in as the local superuser C<root>.
=head1 SEE ALSO
-L<kaserver.DB0 and kaserver.DBSYS1(1)>
-
-L<bos_shutdown(1)>,
-L<kas_examine(1)>,
-L<kaserver(1)>
+L<kaserver.DB0(5)>,
+L<bos_shutdown(8)>,
+L<kas_examine(8)>,
+L<kaserver(8)>
=head1 COPYRIGHT
git://git.openafs.org / openafs.git / blobdiff