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</code></td>
  69     <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.
  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>--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> include:
 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     <br/>
 297     <br/>
 298     Names of user defined schemes will also work, and jalview colour scheme specifications like:
 299     <br/>
 300         <code>&#8209;&#8209;colour "D,E=red; K,R,H=0022FF; C,c=yellow"</code>
 301     <td></td>
 302     <td align="center">&#x2713;</td>
 303     </tr>
 304
 305     <tr valign="top">
 306     <td><code>&#8209;&#8209;features&nbsp;<em>filename/URL</em></code></td>
 307     <td>Add a feature file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 308     <td></td>
 309     <td align="center">&#x2713;</td>
 310     </tr>
 311
 312
 313
 314     <tr valign="top">
 315     <td><code>&#8209;&#8209;tree&nbsp;<em>filename/URL</em></code></td>
 316     <td>Add a tree file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 317     <td></td>
 318     <td align="center">&#x2713;</td>
 319     </tr>
 320
 321     <tr valign="top">
 322     <td><code>&#8209;&#8209;sortbytree / &#8209;&#8209;nosortbytree</code></td>
 323     <td>Enforces sorting (or not sorting) the alignment in the order of an attached phylogenetic tree.</td>
 324     <td></td>
 325     <td align="center">&#x2713;</td>
 326     </tr>
 327
 328
 329     <tr valign="top">
 330     <td><code>&#8209;&#8209;annotations&nbsp;<em>filename/URL</em></code></td>
 331     <td>Add an annotations file <em>filename</em> or URL <em>URL</em> to the open alignment.</td>
 332     <td></td>
 333     <td align="center">&#x2713;</td>
 334     </tr>
 335
 336     <tr valign="top">
 337     <td><code>&#8209;&#8209;showannotations / &#8209;&#8209;noshowannotations</code></td>
 338     <td>Enforces showing (or not showing) alignment annotations.</td>
 339     <td></td>
 340     <td align="center">&#x2713;</td>
 341     </tr>
 342
 343     <tr valign="top">
 344     <td><code>&#8209;&#8209;wrap / &#8209;&#8209;nowrap</code></td>
 345     <td>Enforces wrapped (or not wrapped) alignment formatting.</td>
 346     <td></td>
 347     <td align="center">&#x2713;</td>
 348     </tr>
 349
 350     <tr valign="top">
 351     <td><code>&#8209;&#8209;nostructure</code></td>
 352     <td>Do not open or process any 3D structure in the <code>&#8209;&#8209;open</code> or <code>&#8209;&#8209;append</code> files.</td>
 353     <td></td>
 354     <td align="center">&#x2713;</td>
 355     </tr>
 356
 357   </table>
 358
 359
 360   <h2><a name="adding3dstructure"></a>Adding 3D structure</h2>
 361
 362   <table border="1" cellpadding="3">
 363     <tr valign="top">
 364     <td><strong>argument</strong></td>
 365     <td><strong>action</strong></td>
 366     <td><strong>sub-value modifiers</strong> (optional)</td>
 367     <td><strong>linked</strong> (optional)</td>
 368     </tr>
 369
 370     <tr valign="top">
 371     <td><code>&#8209;&#8209;structure&nbsp;<em>filename/URL</em></code></td>
 372     <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>
 373     <td>
 374       <code>
 375         seqid=<em>id</em></code> or <code><em>INDEX</em>,
 376         <br/>
 377         paefile=<em>filename</em>,
 378         <br/>
 379         tempfac=<em>name</em>,
 380         <br/>
 381         showssannotations,
 382         <!--
 383         <br/>
 384         notempfac,
 385         -->
 386         <br/>
 387         structureviewer=<em>name</em>
 388       </code></td>
 389     <td align="center">&#x2713;</td>
 390     </tr>
 391
 392
 393     <tr valign="top">
 394     <td><code>&#8209;&#8209;seqid&nbsp;<em>ID</em></code></td>
 395     <td>Specify the sequence name for the preceding <code>&#8209;&#8209;structure</code> to be associated with.</td>
 396     <td></td>
 397     <td align="center">&#x2713;</td>
 398     </tr>
 399
 400
 401     <tr valign="top">
 402     <td><code>&#8209;&#8209;paematrix&nbsp;<em>filename</em></code></td>
 403     <td>Add a PAE json matrix file <em>filename</em> to the preceding <code>&#8209;&#8209;structure</code>.</td>
 404     <td></td>
 405     <td align="center">&#x2713;</td>
 406     </tr>
 407
 408
 409     <tr valign="top">
 410     <td><code>&#8209;&#8209;tempfac&nbsp;<em>name</em></code></td>
 411     <td>Set the type of temperature factor.  Valid values for <em>name</em> are:
 412       <br/>
 413       <code>default</code>,
 414       <br/>
 415       <code>plddt</code>
 416     </td>
 417     <td></td>
 418     <td align="center">&#x2713;</td>
 419     </tr>
 420
 421
 422     <tr valign="top">
 423     <td><code>&#8209;&#8209;structureviewer&nbsp;<em>name</em></code></td>
 424     <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:
 425     <br/>
 426     <code>none</code>,
 427     <br/>
 428     <code>jmol</code>,
 429     <br/>
 430     <code>chimera</code> <em>- requires installation, might need configuring in Preferences</em>,
 431     <br/>
 432     <code>chimerax</code> <em>- requires installation, might need configuring in Preferences</em>,
 433     <br/>
 434     <code>pymol</code> <em>- requires installation, might need configuring in Preferences</em>
 435     </td>
 436     <td></td>
 437     <td align="center">&#x2713;</td>
 438     </tr>
 439
 440
 441     <!--
 442     <tr valign="top">
 443     <td><code>&#8209;&#8209;notempfac</code></td>
 444     <td>Do not show the temperature factor annotation for the preceding <code>&#8209;&#8209;structure</code></td>
 445     <td></td>
 446     <td align="center">&#x2713;</td>
 447     </tr>
 448     -->
 449
 450
 451     <tr valign="top">
 452     <td><code>&#8209;&#8209;showssannotations / &#8209;&#8209;noshowssannotations</code></td>
 453     <td>Do not show secondary structure annotations for the preceding <code>&#8209;&#8209;structure</code></td>
 454     <td></td>
 455     <td align="center">&#x2713;</td>
 456     </tr>
 457
 458     <tr valign="top">
 459     <td><code>&#8209;&#8209;close</code></td>
 460     <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>
 461     <td></td>
 462     <td align="center">&#x2713;</td>
 463     </tr>
 464
 465   </table>
 466
 467
 468   <h2><a name="processingalignments"></a>Processing alignments</h2>
 469
 470   <table border="1" cellpadding="3">
 471     <tr valign="top">
 472     <td><strong>argument</strong></td>
 473     <td><strong>action</strong></td>
 474     <td><strong>sub-value modifiers</strong> (optional)</td>
 475     <td><strong>linked</strong> (optional)</td>
 476     </tr>
 477
 478     <tr valign="top">
 479     <td><code>&#8209;&#8209;groovy&nbsp;<em>filename</em></code></td>
 480     <td>Process a groovy script in the file for the open alignment.</td>
 481     <td></td>
 482     <td align="center">&#x2713;</td>
 483     </tr>
 484   </table>
 485
 486
 487   <h2><a name="outputtingalignmentfiles"></a>Outputting alignment files</h2>
 488
 489   <table border="1" cellpadding="3">
 490     <tr valign="top">
 491     <td><strong>argument</strong></td>
 492     <td><strong>action</strong></td>
 493     <td><strong>sub-value modifiers</strong> (optional)</td>
 494     <td><strong>linked</strong> (optional)</td>
 495     </tr>
 496
 497     <tr valign="top">
 498     <td><code>&#8209;&#8209;output&nbsp;<em>filename</em></code></td>
 499     <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:
 500     <br/>
 501     <code>fasta</code> (<code>fa, fasta, mfa, fastq</code>),
 502     <br/>
 503     <code>pfam</code> (<code>pfam</code>),
 504     <br/>
 505     <code>stockholm</code> (<code>sto, stk</code>),
 506     <br/>
 507     <code>pir</code> (<code>pir</code>),
 508     <br/>
 509     <code>blc</code> (<code>blc</code>),
 510     <br/>
 511     <code>amsa</code> (<code>amsa</code>),
 512     <br/>
 513     <code>json</code> (<code>json</code>),
 514     <br/>
 515     <code>pileup</code> (<code>pileup</code>),
 516     <br/>
 517     <code>msf</code> (<code>msf</code>),
 518     <br/>
 519     <code>clustal</code> (<code>aln</code>),
 520     <br/>
 521     <code>phylip</code> (<code>phy</code>),
 522     <br/>
 523     <code>jalview</code> (<code>jvp, jar</code>).
 524     </td>
 525     <td><code>format=<em>name</em></code></td>
 526     <td align="center">&#x2713;</td>
 527     </tr>
 528
 529     <tr valign="top">
 530     <td><code>&#8209;&#8209;format&nbsp;<em>name</em></code></td>
 531     <td>Sets the format for the preceding <code>&#8209;&#8209;output</code> file.  Valid formats are:
 532     <br/>
 533     <code>fasta</code>,
 534     <br/>
 535     <code>pfam</code>,
 536     <br/>
 537     <code>stockholm</code>,
 538     <br/>
 539     <code>pir</code>,
 540     <br/>
 541     <code>blc</code>,
 542     <br/>
 543     <code>amsa</code>,
 544     <br/>
 545     <code>json</code>,
 546     <br/>
 547     <code>pileup</code>,
 548     <br/>
 549     <code>msf</code>,
 550     <br/>
 551     <code>clustal</code>,
 552     <br/>
 553     <code>phylip</code>,
 554     <br/>
 555     <code>jalview</code>.
 556     </td>
 557     <td></td>
 558     <td align="center">&#x2713;</td>
 559     </tr>
 560
 561     <tr valign="top">
 562     <td><code>&#8209;&#8209;backups / &#8209;&#8209;nobackups</code></td>
 563     <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>
 564     <td></td>
 565     <td align="center">&#x2713;</td>
 566     </tr>
 567
 568     <tr valign="top">
 569     <td><code>&#8209;&#8209;overwrite / &#8209;&#8209;nooverwrite</code></td>
 570     <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>
 571     <td></td>
 572     <td align="center">&#x2713;</td>
 573     </tr>
 574
 575   </table>
 576
 577
 578   <h2><a name="exportingimagefiles"></a>Exporting image files</h2>
 579
 580   <table border="1" cellpadding="3">
 581     <tr valign="top">
 582     <td><strong>argument</strong></td>
 583     <td><strong>action</strong></td>
 584     <td><strong>sub-value modifiers</strong> (optional)</td>
 585     <td><strong>linked</strong> (optional)</td>
 586     </tr>
 587
 588     <tr valign="top">
 589     <td><code>&#8209;&#8209;image&nbsp;<em>filename</em></code></td>
 590     <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:
 591     <br/>
 592     <code>svg</code>,
 593     <br/>
 594     <code>png</code>,
 595     <br/>
 596     <code>eps</code>,
 597     <br/>
 598     <code>html</code>,
 599     <br/>
 600     <code>biojs</code>.
 601     </td>
 602     <td>
 603       <code>type=<em>name</em>,
 604       <code>textrenderer=<em>name</em>,
 605       <code>scale=<em>number</em>,
 606       <code>width=<em>number</em>,
 607       <code>height=<em>number</em>
 608     </td>
 609     <td align="center">&#x2713;</td>
 610     </tr>
 611
 612     <tr valign="top">
 613     <td><code>&#8209;&#8209;type&nbsp;<em>name</em></code></td>
 614     <td>Set the image format for the preceding <code>&#8209;&#8209;image</code> to <em>name</em>.  Valid values for <em>name</em> are:
 615     <br/>
 616     <code>svg</code>,
 617     <br/>
 618     <code>png</code>,
 619     <br/>
 620     <code>eps</code>,
 621     <br/>
 622     <code>html</code>,
 623     <br/>
 624     <code>biojs</code>.
 625     </td>
 626     <td></td>
 627     <td align="center">&#x2713;</td>
 628     </tr>
 629
 630     <tr valign="top">
 631     <td><code>&#8209;&#8209;textrenderer&nbsp;<em>name</em></code></td>
 632     <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:
 633     <br/>
 634     <code>text</code>,
 635     <br/>
 636     <code>lineart</code>.
 637     </td>
 638     <td></td>
 639     <td align="center">&#x2713;</td>
 640     </tr>
 641
 642     <tr valign="top">
 643     <td><code>&#8209;&#8209;scale&nbsp;<em>number</em></code></td>
 644     <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).
 645     </td>
 646     <td></td>
 647     <td align="center">&#x2713;</td>
 648     </tr>
 649
 650     <tr valign="top">
 651     <td><code>&#8209;&#8209;width&nbsp;<em>number</em></code></td>
 652     <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).
 653     </td>
 654     <td></td>
 655     <td align="center">&#x2713;</td>
 656     </tr>
 657
 658     <tr valign="top">
 659     <td><code>&#8209;&#8209;height&nbsp;<em>number</em></code></td>
 660     <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>
 661     <td></td>
 662     <td align="center">&#x2713;</td>
 663     </tr>
 664
 665     <tr valign="top">
 666     <td><code>&#8209;&#8209;groovy&nbsp;<em>filename</em></code></td>
 667     <td>Process a groovy script in the file for the open alignment.</td>
 668     <td></td>
 669     <td align="center">&#x2713;</td>
 670     </tr>
 671
 672   </table>
 673
 674
 675   <h2><a name="exporting3dstructureimagefiles"></a>Exporting 3D structure image files (<code>jmol</code> only)</h2>
 676
 677   <table border="1" cellpadding="3">
 678     <tr valign="top">
 679     <td><strong>argument</strong></td>
 680     <td><strong>action</strong></td>
 681     <td><strong>sub-value modifiers</strong> (optional)</td>
 682     <td><strong>linked</strong> (optional)</td>
 683     </tr>
 684
 685     <tr valign="top">
 686     <td><code>&#8209;&#8209;structureimage&nbsp;<em>filename</em></code></td>
 687     <td>Export an image of a 3D structure opened in JMOL.  Image formats can be:
 688     <br/>
 689     <code>svg</code>,
 690     <br/>
 691     <code>png</code>,
 692     <br/>
 693     <code>eps</code>.
 694     </td>
 695     <td>
 696       <code>structureimagetype=<em>name</em>,
 697       <code>structureimagetextrenderer=<em>name</em>,
 698       <code>structureimagescale=<em>number</em>,
 699       <code>structureimagewidth=<em>number</em>,
 700       <code>structureimageheight=<em>number</em>
 701     </td>
 702     <td align="center">&#x2713;</td>
 703     </tr>
 704
 705     <tr valign="top">
 706     <td><code>&#8209;&#8209;structureimagetype&nbsp;<em>name</em></code></td>
 707     <td>Set the structure image format for the preceding --structureimage. Valid values are:
 708     <br/>
 709     <code>svg</code>,
 710     <br/>
 711     <code>png</code>,
 712     <br/>
 713     <code>eps</code>.
 714     </td>
 715     <td></td>
 716     <td align="center">&#x2713;</td>
 717     </tr>
 718
 719     <tr valign="top">
 720     <td><code>&#8209;&#8209;structureimagetextrenderer&nbsp;<em>name</em></code></td>
 721     <td>Sets whether text in a vector structure image format (SVG, EPS) should be rendered as text or vector line-art. Possible values are:
 722     <br/>
 723     <code>text</code>,
 724     <br/>
 725     <code>lineart</code>.
 726     </td>
 727     <td></td>
 728     <td align="center">&#x2713;</td>
 729     </tr>
 730
 731     <tr valign="top">
 732     <td><code>&#8209;&#8209;structureimagescale&nbsp;<em>number</em></code></td>
 733     <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).
 734     </td>
 735     <td></td>
 736     <td align="center">&#x2713;</td>
 737     </tr>
 738
 739     <tr valign="top">
 740     <td><code>&#8209;&#8209;structureimagewidth&nbsp;<em>number</em></code></td>
 741     <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).
 742     </td>
 743     <td></td>
 744     <td align="center">&#x2713;</td>
 745     </tr>
 746
 747     <tr valign="top">
 748     <td><code>&#8209;&#8209;structureimageheight&nbsp;<em>number</em></code></td>
 749     <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).
 750     </td>
 751     <td></td>
 752     <td align="center">&#x2713;</td>
 753     </tr>
 754
 755   </table>
 756
 757
 758   <h2><a name="controllingflowofarguments"></a>Controlling flow of arguments</h2>
 759
 760   <table border="1" cellpadding="3">
 761     <tr valign="top">
 762     <td><strong>argument</strong></td>
 763     <td><strong>action</strong></td>
 764     </tr>
 765
 766     <tr valign="top">
 767     <td><code>&#8209;&#8209;new</code></td>
 768     <td>
 769     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.
 770     <br/>
 771     <em>Note</em> that <code>--open</code> already starts a new alignment window for each file it opens.
 772     </td>
 773     </tr>
 774
 775     <tr valign="top">
 776     <td><code>&#8209;&#8209;substitutions / &#8209;&#8209;nosubstitutions</code></td>
 777     <td>The following argument values allow (or don't allow) subsituting filename parts.  This is initially true.  Valid substitutions are
 778     <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),
 779     <br/>
 780     <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),
 781     <br/>
 782     <code>{argfilebasename}</code> - the filename-without-extension of the current <code>&#8209;&#8209;argfile</code>,
 783     <br/>
 784     <code>{argfiledirname}</code> - the directory (folder) name of the current <code>&#8209;&#8209;argfile</code>,
 785     <br/>
 786     <code>{n}</code> - the value of the index counter (starting at 0).
 787     <br/>
 788     <code>{++n}</code> - increase and substitute the value of the index counter,
 789     <br/>
 790     <code>{}</code> - the value of the current alignment window <em>default</em> index.
 791     </td>
 792     </tr>
 793
 794     <tr valign="top">
 795     <td><code>&#8209;&#8209;argfile&nbsp;<em>filename</em></code></td>
 796     <td>
 797     Open one or more files <em>filename</em> and read, line-by-line, as arguments to Jalview.
 798     <br/>
 799     Values in an argfile should be given with an equals sign ("=") separator with no spaces.
 800     <br/>
 801     <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.
 802     </td>
 803     </tr>
 804
 805     <tr valign="top">
 806     <td><code>&#8209;&#8209;npp</code></td>
 807     <td>Increase the index counter used in argument value substitutions.</td>
 808     </tr>
 809
 810     <tr valign="top">
 811     <td><code>&#8209;&#8209;all / &#8209;&#8209;noall</code></td>
 812     <td>Apply (or stop applying) the following output arguments to <em>all</em> sets of linked arguments.</td>
 813     </tr>
 814
 815     <tr valign="top">
 816     <td><code>&#8209;&#8209;allstructures / &#8209;&#8209;noallstructures</code></td>
 817     <td>
 818         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.
 819     </td>
 820     </tr>
 821
 822     <tr valign="top">
 823     <td><code>&#8209;&#8209;quit</code></td>
 824     <td>After all files have been opened, appended and output, quit Jalview.  In <code>&#8209;&#8209;headless</code> mode this already happens.</td>
 825     </tr>
 826
 827   </table>
 828
 829 </body>
 830 </html>