]> git.ipfire.org Git - thirdparty/krb5.git/commitdiff
Improve the ktadd and ktremove synopses
authorBen Kaduk <kaduk@mit.edu>
Tue, 9 Oct 2012 20:00:53 +0000 (16:00 -0400)
committerBen Kaduk <kaduk@mit.edu>
Thu, 11 Oct 2012 15:29:14 +0000 (11:29 -0400)
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.

doc/rst_source/krb_admins/admin_commands/kadmin_local.rst

index 301d28546654daa71c052cb2fb7a9939916b433d..396e25524f600ce90eee55ef9fe7d0b80be4e384 100644 (file)
@@ -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.