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