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