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