help/html/features/commandline.html

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