57 messages in net.java.dev.glassfish.adminRe: Content of Usage statements for a...| From | Sent On | Attachments |
|---|---|---|
| Dixie Pine | Oct 6, 2009 4:58 pm |  .pdf, .pdf, .pdf |
| Kedar Mhaswade | Oct 14, 2009 5:14 pm | |
| Bill Shannon | Oct 14, 2009 8:30 pm | |
| Dixie Pine | Oct 16, 2009 5:37 pm | .pdf, .pdf, .pdf |
| Bill Shannon | Oct 19, 2009 6:16 pm | |
| Dixie Pine | Oct 20, 2009 10:27 am | |
| Bill Shannon | Oct 20, 2009 10:42 am | |
| Dixie Pine | Oct 20, 2009 2:06 pm | .pdf |
| Sankar Neelakandan | Oct 20, 2009 2:18 pm | |
| Bill Shannon | Oct 20, 2009 2:26 pm | |
| kedar | Oct 20, 2009 2:52 pm | |
| Dixie Pine | Oct 21, 2009 3:52 pm | .pdf |
| Dixie Pine | Oct 21, 2009 3:54 pm | .pdf |
| Sankar Neelakandan | Oct 21, 2009 6:38 pm | |
| Paul Davies | Oct 21, 2009 6:58 pm | |
| Bill Shannon | Oct 21, 2009 7:33 pm | |
| Nandini Ektare | Oct 21, 2009 9:13 pm | |
| Dixie Pine | Oct 22, 2009 12:00 pm | .pdf |
| Dixie Pine | Oct 22, 2009 12:01 pm | |
| Dixie Pine | Oct 22, 2009 12:38 pm | |
| Sankar Neelakandan | Oct 22, 2009 12:48 pm | |
| Nandini Ektare | Oct 22, 2009 12:53 pm | |
| Dixie Pine | Oct 22, 2009 2:31 pm | |
| Nandini Ektare | Oct 22, 2009 2:50 pm | |
| Bill Shannon | Oct 22, 2009 2:51 pm | |
| Dixie Pine | Oct 22, 2009 3:53 pm | |
| Dixie Pine | Oct 22, 2009 3:57 pm | |
| Bill Shannon | Oct 22, 2009 8:53 pm | |
| Bill Shannon | Oct 22, 2009 9:00 pm | |
| Nandini Ektare | Oct 22, 2009 9:48 pm | |
| Lloyd Chambers | Oct 23, 2009 10:07 am | |
| Lloyd Chambers | Oct 23, 2009 10:11 am | |
| Paul Davies | Oct 23, 2009 1:14 pm | |
| Nandini Ektare | Oct 23, 2009 1:18 pm | |
| Lloyd Chambers | Oct 23, 2009 3:13 pm | |
| Dixie Pine | Oct 28, 2009 5:49 pm | .pdf |
| Sankar Neelakandan | Oct 28, 2009 5:53 pm | |
| Bill Shannon | Oct 29, 2009 10:07 pm | |
| Dixie Pine | Oct 30, 2009 8:37 am | |
| Nandini Ektare | Oct 30, 2009 8:46 am | |
| Sankar Neelakandan | Oct 30, 2009 9:39 am | |
| Bill Shannon | Oct 30, 2009 11:28 am | |
| Lloyd Chambers | Oct 30, 2009 11:42 am | |
| Bill Shannon | Oct 30, 2009 1:07 pm | |
| Dixie Pine | Oct 30, 2009 1:32 pm | |
| Sankar Neelakandan | Oct 30, 2009 2:01 pm | |
| Bill Shannon | Oct 30, 2009 2:21 pm | |
| Bill Shannon | Oct 30, 2009 2:35 pm | |
| Nandini Ektare | Oct 30, 2009 2:54 pm | |
| Sankar Neelakandan | Oct 30, 2009 3:01 pm | |
| Dixie Pine | Oct 30, 2009 4:15 pm | |
| Bill Shannon | Nov 2, 2009 5:01 pm | |
| Bill Shannon | Nov 2, 2009 5:03 pm | |
| Sankar Neelakandan | Nov 2, 2009 5:30 pm | |
| June...@Sun.COM | Nov 3, 2009 10:15 am | |
| Paul Davies | Nov 3, 2009 12:33 pm | |
| Bill Shannon | Nov 3, 2009 12:51 pm |
| Subject: | Re: Content of Usage statements for asadmin man pages | |
|---|---|---|
| From: | Dixie Pine (Dixi...@Sun.COM) | |
| Date: | Oct 30, 2009 1:32:18 pm | |
| List: | net.java.dev.glassfish.admin | |
On 10/29/09 10:07 PM, 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.
I think this is very helpful if user has to figure out a subcommand with lots of options. They are very hard to read all run together.
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]]
Now that I'm trying to actually use this style, I'm having trouble with the booleans, prefer this to what's in the long example. It's confusing to have --nopassword inside the < > because it's what I actually type, not a replaceable. Maybe this:
[--nopassword=(default:false)]
Would it be at all likely that a user wouldn't think the other possibility is true?
I don't expect the man pages to include the defaults in the Synopsis.
In man page Synopsis, it looks like this with curly braces around {false|true}:
[--nopassword={false)|true}]
We list the default first. We also state the default in the descriptions of the options.