src/main/resources/resources/options.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3 <command-line name="stigmata">
   4   <definitions>
   5     <definition name="classpath">
   6       <short-option>c</short-option>
   7       <long-option>classpath</long-option>
   8       <description>Append classpath. Separated with comma.</description>
   9       <argument>REQUIRED</argument>
  10       <argument-name>CLASSPATH</argument-name>
  11       <value-separator>,</value-separator>
  12       <multiple-args />
  13     </definition>
  14
  15     <definition name="birthmark">
  16       <short-option>b</short-option>
  17       <long-option>birthmark</long-option>
  18       <description>
  19         Set target birthmarks separated with comma. If this option is
  20         not specified, following available birthmarks are specified.
  21       </description>
  22       <argument>REQUIRED</argument>
  23       <argument-name>BIRTHMARKS</argument-name>
  24       <value-separator>,</value-separator>
  25       <multiple-args />
  26     </definition>
  27
  28     <definition name="mode">
  29       <short-option>m</short-option>
  30       <long-option>mode</long-option>
  31       <description>Set running mode. Available values are `gui,' `list,' `extract,' `compare,' and `gui.'  Default is `gui.'</description>
  32       <argument>REQUIRED</argument>
  33       <argument-name>MODE</argument-name>
  34     </definition>
  35
  36     <definition name="format">
  37       <short-option>f</short-option>
  38       <long-option>format</long-option>
  39       <description>Set output report format. Available value is `csv' and `xml.' Default is `csv.'</description>
  40       <argument>REQUIRED</argument>
  41       <argument-name>FORMAT</argument-name>
  42     </definition>
  43
  44     <definition name="filter">
  45       <short-option>F</short-option>
  46       <long-option>filter</long-option>
  47       <description>Filtering round robin result. This option is ignored when mode is not `compare.'</description>
  48       <argument>REQUIRED</argument>
  49       <argument-name>FILTER_NAME</argument-name>
  50     </definition>
  51
  52     <definition name="config-file">
  53       <long-option>config-file</long-option>
  54       <description>
  55         Set configuration xml file.  If you do not specified this option and you have
  56         `.birthmarks.xml' on your home directory, or `birthmark.xml' on current directory,
  57         this tool read it.
  58       </description>
  59       <argument>REQUIRED</argument>
  60       <argument-name>CONFIG-FILE</argument-name>
  61     </definition>
  62
  63     <definition name="export-config">
  64       <long-option>export-config</long-option>
  65       <description>export configuration file to specified file or standard output.</description>
  66       <argument>OPTIONAL</argument>
  67       <argument-name>FILE</argument-name>
  68     </definition>
  69
  70     <definition name="help">
  71       <short-option>h</short-option>
  72       <long-option>help</long-option>
  73       <description>print this message</description>
  74       <argument>NONE</argument>
  75     </definition>
  76
  77     <definition name="license">
  78       <short-option>l</short-option>
  79       <long-option>license</long-option>
  80       <description>print license</description>
  81       <argument>NONE</argument>
  82     </definition>
  83
  84     <definition name="version">
  85       <short-option>v</short-option>
  86       <long-option>version</long-option>
  87       <description>print version</description>
  88       <argument>NONE</argument>
  89     </definition>
  90
  91     <definition name="extraction-unit">
  92       <short-option>e</short-option>
  93       <long-option>extraction-unit</long-option>
  94       <argument>REQUIRED</argument>
  95       <argument-name>EXTRACT_UNIT</argument-name>
  96       <description>extract birthmark from EXTRACT_UNIT. Available values are CLASS, PACKAGE, and ARCHIVE.  Default is CLASS</description>
  97     </definition>
  98
  99     <definition name="store-target">
 100       <long-option>store-target</long-option>
 101       <argument>REQUIRED</argument>
 102       <argument-name>STORE_TARGET</argument-name>
 103       <description>This option represents how to store extracted birthmarks.  Available value is only MEMORY.</description>
 104     </definition>
 105   </definitions>
 106
 107   <available-options>
 108     <option>classpath</option>
 109     <option>birthmark</option>
 110     <option>format</option>
 111     <option>filter</option>
 112     <option>mode</option>
 113     <option>config-file</option>
 114     <option>help</option>
 115     <option>license</option>
 116     <option>version</option>
 117     <option>export-config</option>
 118     <option>extraction-unit</option>
 119     <option>store-target</option>
 120   </available-options>
 121 </command-line>