doc: kdb manpage fixes

[openafs.git] / doc / man-pages / pod8 / kdb.pod

diff --git a/doc/man-pages/pod8/kdb.pod b/doc/man-pages/pod8/kdb.pod
index 2ce846a..e1c00fb 100644 (file)
--- a/doc/man-pages/pod8/kdb.pod
+++ b/doc/man-pages/pod8/kdb.pod
@@ -8,7 +8,8 @@ kdb - Displays log or privileged actions performed by the Authentication Server
 <div class="synopsis">
 
 B<kdb> S<<< [B<-dbmfile> <I<dbmfile to use (default /usr/afs/logs/AuthLog)>>] >>>
-    S<<< [B<-key> <I<extract entries that match specified key>>] >>> [B<-help>]
+    S<<< [B<-key> <I<extract entries that match specified key>>] >>>
+    [B<-long>] [B<-numeric>] [B<-help>]
 
 =for html
 </div>
@@ -20,14 +21,20 @@ F<AuthLog.pag> files associated with the F<AuthLog> file that resides on
 the local disk, by default in the F</usr/afs/logs> directory. The files
 must exist in that directory, which normally implies that the
 Authentication Server is running on the machine. The files contain
-information on privileged actions performed by the Authentication Server.
+information on privileged actions performed by the obsolete Authentication
+Server.
 
 =head1 CAUTIONS
 
+The B<kdb> command is only used to read the log files from 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.
+
 It is possible that on some operating systems that AFS otherwise supports,
 the Authentication Server cannot create the F</usr/afs/logs/AuthLog.dir>
-and F</usr/afs/logs/AuthLog.pag> files, making this command
-inoperative. See the I<IBM AFS Release Notes> for details.
+and F</usr/afs/logs/AuthLog.pag> files, making this command inoperative.
 
 =head1 OPTIONS
 
@@ -45,6 +52,15 @@ F<AuthLog.dir> and F<AuthLog.pag> files in the F</usr/afs/logs> directory.
 
 Specifies each entry to be displayed from the indicated file.
 
+=item B<-long>
+
+When printing all entries, print out detailed information for each entry.
+
+=item B<-numeric>
+
+Do not resolve IP addresses to hostnames, and instead print out numeric IP
+addresses.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
@@ -113,12 +129,12 @@ The final line of output sums the number of entries.
 
 =head1 EXAMPLES
 
-The following example shows the output of the B<kdb> command in the ABC
-Corporation cell (C<abc.com>):
+The following example shows the output of the B<kdb> command in the Example
+Corporation cell (C<example.com>):
 
    % kdb
    Printing all entries found in /usr/afs/logs/AuthLog
-   admin,krbtgt.ABC.COM:auth
+   admin,krbtgt.EXAMPLE.COM:auth
    admin,afs:gtck
    admin:cruser
    admin:delu