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