Dixie,
Let's not put the mutual exclusiveness in the synopsis since there
are more than 2 options. So your approach is good.
In the manpage you sent you need to add the text "The --portbase option
cannot be used with the --adminport , --instanceport *and
--domainproperties *options." in --portbase description. Also please add
*--portbase cannot be used* when using --domainproperties option
--domainproperties description.
thanks
Sankar
Dixie Pine wrote:
> Sankar,
> I can't show this in the Synopsis. That's why I added material to the
> description of each option in the Options list. Please take a look at
> that and see if it's correct.
>
> If you can give me any examples that might be helpful in illustrating
> this, I could add.
>
> Dixie
>
> On 10/21/09 06:38 PM, Sankar Neelakandan wrote:
>> Okay more details are missing.
>>
>> option --portbase is mutually exclusive with other options
>> --adminport --instanceport & --domainproperties, meaning when
>> --portbase is specified all the other options will not be accepted. I
>> don't know how you can state that in the synopsis.
>>
>> If --portbase is omitted --adminport defaults to 4848 --instanceport
>> defaults to 8080 , so it will show up in the command usage as default
>> values.
>>
>> thanks
>> Sankar
>>
>> Dixie Pine wrote:
>>> On 10/20/09 02:18 PM, Sankar Neelakandan wrote:
>>>> Hi Dixie,
>>>> --adminport and --portbase are mutually exclusive options. It
>>>> should be described as
>>>> [--adminport 4848 | --portbase portbase] [--instanceport 8080]
>>> I looked at the command message and I see no attempt to indicate
>>> mutual exclusivity. It gets very complicated, especially when
>>> instanceport is factored in. So I added a sentence in each port
>>> option description to explain the mutual exclusivity.
>>>
>>> *BUG?* 4848 and 8080 should not be in the command message, but they
>>> are. They should be shown as <adminport> and <instanceport>
>>> replaceables. I changed the man page. Can the command message be fixed?
>>>
>>> Dixie
>>>>
>>>> -Sankar
>>>>
>>>> Dixie Pine wrote:
>>>>> I removed --user from Synopsis and list of options, added new
>>>>> paragraph in description, added
>>>>> description for --nopassword. Please review.
>>>>>
>>>>> dixie
>>>>>
>>>>> On 10/20/09 10:42 AM, Bill Shannon wrote:
>>>>>> Dixie Pine wrote on 10/20/09 10:27:
>>>>>>> On 10/19/09 18:16, Bill Shannon wrote:
>>>>>>>> --user really is just an asadmin option, except with create-domain
>>>>>>>> we make it a *required* option. There was no other good way to
>>>>>>>> specify
>>>>>>>> that requirement in the command usage so I added it as a
>>>>>>>> subcommand
>>>>>>>> option that is required.
>>>>>>>>
>>>>>>> okay. What description do you want for the option? The asadmin
>>>>>>> option version says this:
>>>>>>>
>>>>>>> --user The user name of the authorized administsrative user
>>>>>>> of the DAS.
>>>>>>
>>>>>> Well, since adding the --nopassword option, it's no longer true that
>>>>>> --user is required, so I'll update the command usage to remove
>>>>>> --user.
>>>>>> It will just be an asadmin utility option, but the man page will
>>>>>> need
>>>>>> to describe how it's used.
>>>>>>
>>>>>> This is another one of those "you have to specify option A or
>>>>>> option B"
>>>>>> cases. If you specify --nopassword, --user is optional.
>>>>>>
>>>>>> --user specifies the user name of the administrative user that
>>>>>> will be
>>>>>> created for the new domain. If not specified, and --nopassword
>>>>>> is specified,
>>>>>> the default user name "admin" is used.
>>>>>>
>>>>>> Try this:
>>>>>>
>>>>>> The create-domain command creates a domain with a single
>>>>>> administrative
>>>>>> user specified by the --user asadmin utility option. If the
>>>>>> --nopassword
>>>>>> option is specified and the --user option is not specified, the
>>>>>> default
>>>>>> admin user "admin" is used. If the --nopassword is not
>>>>>> specified, a user
>>>>>> name is required and will be prompted for (if interactive) if
>>>>>> not specified
>>>>>> using the --user option.
>>>>>>
>>>>>>
>>>>> ------------------------------------------------------------------------
>>>>>
>>>>> ---------------------------------------------------------------------
>>>>> To unsubscribe, e-mail: admin-unsubscribe_at_glassfish.dev.java.net
>>>>> For additional commands, e-mail: admin-help_at_glassfish.dev.java.net
>>> ------------------------------------------------------------------------
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: admin-unsubscribe_at_glassfish.dev.java.net
>>> For additional commands, e-mail: admin-help_at_glassfish.dev.java.net