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