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