update author list in license for (JAL-826)
[jalview.git] / help / html / features / clarguments.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
4  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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/URL</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/URL</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>
45                 </td>
46         </tr>
47         <tr>
48                 <td>
49                 <div align="center">-colour COLOURSCHEME</div>
50                 </td>
51                 <td>Set the colourscheme for the alignment. This can be any of
52                 the built-in colourschemes, a name of a predefined colourscheme
53                 (defined in the jalview properties file), or an 'inline' colourscheme
54                 (see the applet's colour parameter for more information).</td>
55  </tr>
56         <tr>
57                 <td>
58                 <div align="center">-annotations FILE/URL</div>
59                 </td>
60                 <td>Add precalculated annotations to the alignment. See <a
61                         href="annotationsFormat.html" target="NEW">Annotation File</a>
62                 description.</td>
63         </tr>
64         <tr>
65                 <td>
66                 <div align="center">-tree FILE/URL</div>
67                 <td>
68                 <div align="left">Load the given newick format tree file onto
69                 the alignment</div>
70                 </td>
71         </tr>
72         <tr>
73                 <td>
74                 <div align="center">-questionnaire URL</div>
75                 <td>
76                 <div align="left">Queries the given URL for information about
77                 any Jalview user questionnaires</div>
78                 </td>
79         </tr>
80         <tr>
81                 <td>
82                 <div align="center">-noquestionnaire</div>
83                 <td>
84                 <div align="left">Turn off questionnaire check</div>
85                 </td>
86         </tr>
87         <tr><td>
88                 <div align="center">-nousagestats</div>
89                 <td>
90                 <div align="left">Turn off google analytics usage tracking</div>
91                 </td>
92         </tr>
93         <tr><td>
94         <div align="center">-[no]sortbytree</div>
95                 <td>
96                 <div align="left">Enable or disable automatic sorting of associated view when a new tree is displayed</div>
97                 </td>
98         </tr>
99         <tr>
100                 <td>
101                 <div align="center">-dasserver nickname=URL</div>
102                 <td>
103                 <div align="left">Add and enable a <a href="dassettings.html">DAS server</a> with given
104                 nickname (alphanumeric or underscores only) for retrieval of features
105                 for all alignments<br>
106                 Sources that also support the sequence command may be specified by prepending the URL with 'sequence:'<br>
107                 <em>e.g.</em> sequence:http://localdas.somewhere.org/das/source</div>
108                 </td>
109         </tr>
110         <tr>
111                 <td>
112                 <div align="center">-fetchfrom nickname</div>
113                 <td>
114                 <div align="left">Query a <a href="dassettings.html">DAS source</a> called nickname for features for the alignments
115                 and display them</div>
116                 </td>
117         </tr>
118         <tr>
119                 <td>
120                 <div align="center">-groovy FILE/URL</div>
121                 <td>
122                 <div align="left">Execute groovy script in FILE (where FILE may be 'STDIN' to read from the standard input) after all other
123                 arguments have been processed</div>
124                 </td>
125         </tr>
126         <tr>
127         <td>
128                 <div align="center">-vdoc VAMSAS DOCUMENT FILE/URL</div>
129                 <td>
130                 <div align="left">Import the given vamsas document into a new session.<br><em>New in 2.5</em></div>
131                 </td>
132         </tr>
133         <tr>
134                 <td>
135                 <div align="center">-vsess VAMSAS SESSION URL</div>
136                 <td>
137                 <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>
138                 </td>
139         </tr>
140         <tr>
141                 <td>
142                 <div align="center">-fasta FILE</div>
143                 </td>
144
145                 <td>
146                 <div align="left">Create alignment file FILE in Fasta format.</div>
147                 </td>
148         </tr>
149         <tr> 
150  <td><div align="center">-clustal FILE</div></td>
151  <td><div align="left">Create alignment file FILE in Clustal format.</div></td>
152  </tr>
153  <tr> 
154  <td><div align="center">-msf FILE</div></td>
155
156  <td><div align="left">Create alignment file FILE in MSF format.</div></td>
157  </tr>
158  <tr> 
159  <td><div align="center">-pileup FILE</div></td>
160  <td><div align="left">Create alignment file FILE in Pileup format.</div></td>
161  </tr>
162  <tr> 
163  <td><div align="center">-pir FILE</div></td>
164
165  <td><div align="left">Create alignment file FILE in PIR format.</div></td>
166  </tr>
167  <tr> 
168  <td><div align="center">-pfam FILE</div></td>
169  <td><div align="left">Create alignment file FILE in PFAM format.</div></td>
170  </tr>
171  <tr> 
172  <td><div align="center">-blc FILE</div></td>
173  <td><div align="left">Create alignment file FILE in BLC format.</div></td>
174  </tr>
175  <tr> 
176  <td><div align="center">-jalview FILE</div></td>
177
178  <td><div align="left">Create alignment file FILE in Jalview format.</div></td>
179  </tr>
180  <tr> 
181  <td><div align="center">-png FILE</div></td>
182  <td><div align="left">Create PNG image FILE from alignment.</div></td>
183  </tr>
184  <tr> 
185  <td><div align="center">-imgMap FILE</div></td>
186
187  <td><div align="left">Create HTML file FILE with image map of PNG 
188  image.</div></td>
189  </tr>
190  <tr> 
191  <td><div align="center">-eps FILE</div></td>
192  <td><div align="left">Create EPS file FILE from alignment.</div></td>
193  </tr>
194  </table>
195 </body>
196 </html>