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