update author list in license for (JAL-826)
[jalview.git] / help / html / features / commandline.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 <head><title>Running Jalview from the command line</title></head>
20 <body>
21  <p><strong>Running Jalview from the command line</strong></p>
22  <p>Jalview is most easily run from the command line if you have built
23  it from source, or via the 'Jalview' executable created from the
24  InstallAnywhere jalview installation. Both of these mechanisms allow
25  true command line execution of jalview - allowing you to provide
26  additional options.</p><p>
27 The Java Webstart version of
28  jalview can be executed from the command line using something like
29  :
30  <pre>javaws http://www.jalview.org/webstart/jalview.jnlp -open
31  <em>yourFileName</em></pre>
32  But, this is not guaranteed to work on all versions of webstart on all
33  operating systems, and doesn't let you execute Jalview with any
34  additional parameters.
35  <p><strong>Running jalview from the InstallAnywhere
36  installation</strong></p>
37  <p>If you install with InstallAnywhere you can use several more commands. 
38  However, if you call the application with the link provided by InstallAnywhere 
39  any output from the application will be sent to output.txt, not standard 
40  out.<br>
41  The jalview application also requires a number of additional
42  libraries on the class path. The command line below adds the Jalview
43  installation's 'lib' directory to the list of directories that are
44  searched for jars to be added to the classpath:</p>
45 <pre>java -Djava.ext.dirs=$INSTALL_DIR$/lib -cp $INSTALL_DIR$/jalview.jar jalview.bin.Jalview -open [FILE] </pre>
46  <p>Use '-help' to get more information on the <a
47  href="clarguments.html">command line arguments</a> that Jalview
48  accepts.</p>
49  <p>&nbsp;</p>
50  <p>&nbsp;</p>
51  </body>
52  </html>