admin@glassfish.java.net

Re: Content of Usage statements for asadmin man pages

From: Bill Shannon <bill.shannon_at_sun.com>
Date: Thu, 29 Oct 2009 22:07:56 -0700

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?