Hi Lioyd,
The separation of asadmin utility options from subcommand options in the
asadmin utility is explained in detail in the following documentation,
which is currently under review:
* The asadmin(1M) man page in the Reference Manual
<
http://wiki.glassfish.java.net/Wiki.jsp?page=ReferenceManual>.
* /Using the /asadmin /Utility/ on pages 49-56 of the July 24 draft
of the Administration Guide
<
http://wiki.glassfish.java.net/Wiki.jsp?page=AdministrationGuide>.
The asadmin output that contains the alternative terms is produced when
the --echo option is specified, for example (I have emphasized the terms
in question):
$ asadmin --echo version
*asadmin program options*: --host localhost --port 4848 --terse false
--interactive true --secure false --echo false
*command*: version --verbose false
In the asadmin output, the term "command" is used to mean what the ARCs
would call a "subcommand".
Regards,
-Paul
On 08/11/09 09:53, Lloyd Chambers wrote:
> Paul,
>
> Some examples of both would help me understand the actual usage.
>
> Lloyd
>
> On Aug 11, 2009, at 9:47 AM, Paul Davies wrote:
>
>> Hi Lloyd,
>>
>> The term "utility" provides greater differentiation from "subcommand"
>> than "command", and is used in the sense of utility program
>> <http://www.answers.com/topic/utility-program> as defined at answers.com.
>>
>> The separation of asadmin options from subcommand options required us
>> to coin two new terms ("asadmin utility option" and "subcommand
>> option") to denote these two types of options. It seemed to me that
>> the best way to avoid confusing users was to choose terms that were
>> distinctly different and to use those terms consistently in the
>> documentation. The new terminology was invented to make a distinction
>> that was not necessary before.
>>
>> Regards,
>> -Paul
>>
>> On 08/11/09 08:51, Lloyd Chambers wrote:
>>> I'm not grokking "utility".
>>>
>>> Subcommand is what we've always used at ARC. I don't think we
>>> should invent new terminology:
>>>
>>> command subcommand options operands
>>>
>>> Lloyd
>>>
>>> On Aug 11, 2009, at 8:44 AM, Paul Davies wrote:
>>>
>>>> Hi,
>>>>
>>>> In the discussion about --echo, I see examples of asadmin output
>>>> that is inconsistent with the terminology in the documentation:
>>>> *asadmin Output*
>>>> *Documentation*
>>>> asadmin program option
>>>> asadmin utility option
>>>> command
>>>> subcommand
>>>>
>>>>
>>>> Of course, the documentation and the software must be consistent,
>>>> and I am willing to change the terms in the documentation if
>>>> necessary. However, before I do, I would like to sugest that team
>>>> consider using the terms "asadmin utility option" and "subcommand"
>>>> in the asadmin output. I chose "utility" because, from a user's
>>>> point of view, the utility aspect of asadmin is more important than
>>>> the fact that it is a program. I chose "subcommand" to emphasise
>>>> the fact that these items cannot be run in the operating system's
>>>> command shell, but must be preceded by asadmin or run in an asadmin
>>>> multimode session.
>>>>
>>>> Regards,
>>>> --
>>>> Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
>>>> http://blogs.sun.com/techscribe/
>>>
>>> Lloyd Chambers
>>> lloyd.chambers_at_sun.com <mailto:lloyd.chambers_at_sun.com>
>>> GlassFish Team
>>>
>>>
>>>
>>
>> --
>> Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
>> http://blogs.sun.com/techscribe/
>
> Lloyd Chambers
> lloyd.chambers_at_sun.com <mailto:lloyd.chambers_at_sun.com>
> GlassFish Team
>
>
>
--
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/