this is great, totally clear, saves user time looking up a default but
there's no room for confusion.
Most usage statements won't need any work because they don't include a
literal default. But for the ones that do, as create-domain used to with
<adminport 4848>, it would be great if the usage statement could be
changed as Bill suggests.
dixie
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
>
>