admin@glassfish.java.net

Re: Content of Usage statements for asadmin man pages

From: Bill Shannon <bill.shannon_at_sun.com>
Date: Fri, 30 Oct 2009 14:36:15 -0700

Sankar Neelakandan wrote on 10/30/09 14:02:
> Here is the review comments.
>
>
> Do we follow the **(default:false) **only for the help option not for the
> others ?.** **

No, intended to do it for all options that have a defined default value.
For --target, I guess I was reading the string "Default server" as
descriptive rather than naming the default at the literal value "server".
But you're right, I should fix that. It should be

   [--target <target(default:server)>]

> < create.system.properties.usagetext=create-system-properties [--target
> target(Default server)] [-?|--help=false] (name=value)[:name=value]* ---
>
>>> create.system.properties.usagetext=create-system-properties\n\t[--target
>>> *<target(Default server)>]
>>> [-?|--help[=<help(default:false)*>]]\n\t(name=value)[:name=value]*
>>
>
> 4c4 < create.jvm.options.usagetext=create-jvm-options [--target
> target(Default server)] [-?|--help=false]
> (jvm_option_name[=jvm_option_value])[:jvm_option_name=jvm_option_name*] ---
>
>>> create.jvm.options.usagetext=create-jvm-options\n\t[--target
>>> *<target(Default server)>*]
>>> [-?|--help[=<help(default:false)>]]\n\t(jvm_option_name[=jvm_option_value])[:jvm_option_name=jvm_option_name*]
>>>
>>
> 7c7 < delete.jvm.options.usagetext=delete-jvm-options [--target
> target(Default server)][-?|--help=false]
> (jvm_option_name[=jvm_option_value])[:jvm_option_name[=jvm_option_name]]* ---
>
>
>>> delete.jvm.options.usagetext=delete-jvm-options\n\t[--target
>>> *<target(Default server)>*]
>>> [-?|--help[=<help(default:false)>]]\n\t(jvm_option_name[=jvm_option_value])[:jvm_option_name[=jvm_option_name]]*
>>>
>>
>
>
> some of the default *true *values are changed to false

That's because I don't think the defaults for --createtables and
--dropandcreatetables actually *are* true. It certainly doesn't
make sense for both of them to be true. I think the syntax was meant
to show how you would specify them to override the default.

But correct me if I'm wrong...

> < deploy.command.usagetext=deploy [--virtualservers virtual_servers]
> [--contextroot context_root] [--force=false] [--precompilejsp=false]
> [--verify=false] [--name component_name] [--upload=false] [--retrieve
> local_dirpath] [--dbvendorname dbvendorname] *[--createtables=true |
> --dropandcreatetables=true]* [--uniquetablenames=true] [--deploymentplan
> deployment_plan] [--enabled=true] [--generatermistubs=false] [--libraries
> jar_file[,jar_file*]] [--type pkg-type]
> [--properties(name=value)[:name=value]*] [-?|--help=false] file_archive |
> filepath ---
>
>>> deploy.command.usagetext=deploy\n\t[--virtualservers <virtual_servers>]
>>> [--contextroot
>>> <context_root>]\n\t[--force[=<force(default:false)>]]\n\t[--precompilejsp[=<precompilejsp(default:false)>]]\n\t[--verify[=<verify(default:false)>]]
>>> [--name <component_name>]\n\t[--upload[=<upload(default:false)>]]
>>> [--retrieve <local_dirpath>]\n\t[--dbvendorname
>>> <dbvendorname>]\n\t*[--createtables[=createtables(default:false)>]
>>> |\n\t--dropandcreatetables[=<dropandcreatetables(default:false)>]]\n\t[--uniquetablenames[=<uniquetablenames(default:false)>]]*\n\t[--deploymentplan
>>> <deployment_plan>]
>>> [--enabled[=<enabled(default:true)>]]\n\t[--generatermistubs[=<generatermistubs(default:false)>]]\n\t[--libraries
>>> jar_file[,jar_file*]] [--type <pkg-type>]\n\t[--properties
>>> (name=value)[:name=value]*]\n\t[-?|--help[=<help(defalt:false)>]]
>>> file_archive | filepath
>>
> 42c42
>
> < undeploy.command.usagetext=undeploy [--target=target]
> [--keepreposdir=false] [--droptables=true] [--cascade=false]
> [--properties(name=value)[:name=value]*] [-?|--help=false] name ---
>
>>> undeploy.command.usagetext=undeploy\n\t[--target <target>]
>>> [--keepreposdir[=<keepreposdir(default:false)>]]\n\t[--droptables*[=<droptables(default:false)>]*]\n\t[--cascade[=<cascade(default:false)>]]\n\t[--properties
>>> (name=value)[:name=value]*]\n\t[-?|--help[=<help(default:false)>]] name
>>
> 50c50 < deploydir.command.usagetext=deploydir [--virtualservers
> virtual_servers] [--contextroot context_root] [--force=false]
> [--precompilejsp=false] [--verify=false] [--name component_name]
> [--upload=false] [--retrieve local_dirpath] [--dbvendorname dbvendorname]
> [--createtables=true | --dropandcreatetables=true] [--uniquetablenames=true]
> [--deploymentplan deployment_plan] [--enabled=true]
> [--generatermistubs=false] [--libraries jar_file[,jar_file*]] [--type
> pkg-type] [--properties(name=value)[:name=value]*] [-?|--help=false] dirpath
> ---
>
>>> deploydir.command.usagetext=deploydir\n\t[--virtualservers
>>> <virtual_servers>] [--contextroot
>>> <context_root>]\n\t[--force[=<force(default:false)>]]\n\t[--precompilejsp[=<precompilejsp(default:false)>]]\n\t[--verify[=<verify(default:false)>]]
>>> [--name <component_name>]\n\t[--upload[=<upload(default:false)>]]
>>> [--retrieve <local_dirpath>]\n\t[--dbvendorname
>>> <dbvendorname>]\n\t[*--createtables[=createtables(default:false)>]
>>> |\n\t--dropandcreatetables[=<dropandcreatetables(default:false)>]]\n\t[--uniquetablenames[=<uniquetablenames(default:false)>]]*\n\t[--deploymentplan
>>> <deployment_plan>]
>>> [--enabled[=<enabled(default:true)>]]\n\t[--generatermistubs[=<generatermistubs(default:false)>]]\n\t[--libraries
>>> jar_file[,jar_file*]] [--type <pkg-type>]\n\t[--properties
>>> (name=value)[:name=value]*]\n\t[-?|--help[=<help(defalt:false)>]] dirpath
>>>
>>
> 59c59 < redeploy.command.usagetext=redeploy [--virtualservers
> virtual_servers] [--contextroot context_root] [--precompilejsp=false]
> [--verify=false] [--name component_name] [--upload=false] [--retrieve
> local_dirpath] [--dbvendorname dbvendorname] [--createtables=true |
> --dropandcreatetables=true] [--uniquetablenames=true] [--deploymentplan
> deployment_plan] [--enabled=true] [--generatermistubs=false] [--libraries
> jar_file[,jar_file*]] [--type pkg-type]
> [--properties(name=value)[:name=value]*] [-?|--help=false] file_archive |
> filepath ---
>>> redeploy.command.usagetext=redeploy\n\t[--virtualservers
>>> <virtual_servers>] [--contextroot
>>> <context_root>]\n\t[--precompilejsp[=<precompilejsp(default:false)>]]\n\t[--verify[=<verify(default:false)>]]
>>> [--name <component_name>]\n\t[--upload[=<upload(default:false)>]]
>>> [--retrieve <local_dirpath>]\n\t[--dbvendorname
>>> <dbvendorname>]\n\t[*--createtables[=createtables(default:false)>]
>>> |\n\t--dropandcreatetables[=<dropandcreatetables(default:false)>]]\n\t[--uniquetablenames[=<uniquetablenames(default:false)>]]*\n\t[--deploymentplan
>>> <deployment_plan>]
>>> [--enabled[=<enabled(default:true)>]]\n\t[--generatermistubs[=<generatermistubs(default:false)>]]\n\t[--libraries
>>> jar_file[,jar_file*]] [--type <pkg-type>]\n\t[--properties
>>> (name=value)[:name=value]*]\n\t[-?|--help[=<help(defalt:false)>]]
>>> file_archive | filepath