krb5 commit: Improve the ktadd and ktremove synopses

Benjamin Kaduk kaduk at MIT.EDU
Thu Oct 11 12:03:49 EDT 2012


https://github.com/krb5/krb5/commit/a9126e9f642b139a489e307c7b36d884d3904c17
commit a9126e9f642b139a489e307c7b36d884d3904c17
Author: Ben Kaduk <kaduk at mit.edu>
Date:   Tue Oct 9 16:00:53 2012 -0400

    Improve the ktadd and ktremove synopses
    
    Mention the options on the synopsis line, and do not imply that
    the principal argument(s) for ktadd are optional.
    reST line blocks are needed to keep the two forms of ktadd on
    separate lines.

 .../krb_admins/admin_commands/kadmin_local.rst     |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst b/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
index 301d285..396e255 100644
--- a/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
+++ b/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
@@ -763,7 +763,8 @@ Examples:
 ktadd
 ~~~~~
 
-    **ktadd** [[*principal*\|\ **-glob** *princ-exp*]
+    | **ktadd** [options] *principal*
+    | **ktadd** [options] **-glob** *princ-exp*
 
 Adds a *principal*, or all principals matching *princ-exp*, to a
 keytab file.  Each principal's keys are randomized in the process.
@@ -771,7 +772,7 @@ The rules for *princ-exp* are described in the **list_principals**
 command.
 
 This command requires the **inquire** and **changepw** privileges.
-With the **-glob** option, it also requires the **list** privilege.
+With the **-glob** form, it also requires the **list** privilege.
 
 The options are:
 
@@ -812,7 +813,7 @@ Example:
 ktremove
 ~~~~~~~~
 
-    **ktremove** *principal* [*kvno*\|\ *all*\| *old*]
+    **ktremove** [options] *principal* [*kvno* | *all* | *old*]
 
 Removes entries for the specified *principal* from a keytab.  Requires
 no permissions, since this does not require database access.


More information about the cvs-krb5 mailing list