--- /dev/null
+<html>
+<!--
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<title>Command Line: reference</title>
+<body>
+
+ <h1>Command Line: reference</h1>
+
+ <p>
+ <a href="clarguments.html">Command Line: introduction</a>
+ <br/>
+ <a href="clarguments-basic.html">Command Line: basic usage</a>
+ <br/>
+ <a href="clarguments-advanced.html">Command Line: advanced usage</a>
+ <br/>
+ <a href="clarguments-argfiles.html">Command Line: argument files</a>
+ <br/>
+ Command Line: reference
+ </p>
+
+ <hr/>
+
+ <ul>
+ <li><a href="#initialisingarguments">Initialising arguments</a></li>
+ <li><a href="#openinganalignment">Opening an alignment</a></li>
+ <li><a href="#adding3dstructure">Adding 3D structure</a></li>
+ <li><a href="#processingalignments">Processing alignments</a></li>
+ <li><a href="#outputtingalignmentfiles">Outputting alignment files</a></li>
+ <li><a href="#exportingimagefiles">Exporting image files</a></li>
+ <li><a href="#exporting3dstructureimagefiles">Exporting 3D structure image files</a></li>
+ <li><a href="#controllingflowofarguments">Controlling flow of arguments</a></li>
+ </ul>
+
+
+ <h2><a name="initialisingarguments"></a>Initialising arguments</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑help / -h</code>
+ </td>
+ <td>Display a help statement.</td>
+ </tr>
+
+ <tr valign="top"><td><code>‑‑help‑config</code></td><td>Help for arguments used to configure Jalview from startup</td></tr>
+ <tr valign="top"><td><code>‑‑help‑opening</code></td><td>Help for arguments used to open and format alignments</td></tr>
+ <tr valign="top"><td><code>‑‑help‑structure</code></td><td>Help for arguments used to add and format 3D structure data</td></tr>
+ <tr valign="top"><td><code>‑‑help‑process</code></td><td>Help for arguments used to process an alignment once opened</td></tr>
+ <tr valign="top"><td><code>‑‑help‑output</code></td><td>Help for arguments used to save data from a processed alignment</td></tr>
+ <tr valign="top"><td><code>‑‑help‑image</code></td><td>Help for arguments used to export an image of an alignment</td></tr>
+ <tr valign="top"><td><code>‑‑help‑structureimage</code></td><td>Help for arguments used to export an image of an structure</td></tr>
+ <tr valign="top"><td><code>‑‑help‑flow</code></td><td>Help for arguments that control processing of the other arguments</td></tr>
+ <tr valign="top"><td><code>‑‑help‑all</code></td><td>Help for all arguments</td></tr>
+
+ <tr valign="top">
+ <td><code>‑‑headless</code></td>
+ <td>Run Jalview in headless mode. In headless mode, no GUI interface will be created and Jalview will quit after all arguments have been processed.
+ <br/>
+ If you use a command line argument to specify an output file of some kind (<code>--output</code>, <code>--image</code> or <code>--structureimage</code>) then <strong>headless mode will be assumed</strong>. If you don't want this behaviour use <code>--gui</code>.
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑gui</code></td>
+ <td>Force Jalview to run in graphical mode. This can be used to counter the assumption of headless mode when an argument that creates an output file is used. <code>--gui</code> takes precedence over <code>--headless</code>.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑jabaws <em>URL</em></code></td>
+ <td>Set a different URL to connect to a JABAWS server.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑news / ‑‑nonews</code></td>
+ <td>Show (/ or don't show) the news feed.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑splash / ‑‑nosplash</code></td>
+ <td>Show (/ or don't show) the About Jalview splash screen.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑questionnaire / ‑‑noquestionnaire</code></td>
+ <td>Show (/ or don't show) the questionnaire if one is available.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑nousagestats</code></td>
+ <td>Don't send usage stats via Google analytics for this session. <em>Note: usage stats are useful for future funding for Jalview!</em></td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑nostartupfile</code></td>
+ <td>Don't show the default startup file.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑webservicediscovery / ‑‑nowebservicediscovery</code></td>
+ <td>Attempt (/ or don't attempt) to connect to JABAWS web services.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑props <em>filename</em></code></td>
+ <td>Use file <em>filename</em> as the preferences file <em>instead</em> of the usual <code>~/.jalview_properties</code> file.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑debug</code></td>
+ <td>Start Jalview in debug log level.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑quiet</code></td>
+ <td>Stop all output to STDOUT (after the Java Virtual Machine has started). Use <code>‑‑quiet</code> a second time to stop all output to STDERR.</td>
+ </tr>
+
+<!--
+ <tr valign="top">
+ <td><code>‑‑P<em>PREFERENCE=VALUE</em></code></td>
+ <td>Set a Jalview preference for this session only. Experimental.</td>
+ </tr>
+-->
+
+<!--
+ <tr valign="top">
+ <td><code>‑‑initsubstitutions / ‑‑noinitsubstitutions</code></td>
+ <td>Set <code>‑‑substitutions</code> to be initially enabled (or initially disabled).</td>
+ </tr>
+-->
+
+<!--
+ <tr valign="top">
+ <td><code>‑‑threads <em>NUMBER</em></code></td>
+ <td>When opening multiple alignment windows, set a limit of <em>NUMBER</em> alignments being processed at one time. The default is 3.</td>
+-->
+
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑jvmmempc=<em>PERCENT</em></code></td>
+ <td>
+ Limit maximum heap size (memory) to <em>PERCENT</em>% of total physical memory detected.
+ This defaults to 90 if total physical memory can be detected.
+ <br/>
+ The equals sign ("=") separator must be used with no spaces.
+ <br/>
+ See <a href="../memory.html">Memory usage settings for Jalview</a> for more details.
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑jvmmemmax=<em>MAXMEMORY</em></code></td>
+ <td>
+ Limit maximum heap size (memory) to <em>MAXMEMORY</em>. <em>MAXMEMORY</em> can be specified in bytes, kilobytes(k), megabytes(m),
+ gigabytes(g) or if you're lucky enough, terabytes(t).
+ This defaults to 32g if total physical memory can be detected, or to 8g if total physical memory cannot be detected.
+ <br/>
+ The equals sign ("=") separator must be used with no spaces.
+ <br/>
+ See <a href="../memory.html">Memory usage settings for Jalview</a> for more details.
+ </td>
+ </tr>
+
+ </table>
+
+
+ <h2><a name="openinganalignment"></a>Opening an alignment</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ <td><strong>sub-value modifiers</strong> (optional)</td>
+ <td><strong>linked</strong> (optional)</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑open <em>filename/URL ...</em></code></td>
+ <td>
+ Opens one or more alignment files <em>filename</em> or URLs <em>URL</em> in new alignment windows.
+ </td>
+ <td>
+ <code>
+ colour=<em>name</em>,
+ <br/>
+ title=<em>string</em>,
+ <br/>
+ features=<em>filename</em>,
+ <br/>
+ annotations=<em>filename</em>,
+ <br/>
+ tree=<em>filename</em>,
+ <br/>
+ showannotations,
+ <br/>
+ showssannotations,
+ <br/>
+ sortbytree,
+ <br/>
+ wrap
+ </code>
+ </td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑append <em>filename/URL ...</em></code></td>
+ <td>Appends one or more alignment files <em>filename</em> or URLs <em>URL</em> to the open alignment window (or opens a new alignment if none already open).</td>
+ <td>
+ <code>
+ colour=<em>name</em>,
+ <br/>
+ title=<em>string</em>,
+ <br/>
+ features=<em>filename</em>,
+ <br/>
+ annotations=<em>filename</em>,
+ <br/>
+ tree=<em>filename</em>,
+ <br/>
+ showannotations,
+ <br/>
+ showssannotations,
+ <br/>
+ sortbytree,
+ <br/>
+ wrap
+ </code>
+ </td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑title <em>"string"</em></code></td>
+ <td>Specifies the title for the open alignment window as <em>string</em>.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑colour <em>name</em></code></td>
+ <td>Applies the colour scheme <em>name</em> to the open alignment window. Valid values for <em>name</em> include:
+ <br/>
+ <code>clustal</code>,
+ <br/>
+ <code>blosum62</code>,
+ <br/>
+ <code>pc-identity</code>,
+ <br/>
+ <code>zappo</code>,
+ <br/>
+ <code>taylor</code>,
+ <br/>
+ <code>gecos-flower</code>,
+ <br/>
+ <code>gecos-blossom</code>,
+ <br/>
+ <code>gecos-sunset</code>,
+ <br/>
+ <code>gecos-ocean</code>,
+ <br/>
+ <code>hydrophobic</code>,
+ <br/>
+ <code>helix-propensity</code>,
+ <br/>
+ <code>strand-propensity</code>,
+ <br/>
+ <code>turn-propensity</code>,
+ <br/>
+ <code>buried-index</code>,
+ <br/>
+ <code>nucleotide</code>,
+ <br/>
+ <code>nucleotide-ambiguity</code>,
+ <br/>
+ <code>purine-pyrimidine</code>,
+ <br/>
+ <code>rna-helices</code>,
+ <br/>
+ <code>t-coffee-scores</code>,
+ <br/>
+ <code>sequence-id</code>.
+ <br/>
+ <br/>
+ Names of user defined schemes will also work, and jalview colour scheme specifications like:
+ <br/>
+ <code>‑‑colour "D,E=red; K,R,H=0022FF; C,c=yellow"</code>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑features <em>filename/URL</em></code></td>
+ <td>Add a feature file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+
+
+ <tr valign="top">
+ <td><code>‑‑tree <em>filename/URL</em></code></td>
+ <td>Add a tree file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑sortbytree / ‑‑nosortbytree</code></td>
+ <td>Enforces sorting (or not sorting) the alignment in the order of an attached phylogenetic tree.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+
+ <tr valign="top">
+ <td><code>‑‑annotations <em>filename/URL</em></code></td>
+ <td>Add an annotations file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑showannotations / ‑‑noshowannotations</code></td>
+ <td>Enforces showing (or not showing) alignment annotations.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑wrap / ‑‑nowrap</code></td>
+ <td>Enforces wrapped (or not wrapped) alignment formatting.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑nostructure</code></td>
+ <td>Do not open or process any 3D structure in the <code>‑‑open</code> or <code>‑‑append</code> files.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ </table>
+
+
+ <h2><a name="adding3dstructure"></a>Adding 3D structure</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ <td><strong>sub-value modifiers</strong> (optional)</td>
+ <td><strong>linked</strong> (optional)</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑structure <em>filename/URL</em></code></td>
+ <td>Load a structure file <em>filename</em> or URL <em>URL</em> associated with a sequence in the open alignment. The sequence to be associated with can be specified with a following <code>‑‑seqid</code> argument, or the sub-value modifier <code>seqid=<em>ID</em></code> can be used. A sub-value <em>INDEX</em> can also be used to specify the <em>INDEX-th</em> sequence in the open alignment.</td>
+ <td>
+ <code>
+ seqid=<em>id</em></code> or <code><em>INDEX</em>,
+ <br/>
+ paefile=<em>filename</em>,
+ <br/>
+ tempfac=<em>name</em>,
+ <br/>
+ showssannotations,
+ <!--
+ <br/>
+ notempfac,
+ -->
+ <br/>
+ structureviewer=<em>name</em>
+ </code></td>
+ <td align="center">✓</td>
+ </tr>
+
+
+ <tr valign="top">
+ <td><code>‑‑seqid <em>ID</em></code></td>
+ <td>Specify the sequence name for the preceding <code>‑‑structure</code> to be associated with.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+
+ <tr valign="top">
+ <td><code>‑‑paematrix <em>filename</em></code></td>
+ <td>Add a PAE json matrix file <em>filename</em> to the preceding <code>‑‑structure</code>.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+
+ <tr valign="top">
+ <td><code>‑‑tempfac <em>name</em></code></td>
+ <td>Set the type of temperature factor. Valid values for <em>name</em> are:
+ <br/>
+ <code>default</code>,
+ <br/>
+ <code>plddt</code>
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+
+ <tr valign="top">
+ <td><code>‑‑structureviewer <em>name</em></code></td>
+ <td>Set the structure viewer to use to open the 3d structure file specified in previous <code>‑‑structure</code> to <em>name</em>. Valid values of <em>name</em> are:
+ <br/>
+ <code>none</code>,
+ <br/>
+ <code>jmol</code>,
+ <br/>
+ <code>chimera</code> <em>- requires installation, might need configuring in Preferences</em>,
+ <br/>
+ <code>chimerax</code> <em>- requires installation, might need configuring in Preferences</em>,
+ <br/>
+ <code>pymol</code> <em>- requires installation, might need configuring in Preferences</em>
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+
+ <!--
+ <tr valign="top">
+ <td><code>‑‑notempfac</code></td>
+ <td>Do not show the temperature factor annotation for the preceding <code>‑‑structure</code></td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+ -->
+
+
+ <tr valign="top">
+ <td><code>‑‑showssannotations / ‑‑noshowssannotations</code></td>
+ <td>Do not show secondary structure annotations for the preceding <code>‑‑structure</code></td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑close</code></td>
+ <td>Close the open alignment window. This occurs after other output, processing and image export arguments. This applies to the current open alignment -- to apply to all <code>‑‑output</code> and <code>‑‑image</code> files, use after <code>‑‑all</code>.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ </table>
+
+
+ <h2><a name="processingalignments"></a>Processing alignments</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ <td><strong>sub-value modifiers</strong> (optional)</td>
+ <td><strong>linked</strong> (optional)</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑groovy <em>filename</em></code></td>
+ <td>Process a groovy script in the file for the open alignment.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+ </table>
+
+
+ <h2><a name="outputtingalignmentfiles"></a>Outputting alignment files</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ <td><strong>sub-value modifiers</strong> (optional)</td>
+ <td><strong>linked</strong> (optional)</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑output <em>filename</em></code></td>
+ <td>Export the open alignment to file <em>filename</em>. The format <em>name</em> is specified by the sub-value modifier <code>format=<em>name</em></code>, a following <code>‑‑format <em>name</em></code> argument or guessed from the file extension. Valid format names (and file extensions) are:
+ <br/>
+ <code>fasta</code> (<code>fa, fasta, mfa, fastq</code>),
+ <br/>
+ <code>pfam</code> (<code>pfam</code>),
+ <br/>
+ <code>stockholm</code> (<code>sto, stk</code>),
+ <br/>
+ <code>pir</code> (<code>pir</code>),
+ <br/>
+ <code>blc</code> (<code>blc</code>),
+ <br/>
+ <code>amsa</code> (<code>amsa</code>),
+ <br/>
+ <code>json</code> (<code>json</code>),
+ <br/>
+ <code>pileup</code> (<code>pileup</code>),
+ <br/>
+ <code>msf</code> (<code>msf</code>),
+ <br/>
+ <code>clustal</code> (<code>aln</code>),
+ <br/>
+ <code>phylip</code> (<code>phy</code>),
+ <br/>
+ <code>jalview</code> (<code>jvp, jar</code>).
+ <br/>
+ To output directly to STDOUT (console output) use the filename <code>-</code> (a single hyphen). In this case all STDOUT messages will instead go to STDERR. If no <code>format</code> is supplied then Fasta will be assumed.
+ </td>
+ <td><code>format=<em>name</em></code></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑format <em>name</em></code></td>
+ <td>Sets the format for the preceding <code>‑‑output</code> file. Valid formats are:
+ <br/>
+ <code>fasta</code>,
+ <br/>
+ <code>pfam</code>,
+ <br/>
+ <code>stockholm</code>,
+ <br/>
+ <code>pir</code>,
+ <br/>
+ <code>blc</code>,
+ <br/>
+ <code>amsa</code>,
+ <br/>
+ <code>json</code>,
+ <br/>
+ <code>pileup</code>,
+ <br/>
+ <code>msf</code>,
+ <br/>
+ <code>clustal</code>,
+ <br/>
+ <code>phylip</code>,
+ <br/>
+ <code>jalview</code>.
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑backups / ‑‑nobackups</code></td>
+ <td>Enable (or disable) writing backup files when saving an <code>‑‑output</code> file. This applies to the current open alignment -- to apply to all <code>‑‑output</code> and <code>‑‑image</code> files, use after <code>‑‑all</code>.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑overwrite / ‑‑nooverwrite</code></td>
+ <td>Enable (or disable) overwriting of output files without backups enabled. This applies to the current open alignment -- to apply to all <code>‑‑output</code> and <code>‑‑image</code> files, use after <code>‑‑all</code>.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ </table>
+
+
+ <h2><a name="exportingimagefiles"></a>Exporting image files</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ <td><strong>sub-value modifiers</strong> (optional)</td>
+ <td><strong>linked</strong> (optional)</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑image <em>filename</em></code></td>
+ <td>Output an image of the open alignment window. Format is specified by the sub-value modifier, a following <code>‑‑type</code> argument or guessed from the file extension. Valid formats/extensions are:
+ <br/>
+ <code>svg</code>,
+ <br/>
+ <code>png</code>,
+ <br/>
+ <code>eps</code>,
+ <br/>
+ <code>html</code>,
+ <br/>
+ <code>biojs</code>.
+ </td>
+ <td>
+ <code>type=<em>name</em>,
+ <code>textrenderer=<em>name</em>,
+ <code>scale=<em>number</em>,
+ <code>width=<em>number</em>,
+ <code>height=<em>number</em>
+ </td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑type <em>name</em></code></td>
+ <td>Set the image format for the preceding <code>‑‑image</code> to <em>name</em>. Valid values for <em>name</em> are:
+ <br/>
+ <code>svg</code>,
+ <br/>
+ <code>png</code>,
+ <br/>
+ <code>eps</code>,
+ <br/>
+ <code>html</code>,
+ <br/>
+ <code>biojs</code>.
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑textrenderer <em>name</em></code></td>
+ <td>Sets whether text in a vector image format (SVG, HTML, EPS) should be rendered as text or vector line-art. Valid values for <em>name</em> are:
+ <br/>
+ <code>text</code>,
+ <br/>
+ <code>lineart</code>.
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑scale <em>number</em></code></td>
+ <td>Sets a scaling for bitmap image format (PNG). Should be given as a floating point number. This can also be set as a sub-value modifier to the <code>--image</code> value. If used in conjunction with <code>--width</code> and <code>--height</code> then the smallest scaling will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑width <em>number</em></code></td>
+ <td>Sets a width for bitmap image format (PNG) with the height maintaining the aspect ratio. Should be given as a positive integer. This can also be set as a sub-value modifier to the <code>--image</code> value. If used in conjunction with <code>--scale</code> and <code>--height</code> then the smallest scaling will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑height <em>number</em></code></td>
+ <td>Sets a height for bitmap image format (PNG) with the width maintaining the aspect ratio. Should be given as a positive integer. This can also be set as a sub-value modifier to the <code>--image</code> value. If used in conjunction with <code>--scale</code> and <code>--width</code> then the smallest scaling will be used (<code>scale</code>, <code>width</code> and <code>height</code> provide bounds for the image).</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑groovy <em>filename</em></code></td>
+ <td>Process a groovy script in the file for the open alignment.</td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ </table>
+
+
+ <h2><a name="exporting3dstructureimagefiles"></a>Exporting 3D structure image files (<code>jmol</code> only)</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ <td><strong>sub-value modifiers</strong> (optional)</td>
+ <td><strong>linked</strong> (optional)</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑structureimage <em>filename</em></code></td>
+ <td>Export an image of a 3D structure opened in JMOL. Image formats can be:
+ <br/>
+ <code>svg</code>,
+ <br/>
+ <code>png</code>,
+ <br/>
+ <code>eps</code>.
+ </td>
+ <td>
+ <code>structureimagetype=<em>name</em>,
+ <code>structureimagetextrenderer=<em>name</em>,
+ <code>structureimagescale=<em>number</em>,
+ <code>structureimagewidth=<em>number</em>,
+ <code>structureimageheight=<em>number</em>
+ </td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑structureimagetype <em>name</em></code></td>
+ <td>Set the structure image format for the preceding --structureimage. Valid values are:
+ <br/>
+ <code>svg</code>,
+ <br/>
+ <code>png</code>,
+ <br/>
+ <code>eps</code>.
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑structureimagetextrenderer <em>name</em></code></td>
+ <td>Sets whether text in a vector structure image format (SVG, EPS) should be rendered as text or vector line-art. Possible values are:
+ <br/>
+ <code>text</code>,
+ <br/>
+ <code>lineart</code>.
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑structureimagescale <em>number</em></code></td>
+ <td>Sets a scaling for bitmap structure image format (PNG). Should be given as a floating point number. If used in conjunction with --structureimagewidth and --structureimageheight then the smallest scaling will be used (structureimagescale, structureimagewidth and structureimageheight provide bounds for the structure image).
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑structureimagewidth <em>number</em></code></td>
+ <td>Sets a width for bitmap structure image format (PNG) with the height maintaining the aspect ratio. Should be given as a positive integer. If used in conjunction with --structureimagescale and --structureimageheight then the smallest scaling will be used (structureimagescale, structureimagewidth and structureimageheight provide bounds for the structure image).
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑structureimageheight <em>number</em></code></td>
+ <td>Sets a height for bitmap structure image format (PNG) with the width maintaining the aspect ratio. Should be given as a positive integer. If used in conjunction with --structureimagescale and --structureimagewidth then the smallest scaling will be used (structureimagescale, structureimagewidth and structureimageheight provide bounds for the structure image).
+ </td>
+ <td></td>
+ <td align="center">✓</td>
+ </tr>
+
+ </table>
+
+
+ <h2><a name="controllingflowofarguments"></a>Controlling flow of arguments</h2>
+
+ <table border="1" cellpadding="3">
+ <tr valign="top">
+ <td><strong>argument</strong></td>
+ <td><strong>action</strong></td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑new</code></td>
+ <td>
+ Move on to a new alignment window. This will ensure <code>‑‑append</code> will start a new alignment window and other linked arguments will apply to the new alignment window.
+ <br/>
+ <em>Note</em> that <code>--open</code> already starts a new alignment window for each file it opens.
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑substitutions / ‑‑nosubstitutions</code></td>
+ <td>The following argument values allow (or don't allow) subsituting filename parts. This is initially true. Valid substitutions are
+ <code>{basename}</code> - the filename-without-extension of the currently <code>‑‑open</code>ed file (or first <code>‑‑append</code>ed file),
+ <br/>
+ <code>{dirname}</code>, - the directory (folder) name of the currently <code>‑‑open</code>ed file (or first <code>‑‑append</code>ed file),
+ <br/>
+ <code>{argfilebasename}</code> - the filename-without-extension of the current <code>‑‑argfile</code>,
+ <br/>
+ <code>{argfiledirname}</code> - the directory (folder) name of the current <code>‑‑argfile</code>,
+ <br/>
+ <code>{n}</code> - the value of the index counter (starting at 0).
+ <br/>
+ <code>{++n}</code> - increase and substitute the value of the index counter,
+ <br/>
+ <code>{}</code> - the value of the current alignment window <em>default</em> index.
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑argfile <em>filename</em></code></td>
+ <td>
+ Open one or more files <em>filename</em> and read, line-by-line, as arguments to Jalview.
+ <br/>
+ Values in an argfile should be given with an equals sign ("=") separator with no spaces.
+ <br/>
+ <strong>Note</strong> that if you use one or more <code>‑‑argfile</code> arguments then all other non-initialising arguments will be ignored.
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑npp</code></td>
+ <td>Increase the index counter used in argument value substitutions.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑all / ‑‑noall</code></td>
+ <td>Apply (or stop applying) the following output arguments to <em>all</em> sets of linked arguments.</td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑allstructures / ‑‑noallstructures</code></td>
+ <td>
+ Apply (or stop applying) the following 3D structure formatting arguments to all structures <em>within the current open alignment</em>. Whilst <code>--allstructures</code> will continue to operate for a <code>--new</code> alignment, the structure formatting arguments must be set again for each new alignment.
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td><code>‑‑quit</code></td>
+ <td>After all files have been opened, appended and output, quit Jalview. In <code>‑‑headless</code> mode this already happens.</td>
+ </tr>
+
+ </table>
+
+</body>
+</html>
git://source.jalview.org / jalview.git / blobdiff