help/help/html/features/clarguments.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</title>
  23 <body>
  24   <p>
  25     <strong>The Jalview Executable's Command Line Arguments</strong>
  26   </p>
  27   See
  28   <a href="commandline.html">running Jalview from the command line</a>
  29   for more information.
  30   <br />
  31   <br />Jalview processes arguments on the command line sequentially. If
  32   you would like to pass a <a href="jvlfiles.html">'JVL' file</a> containing
  33   <a href="../memory.html">memory settings</a> or any other launch
  34   parameters, then include it at the beginning of the command line to
  35   ensure they are processed before any remaining arguments.
  36   <br>
  37   Typical command line execution follows the following pattern:
  38   <pre>
  39   jalview -open &lt;Alignment File/URL&gt; [additional import arguments] [export arguments]
  40   </pre>
  41
  42   <table width="100%" border="1" cellspacing="0" cellpadding="0">
  43     <tr>
  44       <td width="27%"><div align="center">-nodisplay</div></td>
  45       <td width="73%"><div align="left">Run Jalview without
  46           User Interface. (automatically disables questionnaire, version
  47           and usage stats checks)</div></td>
  48     </tr>
  49     <tr>
  50       <td><div align="center">-open FILE/URL</div></td>
  51       <td><div align="left">Specify the alignment file to
  52           open or process by providing additional arguments.</div></td>
  53     </tr>
  54     <tr>
  55       <td><div align="center">-props FILE/URL</div></td>
  56       <td><div align="left">Use the given Jalview properties
  57           file instead of users default.</div></td>
  58     </tr>
  59     <tr>
  60       <td><div align="center">-features FILE/URL</div></td>
  61       <td><div align="left">
  62           <p>
  63             Use the given file to add sequence features to an alignment.
  64             See <a href="featuresFormat.html" target="NEW">Features
  65               File</a> (Known as Groups file prior to 2.08) description.
  66           </p>
  67
  68         </div></td>
  69     </tr>
  70     <tr>
  71       <td>
  72         <div align="center">-colour COLOURSCHEME</div>
  73       </td>
  74       <td>Set the colourscheme for the alignment. This can be any
  75         of the built-in colourschemes, a name of a predefined
  76         colourscheme (defined in the Jalview properties file), or an
  77         'inline' colourscheme (see the applet's colour parameter for
  78         more information).</td>
  79     </tr>
  80     <tr>
  81       <td>
  82         <div align="center">-annotations FILE/URL</div>
  83       </td>
  84       <td>Add precalculated annotations to the alignment. See <a
  85         href="annotationsFormat.html" target="NEW">Annotation
  86           File</a> description.
  87       </td>
  88     </tr>
  89     <tr>
  90       <td>
  91         <div align="center">-tree FILE/URL</div>
  92       <td>
  93         <div align="left">Load the given newick format tree file
  94           onto the alignment</div>
  95       </td>
  96     </tr>
  97     <tr>
  98       <td>
  99         <div align="center">-questionnaire URL</div>
 100       <td>
 101         <div align="left">Queries the given URL for information
 102           about any Jalview user questionnaires</div>
 103       </td>
 104     </tr>
 105     <tr>
 106       <td>
 107         <div align="center">-noquestionnaire</div>
 108       <td>
 109         <div align="left">Turn off questionnaire check</div>
 110       </td>
 111     </tr>
 112     <tr>
 113       <td>
 114         <div align="center">-nonews</div>
 115       <td>
 116         <div align="left">
 117           Disable check for <a href="../webServices/newsreader.html">Jalview
 118             news</a> on startup (not recommended other than for classroom /
 119           demo usage)
 120         </div>
 121       </td>
 122     </tr>
 123     <tr>
 124       <td>
 125         <div align="center">-nousagestats</div>
 126       <td>
 127         <div align="left">Turn off google analytics usage tracking</div>
 128       </td>
 129     </tr>
 130     <tr>
 131       <td>
 132         <div align="center">-[no]sortbytree</div>
 133       <td>
 134         <div align="left">Enable or disable automatic sorting of
 135           associated view when a new tree is displayed</div>
 136       </td>
 137     </tr>
 138     <tr>
 139       <td>
 140         <div align="center">-groovy FILE/URL</div>
 141       <td>
 142         <div align="left">Execute groovy script in FILE (where
 143           FILE may be 'STDIN' to read from the standard input) after all
 144           other arguments have been processed</div>
 145       </td>
 146     </tr>
 147     <tr>
 148       <td>
 149         <div align="center">-jabaws URL</div>
 150       <td>
 151         <div align="left">Specify the URL of the preferred JABAWS
 152           server</div>
 153       </td>
 154     </tr>
 155     <tr>
 156       <td>
 157         <div align="center">-fasta FILE</div>
 158       </td>
 159
 160       <td>
 161         <div align="left">Create alignment file FILE in Fasta
 162           format.</div>
 163       </td>
 164     </tr>
 165     <tr>
 166       <td><div align="center">-clustal FILE</div></td>
 167       <td><div align="left">Create alignment file FILE in
 168           Clustal format.</div></td>
 169     </tr>
 170     <tr>
 171       <td><div align="center">-msf FILE</div></td>
 172
 173       <td><div align="left">Create alignment file FILE in MSF
 174           format.</div></td>
 175     </tr>
 176     <tr>
 177       <td><div align="center">-pileup FILE</div></td>
 178       <td><div align="left">Create alignment file FILE in
 179           Pileup format.</div></td>
 180     </tr>
 181     <tr>
 182       <td><div align="center">-pir FILE</div></td>
 183
 184       <td><div align="left">Create alignment file FILE in PIR
 185           format.</div></td>
 186     </tr>
 187     <tr>
 188       <td><div align="center">-pfam FILE</div></td>
 189       <td><div align="left">Create alignment file FILE in
 190           PFAM format.</div></td>
 191     </tr>
 192     <tr>
 193       <td><div align="center">-blc FILE</div></td>
 194       <td><div align="left">Create alignment file FILE in BLC
 195           format.</div></td>
 196     </tr>
 197     <tr>
 198       <td><div align="center">-json FILE</div></td>
 199       <td><div align="left">Create alignment file FILE in
 200           JSON format.</div></td>
 201     </tr>
 202     <tr>
 203       <td><div align="center">-jalview FILE</div></td>
 204
 205       <td><div align="left">Create alignment file FILE in
 206           Jalview format.</div></td>
 207     </tr>
 208     <tr>
 209       <td><div align="center">-png FILE</div></td>
 210       <td><div align="left">Create PNG image FILE from
 211           alignment.</div></td>
 212     </tr>
 213     <tr>
 214       <td><div align="center">-imgMap FILE</div></td>
 215
 216       <td><div align="left">Create HTML file FILE with image
 217           map of PNG image.</div></td>
 218     </tr>
 219     <tr>
 220       <td><div align="center">-eps FILE</div></td>
 221       <td><div align="left">Create EPS file FILE from
 222           alignment.</div></td>
 223     </tr>
 224     <tr>
 225       <td><div align="center">-svg FILE</div></td>
 226       <td><div align="left">Create Scalable Vector Graphics
 227           file FILE from alignment.</div></td>
 228     </tr>
 229     <tr>
 230       <td><div align="center">-biojsMSA FILE</div></td>
 231       <td><div align="left">Write an HTML page to display
 232           the alignment with the <a href="biojsmsa.html">
 233           BioJS MSAviewer MSA</a>
 234           </div>
 235       </td>
 236     </tr>
 237   </table>
 238 </body>
 239 </html>