From: Ben Kaduk <kaduk@mit.edu>
Date: Tue, 9 Oct 2012 20:00:53 +0000 (-0400)
Subject: Improve the ktadd and ktremove synopses
X-Git-Tag: krb5-1.11-alpha1~99
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a9126e9f642b139a489e307c7b36d884d3904c17;p=thirdparty%2Fkrb5.git

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.
---

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 301d285466..396e25524f 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.