</p>
<p>
- These new arguments are all accessed with a <code>--doubledash</code> form of
+ These new arguments are all accessed with a <code>‑‑doubledash</code> form of
command line argument (with the one exception where simply opening one or more
files can be performed without any arguments other than the filenames).
</p>
<p>
However, you cannot mix old and new style arguments, so if you use any
<code>-singledash</code> arguments (with the exception of <code>-help</code> or <code>-h</code>), they will all be interpreted as
- old style arguments with the new <code>--doubledash</code>
+ old style arguments with the new <code>‑‑doubledash</code>
arguments being ignored. If you have a script
that uses the old arguments without any dashes, and uses the bare-word
<code>open</code> then these will also be interpreted as old style arguments.
<li>
For arguments that require a value, the value can be given after an equals-sign ('=') or a space (' ').
<br/>
- <code>--arg value</code>
+ <code>‑‑arg value</code>
<br/>
- <code>--arg=value</code>
+ <code>‑‑arg=value</code>
</li>
<li>
For arguments that can take multiple values (these will be filenames), the multiple filenames should appear after a space. If you use a filename wildcard you can put this after a space (which will be expanded by the shell unto multiple filenames before they reach Jalview), or you can put it after an equals-sign, which will be used by Jalview to find a list of files. You cannot use an equals-sign and value followed by further values.
<br/>
- <code>--arg file1.fa otherfile.stk</code>
+ <code>‑‑arg file1.fa otherfile.stk</code>
<br/>
- <code>--arg filename*.fa</code> <em>(filenames expanded by shell)</em>
+ <code>‑‑arg filename*.fa</code> <em>(filenames expanded by shell)</em>
<br/>
- <code>--arg=filename*.fa</code> <em>(filenames expanded by Jalview)</em>
+ <code>‑‑arg=filename*.fa</code> <em>(filenames expanded by Jalview)</em>
</li>
<li>
For arguments that act as a switch, most can be negated by preceding the argument name with <code>no</code>.
<br/>
- <code>--switch</code>
+ <code>‑‑switch</code>
<br/>
- <code>--noswitch</code>
+ <code>‑‑noswitch</code>
</li>
<li>
- Some values can be modified, or may need additional information (for instance an <code>--image</code> output can be modified with a <code>--scale=number</code> factor, or a <code>--structure</code> can refer to a sequence with a <code>--seqid=ID</code>). This additional information can be added in a number of different ways.
+ Some values can be modified, or may need additional information (for instance an <code>‑‑image</code> output can be modified with a <code>‑‑scale=number</code> factor, or a <code>‑‑structure</code> can refer to a sequence with a <code>‑‑seqid=ID</code>). This additional information can be added in a number of different ways.
<ul>
<li>
An argument immediately following the main argument.
<br/>
- <code>--image output.png --scale 2.5</code>
+ <code>‑‑image output.png --scale 2.5</code>
</li>
<li>
A <em>sub-value modifier</em>, which is where one or more (comma-separated) values are added to the start of the main value, placed in square brackets.
<br/>
- <code>--open=[nowrap,colour=gecos-blossom]uniref50.fa</code>
+ <code>‑‑open=[nowrap,colour=gecos-blossom]uniref50.fa</code>
<br/>
Sub-value modifiers with a value must use an equals-sign separator, and those that act as a switch can simply be included without an equals-sign or value, and can be preceded with <code>no</code> to negate the value, as with the argument name.
</li>
<li>
Another argument with the same <em>linked ID</em>. A linked ID is an optional identifier for a particular open alignment, placed in square brackets immediately following the argument name (before the equals-sign or space). If linked IDs are specified they do not need to be near to each other.
<br/>
- <code>--image[MYID]=output.png --other --args --scale[MYID]=2.5</code>
+ <code>‑‑image[MYID]=output.png --other --args --scale[MYID]=2.5</code>
</li>
<li>
An argument that is designated as applying to <em>all linked IDs</em>
<br/>
- <code>--image=output.png --other --args --all --scale=2.5</code>
+ <code>‑‑image=output.png --other --args --all --scale=2.5</code>
<br/>
- <code>--image=output.png --other --args --scale[*]=2.5</code>
+ <code>‑‑image=output.png --other --args --scale[*]=2.5</code>
</li>
</ul>
</li>
<h2><a name="headlessmode"></a>Headless mode</h2>
<p>
- Jalview can be run in headless mode, i.e. without the usual graphical user interface (GUI), by specifying the <code>--headless</code> argument. With command line arguments you can specify operations for Jalview to perform on one or more files and then stop running. Most likely you will want to output another file, either an alignment for image file.
+ Jalview can be run in headless mode, i.e. without the usual graphical user interface (GUI), by specifying the <code>‑‑headless</code> argument. With command line arguments you can specify operations for Jalview to perform on one or more files and then stop running. Most likely you will want to output another file, either an alignment for image file.
</p>
<p>
- <strong>If you specify an argument for an output file</strong> (one or more of <code>--output</code>, <code>--image</code> or <code>--structureimage</code>) then it will be assumed that you wish to <strong>run in headless mode</strong>.
+ <strong>If you specify an argument for an output file</strong> (one or more of <code>‑‑output</code>, <code>‑‑image</code> or <code>‑‑structureimage</code>) then it will be assumed that you wish to <strong>run in headless mode</strong>.
</p>
<p>
- You can force Jalview to run in graphical mode using the <code>--gui</code> argument.
+ You can force Jalview to run in graphical mode using the <code>‑‑gui</code> argument.
</p>
<p>
git://source.jalview.org / jalview.git / blobdiff