[krbdev.mit.edu #8403] kinit documentation page

Tom Yu via RT rt-comment at krbdev.mit.edu
Tue May 3 17:56:28 EDT 2016


I would consider the _principal_ argument of kinit to be an operand or a
non-option argument that can be omitted.  It therefore belongs in the
"description" section.  A brief check of a few Mac OS X and GNU manual
pages shows that arguments that can be omitted are typically documented
under "description" instead of "options".

The "option" terminology is typically meant for options that begin
with a '-' character and modify the behavior of the utility.  See

http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap01.html#tag_17_04

for example.

I think the kpasswd documentation is somewhat nonstandard for putting
the argument under "Options".  Perhaps we could add more text to the
"description" section to make it more prominent.



More information about the krb5-bugs mailing list