jalview 2.5 release banner
[jalview.git] / help / html / features / clarguments.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
4  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11  * 
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18 --!>
19 <title>Jalview Command Line Arguments
20 </title>
21 <body>
22  <p><strong>The Jalview Executable's Command Line
23  Arguments</strong></p>
24  See <a href="commandline.html">running Jalview from the command
25  line</a> for more information.<br>
26  <table width="100%" border="1" cellspacing="0" cellpadding="0">
27  <tr > 
28  <td width="27%"><div align="center">-nodisplay</div></td>
29  <td width="73%"><div align="left">Run Jalview without User Interface. (automatically disables questionnaire, version and usage stats checks)</div></td>
30  </tr>
31
32  <tr> 
33  <td><div align="center">-props FILE</div></td>
34  <td><div align="left">Use the given Jalview properties file instead 
35  of users default.</div></td>
36  </tr>
37  <tr> 
38  <td><div align="center">-features FILE</div></td>
39  <td><div align="left"> 
40  <p>Use the given file to add sequence features to an alignment. 
41  See <a href="featuresFormat.html" target="NEW">Features 
42  File</a> (Known as Groups file prior to 2.08) description. </p>
43
44  </div></td>
45  </tr>
46         <tr>
47                 <td>
48                 <div align="center">-annotations FILE</div>
49                 </td>
50                 <td>Add precalculated annotations to the alignment. See <a
51                         href="annotationsFormat.html" target="NEW">Annotation File</a>
52                 description.</td>
53         </tr>
54         <tr>
55                 <td>
56                 <div align="center">-tree FILE</div>
57                 <td>
58                 <div align="left">Load the given newick format tree file onto
59                 the alignment</div>
60                 </td>
61         </tr>
62         <tr>
63                 <td>
64                 <div align="center">-questionnaire URL</div>
65                 <td>
66                 <div align="left">Queries the given URL for information about
67                 any Jalview user questionnaires</div>
68                 </td>
69         </tr>
70         <tr>
71                 <td>
72                 <div align="center">-noquestionnaire</div>
73                 <td>
74                 <div align="left">Turn off questionnaire check</div>
75                 </td>
76         </tr>
77         <tr><td>
78                 <div align="center">-nousagestats</div>
79                 <td>
80                 <div align="left">Turn off google analytics usage tracking</div>
81                 </td>
82         </tr>
83         <tr><td>
84         <div align="center">-[no]sortbytree</div>
85                 <td>
86                 <div align="left">Enable or disable automatic sorting of associated view when a new tree is displayed</div>
87                 </td>
88         </tr>
89         <tr>
90                 <td>
91                 <div align="center">-dasserver nickname=URL</div>
92                 <td>
93                 <div align="left">Add and enable a <a href="dassettings.html">DAS server</a> with given
94                 nickname (alphanumeric or underscores only) for retrieval of features
95                 for all alignments<br>
96                 Sources that also support the sequence command may be specified by prepending the URL with 'sequence:'<br>
97                 <em>e.g.</em> sequence:http://localdas.somewhere.org/das/source</div>
98                 </td>
99         </tr>
100         <tr>
101                 <td>
102                 <div align="center">-fetchfrom nickname</div>
103                 <td>
104                 <div align="left">Query a <a href="dassettings.html">DAS source</a> called nickname for features for the alignments
105                 and display them</div>
106                 </td>
107         </tr>
108         <tr>
109                 <td>
110                 <div align="center">-groovy FILE</div>
111                 <td>
112                 <div align="left">Execute groovy script in FILE (where FILE may be 'STDIN' to read from the standard input) after all other
113                 arguments have been processed</div>
114                 </td>
115         </tr>
116         <tr>
117         <td>
118                 <div align="center">-vdoc VAMSAS DOCUMENT FILE or URL</div>
119                 <td>
120                 <div align="left">Import the given vamsas document into a new session.<br><em>New in 2.5</em></div>
121                 </td>
122         </tr>
123         <tr>
124                 <td>
125                 <div align="center">-vsess VAMSAS SESSION URL</div>
126                 <td>
127                 <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>
128                 </td>
129         </tr>
130         <tr>
131                 <td>
132                 <div align="center">-groovy FILE</div>
133                 <td>
134                 <div align="left">Execute groovy script in FILE (where FILE may be 'STDIN' to read from the standard input) after all other
135                 arguments have been processed</div>
136                 </td>
137         </tr>
138         <tr>
139                 <td>
140                 <div align="center">-fasta FILE</div>
141                 </td>
142
143                 <td>
144                 <div align="left">Create alignment file FILE in Fasta format.</div>
145                 </td>
146         </tr>
147         <tr> 
148  <td><div align="center">-clustal FILE</div></td>
149  <td><div align="left">Create alignment file FILE in Clustal format.</div></td>
150  </tr>
151  <tr> 
152  <td><div align="center">-msf FILE</div></td>
153
154  <td><div align="left">Create alignment file FILE in MSF format.</div></td>
155  </tr>
156  <tr> 
157  <td><div align="center">-pileup FILE</div></td>
158  <td><div align="left">Create alignment file FILE in Pileup format.</div></td>
159  </tr>
160  <tr> 
161  <td><div align="center">-pir FILE</div></td>
162
163  <td><div align="left">Create alignment file FILE in PIR format.</div></td>
164  </tr>
165  <tr> 
166  <td><div align="center">-pfam FILE</div></td>
167  <td><div align="left">Create alignment file FILE in PFAM format.</div></td>
168  </tr>
169  <tr> 
170  <td><div align="center">-blc FILE</div></td>
171  <td><div align="left">Create alignment file FILE in BLC format.</div></td>
172  </tr>
173  <tr> 
174  <td><div align="center">-jalview FILE</div></td>
175
176  <td><div align="left">Create alignment file FILE in Jalview format.</div></td>
177  </tr>
178  <tr> 
179  <td><div align="center">-png FILE</div></td>
180  <td><div align="left">Create PNG image FILE from alignment.</div></td>
181  </tr>
182  <tr> 
183  <td><div align="center">-imgMap FILE</div></td>
184
185  <td><div align="left">Create HTML file FILE with image map of PNG 
186  image.</div></td>
187  </tr>
188  <tr> 
189  <td><div align="center">-eps FILE</div></td>
190  <td><div align="left">Create EPS file FILE from alignment.</div></td>
191  </tr>
192  </table>
193 </body>
194 </html>