mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
fc5acc0151
Implement proper synopsis wrapping for HTML generation. This was done in three pieces. First, add HTML-specific tags to the POD to mark the synopsis for HTML purposes so that we can apply style information to it. Second, update the style sheet to indent all lines except for the first in the synopsis section. Third, add the appropriate S<> tags around option and argument pairs so that we don't wrap between the option and its argument. Unfortunately, due to the <I<foo>> style that looks nicer for other reasons, we have to use the very verbose S<<< >>>. Oh well.
104 lines
3.0 KiB
Plaintext
104 lines
3.0 KiB
Plaintext
=head1 NAME
|
|
|
|
kadb_check - Checks the integrity of the Authentication Database
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
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 B<kadb_check> command checks the integrity of the Protection Database,
|
|
reporting any errors or corruption it finds. If there are problems, do not
|
|
issue any B<kas> commands until the database is repaired.
|
|
|
|
=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
|
|
F<kaserver.DB0> file (with a different name) on which to run the command.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-database> <I<kadb file>>
|
|
|
|
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 B<-uheader>
|
|
|
|
Displays information which Ubik maintains in the database's header.
|
|
|
|
=item B<-kheader>
|
|
|
|
Displays information which the Authentication Server maintains in the
|
|
database's header.
|
|
|
|
=item B<-entries>
|
|
|
|
Outputs every entry in the database, providing information similar to that
|
|
returned by the B<kas examine> command.
|
|
|
|
=item B<-verbose>
|
|
|
|
Reports additional information about the database, including the number of
|
|
free (allocated but unused) entries in the database.
|
|
|
|
=item B<-rebuild> <I<out file>>
|
|
|
|
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 B<-help>
|
|
|
|
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 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 C<root>.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<kaserver.DB0(5)>,
|
|
L<bos_shutdown(8)>,
|
|
L<kas_examine(8)>,
|
|
L<kaserver(8)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
|