I'm not wedded to the colon, but I think it's sufficiently clear and
concise. I also considered equals and space. I think " is " is
unnecessarily verbose.
And in any event, the entire phrase is now in LocalStrings.properties,
so it's trivial to change it if we want. :-)
Sankar Neelakandan wrote on 10/30/09 09:39:
> I don't know my thinking is correct, but do we really need to put a ":"
> after the string "default" ?. Since we use : as a separator in other
> many of the commands I don't know this might become a issue. If we have
> this level of verbose why don't we say something like
>
> <adminport(default is 4848)>
>
> If everybody thinks that ":" is okay, then I am fine with it too :-)
>
> thanks
> Sankar
>
> Bill Shannon wrote:
>> Following up on this discussion we had last week...
>>
>> Here's what I've done:
>>
>> Usage: asadmin [asadmin-utility-options] create-domain
>> [--adminport <adminport(default:4848)>]
>> [--instanceport <instanceport(default:8080)>] [--portbase <portbase>]
>> [--profile <profile>] [--template <template>] [--domaindir
>> <domaindir>]
>> [--savemasterpassword[=<savemasterpassword(default:false)>]]
>> [--domainproperties <domainproperties>]
>> [--keytooloptions <keytooloptions>]
>> [--savelogin[=<savelogin(default:false)>]]
>> [--checkports[=<checkports(default:true)>]]
>> [--nopassword[=<nopassword(default:false)>]]
>> [-?|--help[=<help(default:false)>]] domain_name
>>
>>
>> Notice that I also fixed it to insert line breaks at reasonable points.
>>
>> It's a bit on the verbose side, but is it usable?
>>
>> I considered the alternative of listing the default boolean value first,
>> but since that was inconsistent with the other defaults it seemed
>> like it would be confusing. For example:
>>
>> [--nopassword[=false|true]]
>>
>> I don't expect the man pages to include the defaults in the Synopsis.
>>
>> Comments?
>>
>> ---------------------------------------------------------------------
>> 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
>