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