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