[jboss-jira] [JBoss JIRA] Reopened: (AS7-1701) Add a --help command line switch to jboss-admin

[Thomas Diesler (JIRA)]

     [ https://issues.jboss.org/browse/AS7-1701?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Thomas Diesler reopened AS7-1701:
---------------------------------



The documentation produced by --help does not give sufficient information about the support command line options.

Here is an example 

{code}
$ ssh --help
usage: ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-b bind_address] [-c cipher_spec]
           [-D [bind_address:]port] [-e escape_char] [-F configfile]
           [-I pkcs11] [-i identity_file]
           [-L [bind_address:]port:host:hostport]
           [-l login_name] [-m mac_spec] [-O ctl_cmd] [-o option] [-p port]
           [-R [bind_address:]port:host:hostport] [-S ctl_path]
           [-W host:port] [-w local_tun[:remote_tun]]
           [user@]hostname [command]
{code}

The syntax of the 'connect' option is not clear either

{code}
$ bin/jboss-admin.sh connect
Connected to standalone controller at localhost:9999
Closed connection to localhost:9999
$ 
{code}

I'd say that this is issue is resolved when a user does not need to rely on external documentation to find out what command line options are supported.

Once in the context of the tool the 'help' command would produce documentation relevant to the context - this is already given I think.

> Add a --help command line switch to jboss-admin
> -----------------------------------------------
>
>                 Key: AS7-1701
>                 URL: https://issues.jboss.org/browse/AS7-1701
>             Project: Application Server 7
>          Issue Type: Feature Request
>          Components: CLI
>            Reporter: Thomas Diesler
>            Assignee: Alexey Loubyansky
>             Fix For: 7.1.0.Beta1
>
>
> {code}
> $ bin/jboss-admin.sh --help
> '--help' is not a valid operation name.
> {code}
> I would have like to see that 
> {code}
> $ bin/jboss-admin.sh --connect 
> {code}
> is valid.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira