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