help/html/features/commandline.html

   1 #-------------------------------------------------------------------------------
   2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)
   3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   4 #
   5 # This file is part of Jalview.
   6 #
   7 # Jalview is free software: you can redistribute it and/or
   8 # modify it under the terms of the GNU General Public License
   9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10 #
  11 # Jalview is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty
  13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14 # PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17 #-------------------------------------------------------------------------------
  18 <html>
  19 <!--
  20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
  21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  22  *
  23  * This file is part of Jalview.
  24  *
  25  * Jalview is free software: you can redistribute it and/or
  26  * modify it under the terms of the GNU General Public License
  27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  28  *
  29  * Jalview is distributed in the hope that it will be useful, but
  30  * WITHOUT ANY WARRANTY; without even the implied warranty
  31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  32  * PURPOSE.  See the GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  35 -->
  36 <head><title>Running Jalview from the command line</title></head>
  37 <body>
  38  <p><strong>Running Jalview from the command line</strong></p>
  39  <p>Jalview is most easily run from the command line if you have built
  40  it from source, or via the 'Jalview' executable created from the
  41  InstallAnywhere jalview installation. Both of these mechanisms allow
  42  true command line execution of jalview - allowing you to provide
  43  additional options.</p><p>
  44 The Java Webstart version of
  45  jalview can be executed from the command line using something like
  46  :
  47  <pre>javaws http://www.jalview.org/webstart/jalview.jnlp -open
  48  <em>yourFileName</em></pre>
  49  But, this is not guaranteed to work on all versions of webstart on all
  50  operating systems, and doesn't let you execute Jalview with any
  51  additional parameters.
  52  <p><strong>Running jalview from the InstallAnywhere
  53  installation</strong></p>
  54  <p>If you install with InstallAnywhere you can use several more commands.
  55  However, if you call the application with the link provided by InstallAnywhere
  56  any output from the application will be sent to output.txt, not standard
  57  out.<br>
  58  The jalview application also requires a number of additional
  59  libraries on the class path. The command line below adds the Jalview
  60  installation's 'lib' directory to the list of directories that are
  61  searched for jars to be added to the classpath:</p>
  62 <pre>java -Djava.ext.dirs=$INSTALL_DIR$/lib -cp $INSTALL_DIR$/jalview.jar jalview.bin.Jalview -open [FILE] </pre>
  63  <p>Use '-help' to get more information on the <a
  64  href="clarguments.html">command line arguments</a> that Jalview
  65  accepts.</p>
  66  <p>&nbsp;</p>
  67  <p>&nbsp;</p>
  68  </body>
  69  </html>