help/help/html/features/clarguments-intro.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 <title>Jalview Command Line Arguments: introduction</title>
  23 <body>
  24
  25   <h1>Jalview Command Line Arguments: introduction</h1>
  26
  27   <p>
  28   <a href="clarguments.html">Jalview Command Line Arguments: summary</a>
  29   <br/>
  30   Jalview Command Line Arguments: introduction
  31   <br/>
  32   <a href="clarguments-basic.html">Jalview Command Line Arguments: basic usage</a>
  33   <br/>
  34   <a href="clarguments-advanced.html">Jalview Command Line Arguments: advanced usage</a>
  35   <br/>
  36   <a href="clarguments-argfiles.html">Jalview Command Line Arguments: argfiles</a>
  37   </p>
  38
  39   <hr/>
  40
  41   <p>
  42   From version 2.11.3.0 Jalview processes a new set of command line arguments
  43   which allow more powerful and flexible combinations of arguments, though can
  44   also be used for very simple use cases too.
  45   </p>
  46
  47   <p>
  48   These new arguments are all accessed with a <code>--doubledash</code> form of
  49   command line argument (with the one exception where simply opening one or more
  50   files can be performed without any arguments other than the filenames).
  51   </p>
  52
  53   <p>
  54   The old command line arguments can still be used (see
  55   <a href="clarguments-old.html">the old page on command line arguments</a>) so
  56   existing scripts utilising them should not break.
  57   <br/>
  58   <strong>These are now deprecated and will be removed</strong> in a future version of Jalview.
  59   </p>
  60
  61   <p>
  62   However, you cannot mix old and new style arguments, so if you use any
  63   <code>-singledash</code> arguments (with the exception of <code>-help</code> or <code>-h</code>), they will all be interpreted as
  64   old style arguments with the new <code>--doubledash</code>
  65   arguments being ignored.  If you have a script
  66   that uses the old arguments without any dashes, and uses the bare-word
  67   <code>open</code> then these will also be interpreted as old style arguments.
  68   </p>
  69   <p>
  70   <strong>Warning!</strong> If you use command line arguments without any dashes and
  71   <em>don't</em> use the bare-word argument <code>open</code> then all
  72   your arguments will be interpreted as alignment files to be opened by the
  73   new command line argument process!
  74   </p>
  75
  76   <p>
  77   To launch Jalview from the command line, see
  78   <a href="commandline.html">running Jalview from the command line</a>.
  79   </p>
  80
  81   <hr/>
  82   Continue to <a href="clarguments-basic.html">Jalview Command Line Arguments: basic usage</a>.
  83   <br/>
  84   Return to <a href="clarguments.html">Jalview Command Line Arguments: summary</a>.
  85
  86
  87 </body>
  88 </html>