admin@glassfish.java.net

Re: Content of Usage statements for asadmin man pages

From: Lloyd Chambers <Lloyd.Chambers_at_Sun.COM>
Date: Fri, 23 Oct 2009 10:11:45 -0700

To clarify my earlier comment—

"If the user needs more info on any particular option, man page should
provide all the details needed"

In my experience the issue is rarely understanding a particular
option, the major stumbling block is lack of a basic and advanced
*example* invocation.

Lloyd

On Oct 23, 2009, at 10:08 AM, Lloyd Chambers wrote:

>> [Thinking aloud] It sure does give more info. But if there were
>> bugs, as docs team stated, because someone used 4848 as is, this
>> kind of nomenclature as well as the one above seems to have a high
>> bugs potential. Plus some of the commands with many options are
>> already pretty lengthy. Such verbose usage will reduce the usage
>> reference appeal further. To me, usage has to be short as it is a
>> means of quick reference. If the user needs more info on any
>> particular option, man page should provide all the details needed.
>> But then again any existing standards and practices on this may
>> have better reasons to support such detailed usage text.
>

Lloyd Chambers
lloyd.chambers_at_sun.com
GlassFish Team