Update kdb5_util man page with missing purge_mkeys command
authorWill Fiveash <will.fiveash@oracle.com>
Mon, 13 Apr 2009 22:15:05 +0000 (22:15 +0000)
committerWill Fiveash <will.fiveash@oracle.com>
Mon, 13 Apr 2009 22:15:05 +0000 (22:15 +0000)
While previously updating the kdb5_util command man page to include
documentation on new subcommands added as a result of the Master Key
Migration project I missed the purge_mkeys command.  I've added that
with this commit.

Ticket: 6459
Version_Reported: 1.7
Target_Version: 1.7
Tags: pullup

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@22208 dc483132-0cff-0310-8789-dd5450dbe970

src/kadmin/dbutil/kdb5_util.M

index 1883ce2824f664651144275b41ad7f1ba305446d..f566781ebd6a8f2948e60850a92d0ef3918ec5b9 100644 (file)
@@ -236,6 +236,18 @@ argument is that specified in the Time Formats section of the kadmin man page.
 \fBlist_mkeys\fP
 List all master keys from most recent to earliest in K/M principal. The output will show the KVNO, enctype and salt for each mkey similar to kadmin getprinc output.  A * following an mkey denotes the currently active master key. 
 .TP
+\fBpurge_mkeys\fP [\fB-f\fP] [\fB-n\fP] [\fB-v\fP]
+Delete master keys from the K/M principal that are not used to protect any principals.  This command can be used to remove old master keys from a K/M principal once all principal keys are protected by a newer master key.
+.TP
+.B \-f
+does not prompt user.
+.TP
+.B \-n
+do a dry run, shows master keys that would be purged, does not actually purge any keys.
+.TP
+.B \-v
+verbose output.
+.TP
 \fBupdate_princ_encryption\fP [\fB\-f\fP] [\fB\-n\fP] [\fB\-v\fP] [\fBprinc\-pattern\fP]
 Update all principal records (or only those matching the
 .B princ\-pattern