help/help/html/features/clarguments-reference.html

   1 <html>
   2 <!--
   3  * Jalview is distributed in the hope that it will be useful, but
   4  * WITHOUT ANY WARRANTY; without even the implied warranty
   5  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   6  * PURPOSE.  See the GNU General Public License for more details.
   7  *
   8  * You should have received a copy of the GNU General Public License
   9  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  10  * The Jalview Authors are detailed in the 'AUTHORS' file.
  11  -->
  12 <title>Command Line: reference</title>
  13 <body>
  14
  15   <h1>Command Line: reference</h1>
  16
  17   <p>
  18   <a href="clarguments.html">Command Line: introduction</a>
  19   <br/>
  20   <a href="clarguments-basic.html">Command Line: basic usage</a>
  21   <br/>
  22   <a href="clarguments-advanced.html">Command Line: advanced usage</a>
  23   <br/>
  24   <a href="clarguments-argfiles.html">Command Line: argument files</a>
  25   <br/>
  26   Command Line: reference
  27   </p>
  28
  29   <hr/>
  30
  31   <ul>
  32   <li><a href="#initialisingarguments">Initialising arguments</a></li>
  33   <li><a href="#openinganalignment">Opening an alignment</a></li>
  34   <li><a href="#adding3dstructure">Adding 3D structure</a></li>
  35   <li><a href="#processingalignments">Processing alignments</a></li>
  36   <li><a href="#outputtingalignmentfiles">Outputting alignment files</a></li>
  37   <li><a href="#exportingimagefiles">Exporting image files</a></li>
  38   <li><a href="#exporting3dstructureimagefiles">Exporting 3D structure image files</a></li>
  39   <li><a href="#controllingflowofarguments">Controlling flow of arguments</a></li>
  40   </ul>
  41
  42
  43   <h2><a name="initialisingarguments"></a>Initialising arguments</h2>
  44
  45   <table border="1" cellpadding="3">
  46     <tr valign="top">
  47     <td><strong>argument</strong></td>
  48     <td><strong>action</strong></td>
  49     </tr>
  50
  51     <tr valign="top">
  52     <td><code>&#8209;&#8209;help / -h</code>
  53     </td>
  54     <td>Display a help statement.</td>
  55     </tr>
  56
  57     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;config</code></td><td>Help for arguments used to configure Jalview from startup</td></tr>
  58     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;opening</code></td><td>Help for arguments used to open and format alignments</td></tr>
  59     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;structure</code></td><td>Help for arguments used to add and format 3D structure data</td></tr>
  60     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;process</code></td><td>Help for arguments used to process an alignment once opened</td></tr>
  61     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;output</code></td><td>Help for arguments used to save data from a processed alignment</td></tr>
  62     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;image</code></td><td>Help for arguments used to export an image of an alignment</td></tr>
  63     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;structureimage</code></td><td>Help for arguments used to export an image of an structure</td></tr>
  64     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;flow</code></td><td>Help for arguments that control processing of the other arguments</td></tr>
  65     <tr valign="top"><td><code>&#8209;&#8209;help&#8209;all</code></td><td>Help for all arguments</td></tr>
  66
  67     <tr valign="top">
  68     <td><code>&#8209;&#8209;headless / &#8209;&#8209;noheadless</code></td>
  69     <td>Run Jalview in headless (/ or not in headless) mode.  In headless mode, no GUI interface will be created and Jalview will quit after all arguments have been processed.
  70     <br/>
  71     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>--noheadless</code> or <code>--gui</code>.
  72     </td>
  73     </tr>
  74
  75     <tr valign="top">
  76     <td><code>&#8209;&#8209;gui</code></td>
  77     <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>
  78     </tr>
  79
  80     <tr valign="top">
  81     <td><code>&#8209;&#8209;jabaws&nbsp;<em>URL</em></code></td>
  82     <td>Set a different URL to connect to a JABAWS server.</td>
  83     </tr>
  84
  85     <tr valign="top">
  86     <td><code>&#8209;&#8209;news / &#8209;&#8209;nonews</code></td>
  87     <td>Show (/ or don't show) the news feed.</td>
  88     </tr>
  89
  90     <tr valign="top">
  91     <td><code>&#8209;&#8209;splash / &#8209;&#8209;nosplash</code></td>
  92     <td>Show (/ or don't show) the About Jalview splash screen.</td>
  93     </tr>
  94
  95     <tr valign="top">
  96     <td><code>&#8209;&#8209;questionnaire / &#8209;&#8209;noquestionnaire</code></td>
  97     <td>Show (/ or don't show) the questionnaire if one is available.</td>
  98     </tr>
  99
 100     <tr valign="top">
 101     <td><code>&#8209;&#8209;nousagestats</code></td>
 102     <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>
 103     </tr>
 104
 105     <tr valign="top">
 106     <td><code>&#8209;&#8209;nostartupfile</code></td>
 107     <td>Don't show the default startup file.</td>
 108     </tr>
 109
 110     <tr valign="top">
 111     <td><code>&#8209;&#8209;webservicediscovery / &#8209;&#8209;nowebservicediscovery</code></td>
 112     <td>Attempt (/ or don't attempt) to connect to JABAWS web services.</td>
 113     </tr>
 114
 115     <tr valign="top">
 116     <td><code>&#8209;&#8209;props&nbsp;<em>filename</em></code></td>
 117     <td>Use file <em>filename</em> as the preferences file <em>instead</em> of the usual <code>~/.jalview_properties</code> file.</td>
 118     </tr>
 119
 120     <tr valign="top">
 121     <td><code>&#8209;&#8209;debug</code></td>
 122     <td>Start Jalview in debug log level.</td>
 123     </tr>
 124
 125     <tr valign="top">
 126     <td><code>&#8209;&#8209;quiet</code></td>
 127     <td>Stop all output to STDOUT (after the Java Virtual Machine has started).  Use <code>&#8209;&#8209;quiet</code> a second time to stop all output to STDERR.</td>
 128     </tr>
 129
 130 <!--
 131     <tr valign="top">
 132     <td><code>&#8209;&#8209;P<em>PREFERENCE=VALUE</em></code></td>
 133     <td>Set a Jalview preference for this session only.  Experimental.</td>
 134     </tr>
 135 -->
 136
 137 <!--
 138     <tr valign="top">
 139     <td><code>&#8209;&#8209;initsubstitutions / &#8209;&#8209;noinitsubstitutions</code></td>
 140     <td>Set <code>&#8209;&#8209;substitutions</code> to be initially enabled (or initially disabled).</td>
 141     </tr>
 142 -->
 143
 144 <!--
 145     <tr valign="top">
 146     <td><code>&#8209;&#8209;threads <em>NUMBER</em></code></td>
 147     <td>When opening multiple alignment windows, set a limit of <em>NUMBER</em> alignments being processed at one time.  The default is 3.</td>
 148 -->
 149
 150     </tr>
 151
 152     <tr valign="top">
 153     <td><code>&#8209;&#8209;jvmmempc=<em>PERCENT</em></code></td>
 154     <td>
 155       Limit maximum heap size (memory) to <em>PERCENT</em>% of total physical memory detected.
 156       This defaults to 90 if total physical memory can be detected.
 157       <br/>
 158       The equals sign ("=") separator must be used with no spaces.
 159       <br/>
 160       See <a href="../memory.html">Memory usage settings for Jalview</a> for more details.
 161     </td>
 162     </tr>
 163
 164     <tr valign="top">
 165     <td><code>&#8209;&#8209;jvmmemmax=<em>MAXMEMORY</em></code></td>
 166     <td>
 167       Limit maximum heap size (memory) to <em>MAXMEMORY</em>. <em>MAXMEMORY</em> can be specified in bytes, kilobytes(k), megabytes(m),
 168       gigabytes(g) or if you're lucky enough, terabytes(t).
 169       This defaults to 32g if total physical memory can be detected, or to 8g if total physical memory cannot be detected.
 170       <br/>
 171       The equals sign ("=") separator must be used with no spaces.
 172       <br/>
 173       See <a href="../memory.html">Memory usage settings for Jalview</a> for more details.
 174     </td>
 175     </tr>
 176
 177   </table>
 178
 179
 180   <h2><a name="openinganalignment"></a>Opening an alignment</h2>
 181
 182   <table border="1" cellpadding="3">
 183     <tr valign="top">
 184     <td><strong>argument</strong></td>
 185     <td><strong>action</strong></td>
 186     <td><strong>sub-value modifiers</strong> (optional)</td>
 187     <td><strong>linked</strong> (optional)</td>
 188     </tr>
 189
 190     <tr valign="top">
 191     <td><code>&#8209;&#8209;open&nbsp;<em>filename/URL ...</em></code></td>
 192     <td>
 193     Opens one or more alignment files <em>filename</em> or URLs <em>URL</em> in new alignment windows.
 194     </td>
 195     <td>
 196       <code>
 197         colour=<em>name</em>,
 198         <br/>
 199         title=<em>string</em>,
 200         <br/>
 201         features=<em>filename</em>,
 202         <br/>
 203         annotations=<em>filename</em>,
 204         <br/>
 205         tree=<em>filename</em>,
 206         <br/>
 207         showannotations,
 208         <br/>
 209         showssannotations,
 210         <br/>
 211         sortbytree,
 212         <br/>
 213         wrap
 214       </code>
 215     </td>
 216     <td align="center">&#x2713;</td>
 217     </tr>
 218
 219     <tr valign="top">
 220     <td><code>&#8209;&#8209;append&nbsp;<em>filename/URL ...</em></code></td>
 221     <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>
 222     <td>
 223     <code>
 224         colour=<em>name</em>,
 225         <br/>
 226         title=<em>string</em>,
 227         <br/>
 228         features=<em>filename</em>,
 229         <br/>
 230         annotations=<em>filename</em>,
 231         <br/>
 232         tree=<em>filename</em>,
 233         <br/>
 234         showannotations,
 235         <br/>
 236         showssannotations,
 237         <br/>
 238         sortbytree,
 239         <br/>
 240         wrap
 241       </code>
 242     </td>
 243     <td align="center">&#x2713;</td>
 244     </tr>
 245
 246     <tr valign="top">
 247     <td><code>&#8209;&#8209;title&nbsp;<em>"string""</em></code></td>
 248     <td>Specifies the title for the open alignment window as <em>string</em>.</td>
 249     <td></td>
 250     <td align="center">&#x2713;</td>
 251     </tr>
 252
 253     <tr valign="top">
 254     <td><code>&#8209;&#8209;colour&nbsp;<em>name</em></code></td>
 255     <td>Applies the colour scheme <em>name</em> to the open alignment window.  Valid values for <em>name</em> are:
 256     <br/>
 257     <code>clustal</code>,
 258     <br/>
 259     <code>blosum62</code>,
 260     <br/>
 261     <code>pc-identity</code>,
 262     <br/>
 263     <code>zappo</code>,
 264     <br/>
 265     <code>taylor</code>,
 266     <br/>
 267     <code>gecos-flower</code>,
 268     <br/>
 269     <code>gecos-blossom</code>,
 270     <br/>
 271     <code>gecos-sunset</code>,
 272     <br/>
 273     <code>gecos-ocean</code>,
 274     <br/>
 275     <code>hydrophobic</code>,
 276     <br/>
 277     <code>helix-propensity</code>,
 278     <br/>
 279     <code>strand-propensity</code>,
 280     <br/>
 281     <code>turn-propensity</code>,
 282     <br/>
 283     <code>buried-index</code>,
 284     <br/>
 285     <code>nucleotide</code>,
 286     <br/>
 287     <code>nucleotide-ambiguity</code>,
 288     <br/>
 289     <code>purine-pyrimidine</code>,
 290     <br/>
 291     <code>rna-helices</code>,
 292     <br/>
 293     <code>t-coffee-scores</code>,
 294     <br/>
 295     <code>sequence-id</code>.
 296     <td></td>
 297     <td align="center">&#x2713;</td>
 298     </tr>
 299
 300     <tr valign="top">
 301     <td><code>&#8209;&#8209;features&nbsp;<em>filename/URL</em></code></td>
 302     <td>Add a feature file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 303     <td></td>
 304     <td align="center">&#x2713;</td>
 305     </tr>
 306
 307
 308
 309     <tr valign="top">
 310     <td><code>&#8209;&#8209;tree&nbsp;<em>filename/URL</em></code></td>
 311     <td>Add a tree file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 312     <td></td>
 313     <td align="center">&#x2713;</td>
 314     </tr>
 315
 316     <tr valign="top">
 317     <td><code>&#8209;&#8209;sortbytree / &#8209;&#8209;nosortbytree</code></td>
 318     <td>Enforces sorting (or not sorting) the alignment in the order of an attached phylogenetic tree.</td>
 319     <td></td>
 320     <td align="center">&#x2713;</td>
 321     </tr>
 322
 323
 324     <tr valign="top">
 325     <td><code>&#8209;&#8209;annotations&nbsp;<em>filename/URL</em></code></td>
 326     <td>Add an annotations file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 327     <td></td>
 328     <td align="center">&#x2713;</td>
 329     </tr>
 330
 331     <tr valign="top">
 332     <td><code>&#8209;&#8209;showannotations / &#8209;&#8209;noshowannotations</code></td>
 333     <td>Enforces showing (or not showing) alignment annotations.</td>
 334     <td></td>
 335     <td align="center">&#x2713;</td>
 336     </tr>
 337
 338     <tr valign="top">
 339     <td><code>&#8209;&#8209;wrap / &#8209;&#8209;nowrap</code></td>
 340     <td>Enforces wrapped (or not wrapped) alignment formatting.</td>
 341     <td></td>
 342     <td align="center">&#x2713;</td>
 343     </tr>
 344
 345     <tr valign="top">
 346     <td><code>&#8209;&#8209;nostructure</code></td>
 347     <td>Do not open or process any 3D structure in the <code>&#8209;&#8209;open</code> or <code>&#8209;&#8209;append</code> files.</td>
 348     <td></td>
 349     <td align="center">&#x2713;</td>
 350     </tr>
 351
 352   </table>
 353
 354
 355   <h2><a name="adding3dstructure"></a>Adding 3D structure</h2>
 356
 357   <table border="1" cellpadding="3">
 358     <tr valign="top">
 359     <td><strong>argument</strong></td>
 360     <td><strong>action</strong></td>
 361     <td><strong>sub-value modifiers</strong> (optional)</td>
 362     <td><strong>linked</strong> (optional)</td>
 363     </tr>
 364
 365     <tr valign="top">
 366     <td><code>&#8209;&#8209;structure&nbsp;<em>filename/URL</em></code></td>
 367     <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>&#8209;&#8209;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>
 368     <td>
 369       <code>
 370         seqid=<em>id</em></code> or <code><em>INDEX</em>,
 371         <br/>
 372         paefile=<em>filename</em>,
 373         <br/>
 374         tempfac=<em>name</em>,
 375         <br/>
 376         showssannotations,
 377         <!--
 378         <br/>
 379         notempfac,
 380         -->
 381         <br/>
 382         structureviewer=<em>name</em>
 383       </code></td>
 384     <td align="center">&#x2713;</td>
 385     </tr>
 386
 387
 388     <tr valign="top">
 389     <td><code>&#8209;&#8209;seqid&nbsp;<em>ID</em></code></td>
 390     <td>Specify the sequence name for the preceding <code>&#8209;&#8209;structure</code> to be associated with.</td>
 391     <td></td>
 392     <td align="center">&#x2713;</td>
 393     </tr>
 394
 395
 396     <tr valign="top">
 397     <td><code>&#8209;&#8209;paematrix&nbsp;<em>filename</em></code></td>
 398     <td>Add a PAE json matrix file <em>filename</em> to the preceding <code>&#8209;&#8209;structure</code>.</td>
 399     <td></td>
 400     <td align="center">&#x2713;</td>
 401     </tr>
 402
 403
 404     <tr valign="top">
 405     <td><code>&#8209;&#8209;tempfac&nbsp;<em>name</em></code></td>
 406     <td>Set the type of temperature factor.  Valid values for <em>name</em> are:
 407       <br/>
 408       <code>default</code>,
 409       <br/>
 410       <code>plddt</code>
 411     </td>
 412     <td></td>
 413     <td align="center">&#x2713;</td>
 414     </tr>
 415
 416
 417     <tr valign="top">
 418     <td><code>&#8209;&#8209;structureviewer&nbsp;<em>name</em></code></td>
 419     <td>Set the structure viewer to use to open the 3d structure file specified in previous <code>&#8209;&#8209;structure</code> to <em>name</em>.  Valid values of <em>name</em> are:
 420     <br/>
 421     <code>none</code>,
 422     <br/>
 423     <code>jmol</code>,
 424     <br/>
 425     <code>chimera</code> <em>- requires installation, might need configuring in Preferences</em>,
 426     <br/>
 427     <code>chimerax</code> <em>- requires installation, might need configuring in Preferences</em>,
 428     <br/>
 429     <code>pymol</code> <em>- requires installation, might need configuring in Preferences</em>
 430     </td>
 431     <td></td>
 432     <td align="center">&#x2713;</td>
 433     </tr>
 434
 435
 436     <!--
 437     <tr valign="top">
 438     <td><code>&#8209;&#8209;notempfac</code></td>
 439     <td>Do not show the temperature factor annotation for the preceding <code>&#8209;&#8209;structure</code></td>
 440     <td></td>
 441     <td align="center">&#x2713;</td>
 442     </tr>
 443     -->
 444
 445
 446     <tr valign="top">
 447     <td><code>&#8209;&#8209;showssannotations / &#8209;&#8209;noshowssannotations</code></td>
 448     <td>Do not show secondary structure annotations for the preceding <code>&#8209;&#8209;structure</code></td>
 449     <td></td>
 450     <td align="center">&#x2713;</td>
 451     </tr>
 452
 453     <tr valign="top">
 454     <td><code>&#8209;&#8209;close</code></td>
 455     <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>&#8209;&#8209;output</code> and <code>&#8209;&#8209;image</code> files, use after <code>&#8209;&#8209;all</code>.</td>
 456     <td></td>
 457     <td align="center">&#x2713;</td>
 458     </tr>
 459
 460   </table>
 461
 462
 463   <h2><a name="processingalignments"></a>Processing alignments</h2>
 464
 465   <table border="1" cellpadding="3">
 466     <tr valign="top">
 467     <td><strong>argument</strong></td>
 468     <td><strong>action</strong></td>
 469     <td><strong>sub-value modifiers</strong> (optional)</td>
 470     <td><strong>linked</strong> (optional)</td>
 471     </tr>
 472
 473     <tr valign="top">
 474     <td><code>&#8209;&#8209;groovy&nbsp;<em>filename</em></code></td>
 475     <td>Process a groovy script in the file for the open alignment.</td>
 476     <td></td>
 477     <td align="center">&#x2713;</td>
 478     </tr>
 479   </table>
 480
 481
 482   <h2><a name="outputtingalignmentfiles"></a>Outputting alignment files</h2>
 483
 484   <table border="1" cellpadding="3">
 485     <tr valign="top">
 486     <td><strong>argument</strong></td>
 487     <td><strong>action</strong></td>
 488     <td><strong>sub-value modifiers</strong> (optional)</td>
 489     <td><strong>linked</strong> (optional)</td>
 490     </tr>
 491
 492     <tr valign="top">
 493     <td><code>&#8209;&#8209;output&nbsp;<em>filename</em></code></td>
 494     <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>&#8209;&#8209;format <em>name</em></code> argument or guessed from the file extension.  Valid format names (and file extensions) are:
 495     <br/>
 496     <code>fasta</code> (<code>fa, fasta, mfa, fastq</code>),
 497     <br/>
 498     <code>pfam</code> (<code>pfam</code>),
 499     <br/>
 500     <code>stockholm</code> (<code>sto, stk</code>),
 501     <br/>
 502     <code>pir</code> (<code>pir</code>),
 503     <br/>
 504     <code>blc</code> (<code>blc</code>),
 505     <br/>
 506     <code>amsa</code> (<code>amsa</code>),
 507     <br/>
 508     <code>json</code> (<code>json</code>),
 509     <br/>
 510     <code>pileup</code> (<code>pileup</code>),
 511     <br/>
 512     <code>msf</code> (<code>msf</code>),
 513     <br/>
 514     <code>clustal</code> (<code>aln</code>),
 515     <br/>
 516     <code>phylip</code> (<code>phy</code>),
 517     <br/>
 518     <code>jalview</code> (<code>jvp, jar</code>).
 519     </td>
 520     <td><code>format=<em>name</em></code></td>
 521     <td align="center">&#x2713;</td>
 522     </tr>
 523
 524     <tr valign="top">
 525     <td><code>&#8209;&#8209;format&nbsp;<em>name</em></code></td>
 526     <td>Sets the format for the preceding <code>&#8209;&#8209;output</code> file.  Valid formats are:
 527     <br/>
 528     <code>fasta</code>,
 529     <br/>
 530     <code>pfam</code>,
 531     <br/>
 532     <code>stockholm</code>,
 533     <br/>
 534     <code>pir</code>,
 535     <br/>
 536     <code>blc</code>,
 537     <br/>
 538     <code>amsa</code>,
 539     <br/>
 540     <code>json</code>,
 541     <br/>
 542     <code>pileup</code>,
 543     <br/>
 544     <code>msf</code>,
 545     <br/>
 546     <code>clustal</code>,
 547     <br/>
 548     <code>phylip</code>,
 549     <br/>
 550     <code>jalview</code>.
 551     </td>
 552     <td></td>
 553     <td align="center">&#x2713;</td>
 554     </tr>
 555
 556     <tr valign="top">
 557     <td><code>&#8209;&#8209;backups / &#8209;&#8209;nobackups</code></td>
 558     <td>Enable (or disable) writing backup files when saving an <code>&#8209;&#8209;output</code> file.  This applies to the current open alignment -- to apply to all <code>&#8209;&#8209;output</code> and <code>&#8209;&#8209;image</code> files, use after <code>&#8209;&#8209;all</code>.</td>
 559     <td></td>
 560     <td align="center">&#x2713;</td>
 561     </tr>
 562
 563     <tr valign="top">
 564     <td><code>&#8209;&#8209;overwrite / &#8209;&#8209;nooverwrite</code></td>
 565     <td>Enable (or disable) overwriting of output files without backups enabled.  This applies to the current open alignment -- to apply to all <code>&#8209;&#8209;output</code> and <code>&#8209;&#8209;image</code> files, use after <code>&#8209;&#8209;all</code>.</td>
 566     <td></td>
 567     <td align="center">&#x2713;</td>
 568     </tr>
 569
 570   </table>
 571
 572
 573   <h2><a name="exportingimagefiles"></a>Exporting image files</h2>
 574
 575   <table border="1" cellpadding="3">
 576     <tr valign="top">
 577     <td><strong>argument</strong></td>
 578     <td><strong>action</strong></td>
 579     <td><strong>sub-value modifiers</strong> (optional)</td>
 580     <td><strong>linked</strong> (optional)</td>
 581     </tr>
 582
 583     <tr valign="top">
 584     <td><code>&#8209;&#8209;image&nbsp;<em>filename</em></code></td>
 585     <td>Output an image of the open alignment window.  Format is specified by the sub-value modifier, a following <code>&#8209;&#8209;type</code> argument or guessed from the file extension.  Valid formats/extensions are:
 586     <br/>
 587     <code>svg</code>,
 588     <br/>
 589     <code>png</code>,
 590     <br/>
 591     <code>eps</code>,
 592     <br/>
 593     <code>html</code>,
 594     <br/>
 595     <code>biojs</code>.
 596     </td>
 597     <td>
 598       <code>type=<em>name</em>,
 599       <code>textrenderer=<em>name</em>,
 600       <code>scale=<em>number</em>,
 601       <code>width=<em>number</em>,
 602       <code>height=<em>number</em>
 603     </td>
 604     <td align="center">&#x2713;</td>
 605     </tr>
 606
 607     <tr valign="top">
 608     <td><code>&#8209;&#8209;type&nbsp;<em>name</em></code></td>
 609     <td>Set the image format for the preceding <code>&#8209;&#8209;image</code> to <em>name</em>.  Valid values for <em>name</em> are:
 610     <br/>
 611     <code>svg</code>,
 612     <br/>
 613     <code>png</code>,
 614     <br/>
 615     <code>eps</code>,
 616     <br/>
 617     <code>html</code>,
 618     <br/>
 619     <code>biojs</code>.
 620     </td>
 621     <td></td>
 622     <td align="center">&#x2713;</td>
 623     </tr>
 624
 625     <tr valign="top">
 626     <td><code>&#8209;&#8209;textrenderer&nbsp;<em>name</em></code></td>
 627     <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:
 628     <br/>
 629     <code>text</code>,
 630     <br/>
 631     <code>lineart</code>.
 632     </td>
 633     <td></td>
 634     <td align="center">&#x2713;</td>
 635     </tr>
 636
 637     <tr valign="top">
 638     <td><code>&#8209;&#8209;scale&nbsp;<em>number</em></code></td>
 639     <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).
 640     </td>
 641     <td></td>
 642     <td align="center">&#x2713;</td>
 643     </tr>
 644
 645     <tr valign="top">
 646     <td><code>&#8209;&#8209;width&nbsp;<em>number</em></code></td>
 647     <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).
 648     </td>
 649     <td></td>
 650     <td align="center">&#x2713;</td>
 651     </tr>
 652
 653     <tr valign="top">
 654     <td><code>&#8209;&#8209;height&nbsp;<em>number</em></code></td>
 655     <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>
 656     <td></td>
 657     <td align="center">&#x2713;</td>
 658     </tr>
 659
 660     <tr valign="top">
 661     <td><code>&#8209;&#8209;groovy&nbsp;<em>filename</em></code></td>
 662     <td>Process a groovy script in the file for the open alignment.</td>
 663     <td></td>
 664     <td align="center">&#x2713;</td>
 665     </tr>
 666
 667   </table>
 668
 669
 670   <h2><a name="exporting3dstructureimagefiles"></a>Exporting 3D structure image files (<code>jmol</code> only)</h2>
 671
 672   <table border="1" cellpadding="3">
 673     <tr valign="top">
 674     <td><strong>argument</strong></td>
 675     <td><strong>action</strong></td>
 676     <td><strong>sub-value modifiers</strong> (optional)</td>
 677     <td><strong>linked</strong> (optional)</td>
 678     </tr>
 679
 680     <tr valign="top">
 681     <td><code>&#8209;&#8209;structureimage&nbsp;<em>filename</em></code></td>
 682     <td>Export an image of a 3D structure opened in JMOL.  Image formats can be:
 683     <br/>
 684     <code>svg</code>,
 685     <br/>
 686     <code>png</code>,
 687     <br/>
 688     <code>eps</code>.
 689     </td>
 690     <td>
 691       <code>structureimagetype=<em>name</em>,
 692       <code>structureimagetextrenderer=<em>name</em>,
 693       <code>structureimagescale=<em>number</em>,
 694       <code>structureimagewidth=<em>number</em>,
 695       <code>structureimageheight=<em>number</em>
 696     </td>
 697     <td align="center">&#x2713;</td>
 698     </tr>
 699
 700     <tr valign="top">
 701     <td><code>&#8209;&#8209;structureimagetype&nbsp;<em>name</em></code></td>
 702     <td>Set the structure image format for the preceding --structureimage. Valid values are:
 703     <br/>
 704     <code>svg</code>,
 705     <br/>
 706     <code>png</code>,
 707     <br/>
 708     <code>eps</code>.
 709     </td>
 710     <td></td>
 711     <td align="center">&#x2713;</td>
 712     </tr>
 713
 714     <tr valign="top">
 715     <td><code>&#8209;&#8209;structureimagetextrenderer&nbsp;<em>name</em></code></td>
 716     <td>Sets whether text in a vector structure image format (SVG, EPS) should be rendered as text or vector line-art. Possible values are:
 717     <br/>
 718     <code>text</code>,
 719     <br/>
 720     <code>lineart</code>.
 721     </td>
 722     <td></td>
 723     <td align="center">&#x2713;</td>
 724     </tr>
 725
 726     <tr valign="top">
 727     <td><code>&#8209;&#8209;structureimagescale&nbsp;<em>number</em></code></td>
 728     <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).
 729     </td>
 730     <td></td>
 731     <td align="center">&#x2713;</td>
 732     </tr>
 733
 734     <tr valign="top">
 735     <td><code>&#8209;&#8209;structureimagewidth&nbsp;<em>number</em></code></td>
 736     <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).
 737     </td>
 738     <td></td>
 739     <td align="center">&#x2713;</td>
 740     </tr>
 741
 742     <tr valign="top">
 743     <td><code>&#8209;&#8209;structureimageheight&nbsp;<em>number</em></code></td>
 744     <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).
 745     </td>
 746     <td></td>
 747     <td align="center">&#x2713;</td>
 748     </tr>
 749
 750   </table>
 751
 752
 753   <h2><a name="controllingflowofarguments"></a>Controlling flow of arguments</h2>
 754
 755   <table border="1" cellpadding="3">
 756     <tr valign="top">
 757     <td><strong>argument</strong></td>
 758     <td><strong>action</strong></td>
 759     </tr>
 760
 761     <tr valign="top">
 762     <td><code>&#8209;&#8209;new</code></td>
 763     <td>
 764     Move on to a new alignment window.  This will ensure <code>&#8209;&#8209;append</code> will start a new alignment window and other linked arguments will apply to the new alignment window.
 765     <br/>
 766     <em>Note</em> that <code>--open</code> already starts a new alignment window for each file it opens.
 767     </td>
 768     </tr>
 769
 770     <tr valign="top">
 771     <td><code>&#8209;&#8209;substitutions / &#8209;&#8209;nosubstitutions</code></td>
 772     <td>The following argument values allow (or don't allow) subsituting filename parts.  This is initially true.  Valid substitutions are
 773     <code>{basename}</code> - the filename-without-extension of the currently <code>&#8209;&#8209;open</code>ed file (or first <code>&#8209;&#8209;append</code>ed file),
 774     <br/>
 775     <code>{dirname}</code>, - the directory (folder) name of the currently <code>&#8209;&#8209;open</code>ed file (or first <code>&#8209;&#8209;append</code>ed file),
 776     <br/>
 777     <code>{argfilebasename}</code> - the filename-without-extension of the current <code>&#8209;&#8209;argfile</code>,
 778     <br/>
 779     <code>{argfiledirname}</code> - the directory (folder) name of the current <code>&#8209;&#8209;argfile</code>,
 780     <br/>
 781     <code>{n}</code> - the value of the index counter (starting at 0).
 782     <br/>
 783     <code>{++n}</code> - increase and substitute the value of the index counter,
 784     <br/>
 785     <code>{}</code> - the value of the current alignment window <em>default</em> index.
 786     </td>
 787     </tr>
 788
 789     <tr valign="top">
 790     <td><code>&#8209;&#8209;argfile&nbsp;<em>filename</em></code></td>
 791     <td>
 792     Open one or more files <em>filename</em> and read, line-by-line, as arguments to Jalview.
 793     <br/>
 794     Values in an argfile should be given with an equals sign ("=") separator with no spaces.
 795     <br/>
 796     <strong>Note</strong> that if you use one or more <code>&#8209;&#8209;argfile</code> arguments then all other non-initialising arguments will be ignored.
 797     </td>
 798     </tr>
 799
 800     <tr valign="top">
 801     <td><code>&#8209;&#8209;npp</code></td>
 802     <td>Increase the index counter used in argument value substitutions.</td>
 803     </tr>
 804
 805     <tr valign="top">
 806     <td><code>&#8209;&#8209;all / &#8209;&#8209;noall</code></td>
 807     <td>Apply (or stop applying) the following output arguments to <em>all</em> sets of linked arguments.</td>
 808     </tr>
 809
 810     <tr valign="top">
 811     <td><code>&#8209;&#8209;allstructures / &#8209;&#8209;noallstructures</code></td>
 812     <td>
 813         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.
 814     </td>
 815     </tr>
 816
 817     <tr valign="top">
 818     <td><code>&#8209;&#8209;quit</code></td>
 819     <td>After all files have been opened, appended and output, quit Jalview.  In <code>&#8209;&#8209;headless</code> mode this already happens.</td>
 820     </tr>
 821
 822   </table>
 823
 824 </body>
 825 </html>