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