help/html/features/commandline.html

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