Menu

#267 Update to usage in list of help command line switches

open-accepted
6
2011-01-18
2010-07-07
No

Xena Testing Branch (changeset date 29/06/2010 12:29)

The command line help for Xena does not make it clear that you need to enter parameters for file, output directory and plugins directory.

Typing java -jar xena.jar --help at a command prompt, I get:

usage: xena
-f,--file <arg> Input files
-h,--help Print usage information
-o,--outputDirectory <arg> Output directory
-p,--pluginsDirectory <arg> Path to plugins directory

Can this be updated to show the user that three arguments (file, output directory and plugins directory) are required to normalise files.

For example:

usage: xena [--file <arg>] [--outputDirectory <arg>] [--pluginsDirectory <arg>]

Also, the long form of an argument is not standard as '=' is not used (e.g. --file <arg> vs. --file=<arg>)

Discussion

  • Justin Waddell

    Justin Waddell - 2010-07-08

    The plugins directory should not be mandatory (it can just default to the "plugins" directory under the current working directory).

     
  • Matthew Oliver

    Matthew Oliver - 2010-07-12

    Updated the usage to correctly identify which parameters are required and if the plugins directory is not supplied then the console attempts to find one in the local directory.

     
  • Matthew Oliver

    Matthew Oliver - 2010-07-12
    • assigned_to: nobody --> acunliffe
    • status: open --> open-fixed
     
  • Matthew Oliver

    Matthew Oliver - 2010-07-12

    This fix is tagged as rfe-3026203

     
  • Allan Cunliffe

    Allan Cunliffe - 2010-07-14

    Tested in Xena testing branch (rfe-3026203)

    A couple of things:

    * The plugins option can't be stated on it own. If it is, the help contents is displayed.
    * The switch for file option should be "file" not "files"

    Can you please adjust the arguments statement to be:
    usage: xena [--outputDirectory <arg> --file <args> [--pluginsDirectory <arg>]]

     
  • Allan Cunliffe

    Allan Cunliffe - 2010-07-19
    • assigned_to: acunliffe --> matthewoliver
     
  • Daniel Black

    Daniel Black - 2011-01-18
    • labels: --> Interface Improvements
    • priority: 5 --> 6
    • status: open-fixed --> open-accepted
     

Log in to post a comment.