vamsas 0.2 client capabilities
[jalview.git] / help / html / features / clarguments.html
1 <html>
2 <title>Jalview Command Line Arguments
3 </title>
4 <body>
5  <p><strong>The Jalview Executable's Command Line
6  Arguments</strong></p>
7  See <a href="commandline.html">running Jalview from the command
8  line</a> for more information.<br>
9  <table width="100%" border="1" cellspacing="0" cellpadding="0">
10  <tr > 
11  <td width="27%"><div align="center">-nodisplay</div></td>
12  <td width="73%"><div align="left">Run Jalview without User Interface. (automatically disables questionnaire, version and usage stats checks)</div></td>
13  </tr>
14
15  <tr> 
16  <td><div align="center">-props FILE</div></td>
17  <td><div align="left">Use the given Jalview properties file instead 
18  of users default.</div></td>
19  </tr>
20  <tr> 
21  <td><div align="center">-features FILE</div></td>
22  <td><div align="left"> 
23  <p>Use the given file to add sequence features to an alignment. 
24  See <a href="featuresFormat.html" target="NEW">Features 
25  File</a> (Known as Groups file prior to 2.08) description. </p>
26
27  </div></td>
28  </tr>
29         <tr>
30                 <td>
31                 <div align="center">-annotations FILE</div>
32                 </td>
33                 <td>Add precalculated annotations to the alignment. See <a
34                         href="annotationsFormat.html" target="NEW">Annotation File</a>
35                 description.</td>
36         </tr>
37         <tr>
38                 <td>
39                 <div align="center">-tree FILE</div>
40                 <td>
41                 <div align="left">Load the given newick format tree file onto
42                 the alignment</div>
43                 </td>
44         </tr>
45         <tr>
46                 <td>
47                 <div align="center">-questionnaire URL</div>
48                 <td>
49                 <div align="left">Queries the given URL for information about
50                 any Jalview user questionnaires</div>
51                 </td>
52         </tr>
53         <tr>
54                 <td>
55                 <div align="center">-noquestionnaire</div>
56                 <td>
57                 <div align="left">Turn off questionnaire check</div>
58                 </td>
59         </tr>
60         <tr><td>
61                 <div align="center">-nousagestats</div>
62                 <td>
63                 <div align="left">Turn off google analytics usage tracking</div>
64                 </td>
65         </tr>
66         <tr><td>
67         <div align="center">-[no]sortbytree</div>
68                 <td>
69                 <div align="left">Enable or disable automatic sorting of associated view when a new tree is displayed</div>
70                 </td>
71         </tr>
72         <tr>
73                 <td>
74                 <div align="center">-dasserver nickname=URL</div>
75                 <td>
76                 <div align="left">Add and enable a <a href="dassettings.html">DAS server</a> with given
77                 nickname (alphanumeric or underscores only) for retrieval of features
78                 for all alignments<br>
79                 Sources that also support the sequence command may be specified by prepending the URL with 'sequence:'<br>
80                 <em>e.g.</em> sequence:http://localdas.somewhere.org/das/source</div>
81                 </td>
82         </tr>
83         <tr>
84                 <td>
85                 <div align="center">-fetchfrom nickname</div>
86                 <td>
87                 <div align="left">Query a <a href="dassettings.html">DAS source</a> called nickname for features for the alignments
88                 and display them</div>
89                 </td>
90         </tr>
91         <tr>
92                 <td>
93                 <div align="center">-groovy FILE</div>
94                 <td>
95                 <div align="left">Execute groovy script in FILE (where FILE may be 'STDIN' to read from the standard input) after all other
96                 arguments have been processed</div>
97                 </td>
98         </tr>
99         <tr>
100         <td>
101                 <div align="center">-vdoc VAMSAS DOCUMENT FILE or URL</div>
102                 <td>
103                 <div align="left">Import the given vamsas document into a new session.<br><em>New in 2.5</em></div>
104                 </td>
105         </tr>
106         <tr>
107                 <td>
108                 <div align="center">-vsess VAMSAS SESSION URL</div>
109                 <td>
110                 <div align="left">Join the given vamsas session<br>If a document was also specified, this will be imported first and then committed as new data from Jalview to the specified session (Experimental - not yet enabled!).<em>New in 2.5</em></div></div>
111                 </td>
112         </tr>
113         <tr>
114                 <td>
115                 <div align="center">-groovy FILE</div>
116                 <td>
117                 <div align="left">Execute groovy script in FILE (where FILE may be 'STDIN' to read from the standard input) after all other
118                 arguments have been processed</div>
119                 </td>
120         </tr>
121         <tr>
122                 <td>
123                 <div align="center">-fasta FILE</div>
124                 </td>
125
126                 <td>
127                 <div align="left">Create alignment file FILE in Fasta format.</div>
128                 </td>
129         </tr>
130         <tr> 
131  <td><div align="center">-clustal FILE</div></td>
132  <td><div align="left">Create alignment file FILE in Clustal format.</div></td>
133  </tr>
134  <tr> 
135  <td><div align="center">-msf FILE</div></td>
136
137  <td><div align="left">Create alignment file FILE in MSF format.</div></td>
138  </tr>
139  <tr> 
140  <td><div align="center">-pileup FILE</div></td>
141  <td><div align="left">Create alignment file FILE in Pileup format.</div></td>
142  </tr>
143  <tr> 
144  <td><div align="center">-pir FILE</div></td>
145
146  <td><div align="left">Create alignment file FILE in PIR format.</div></td>
147  </tr>
148  <tr> 
149  <td><div align="center">-pfam FILE</div></td>
150  <td><div align="left">Create alignment file FILE in PFAM format.</div></td>
151  </tr>
152  <tr> 
153  <td><div align="center">-blc FILE</div></td>
154  <td><div align="left">Create alignment file FILE in BLC format.</div></td>
155  </tr>
156  <tr> 
157  <td><div align="center">-jalview FILE</div></td>
158
159  <td><div align="left">Create alignment file FILE in Jalview format.</div></td>
160  </tr>
161  <tr> 
162  <td><div align="center">-png FILE</div></td>
163  <td><div align="left">Create PNG image FILE from alignment.</div></td>
164  </tr>
165  <tr> 
166  <td><div align="center">-imgMap FILE</div></td>
167
168  <td><div align="left">Create HTML file FILE with image map of PNG 
169  image.</div></td>
170  </tr>
171  <tr> 
172  <td><div align="center">-eps FILE</div></td>
173  <td><div align="left">Create EPS file FILE from alignment.</div></td>
174  </tr>
175  </table>
176 </body>
177 </html>