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   <table width="100%" border="1" cellspacing="0" cellpadding="0">
  32     <tr>
  33       <td width="27%"><div align="center">-nodisplay</div></td>
  34       <td width="73%"><div align="left">Run Jalview without
  35           User Interface. (automatically disables questionnaire, version
  36           and usage stats checks)</div></td>
  37     </tr>
  38
  39     <tr>
  40       <td><div align="center">-props FILE/URL</div></td>
  41       <td><div align="left">Use the given Jalview properties
  42           file instead of users default.</div></td>
  43     </tr>
  44     <tr>
  45       <td><div align="center">-features FILE/URL</div></td>
  46       <td><div align="left">
  47           <p>
  48             Use the given file to add sequence features to an alignment.
  49             See <a href="featuresFormat.html" target="NEW">Features
  50               File</a> (Known as Groups file prior to 2.08) description.
  51           </p>
  52
  53         </div></td>
  54     </tr>
  55     <tr>
  56       <td>
  57         <div align="center">-colour COLOURSCHEME</div>
  58       </td>
  59       <td>Set the colourscheme for the alignment. This can be any
  60         of the built-in colourschemes, a name of a predefined
  61         colourscheme (defined in the Jalview properties file), or an
  62         'inline' colourscheme (see the applet's colour parameter for
  63         more information).</td>
  64     </tr>
  65     <tr>
  66       <td>
  67         <div align="center">-annotations FILE/URL</div>
  68       </td>
  69       <td>Add precalculated annotations to the alignment. See <a
  70         href="annotationsFormat.html" target="NEW">Annotation
  71           File</a> description.
  72       </td>
  73     </tr>
  74     <tr>
  75       <td>
  76         <div align="center">-tree FILE/URL</div>
  77       <td>
  78         <div align="left">Load the given newick format tree file
  79           onto the alignment</div>
  80       </td>
  81     </tr>
  82     <tr>
  83       <td>
  84         <div align="center">-questionnaire URL</div>
  85       <td>
  86         <div align="left">Queries the given URL for information
  87           about any Jalview user questionnaires</div>
  88       </td>
  89     </tr>
  90     <tr>
  91       <td>
  92         <div align="center">-noquestionnaire</div>
  93       <td>
  94         <div align="left">Turn off questionnaire check</div>
  95       </td>
  96     </tr>
  97     <tr>
  98       <td>
  99         <div align="center">-nonews</div>
 100       <td>
 101         <div align="left">
 102           Disable check for <a href="../webServices/newsreader.html">Jalview
 103             news</a> on startup (not recommended other than for classroom /
 104           demo usage)
 105         </div>
 106       </td>
 107     </tr>
 108     <tr>
 109       <td>
 110         <div align="center">-nousagestats</div>
 111       <td>
 112         <div align="left">Turn off google analytics usage tracking</div>
 113       </td>
 114     </tr>
 115     <tr>
 116       <td>
 117         <div align="center">-[no]sortbytree</div>
 118       <td>
 119         <div align="left">Enable or disable automatic sorting of
 120           associated view when a new tree is displayed</div>
 121       </td>
 122     </tr>
 123     <tr>
 124       <td>
 125         <div align="center">-dasserver nickname=URL</div>
 126       <td>
 127         <div align="left">
 128           Add and enable a <a href="dassettings.html">DAS server</a>
 129           with given nickname (alphanumeric or underscores only) for
 130           retrieval of features for all alignments<br> Sources that
 131           also support the sequence command may be specified by
 132           prepending the URL with 'sequence:'<br> <em>e.g.</em>
 133           sequence:http://localdas.somewhere.org/das/source
 134         </div>
 135       </td>
 136     </tr>
 137     <tr>
 138       <td>
 139         <div align="center">-fetchfrom nickname</div>
 140       <td>
 141         <div align="left">
 142           Query a <a href="dassettings.html">DAS source</a> called
 143           nickname for features for the alignments and display them
 144         </div>
 145       </td>
 146     </tr>
 147     <tr>
 148       <td>
 149         <div align="center">-groovy FILE/URL</div>
 150       <td>
 151         <div align="left">Execute groovy script in FILE (where
 152           FILE may be 'STDIN' to read from the standard input) after all
 153           other arguments have been processed</div>
 154       </td>
 155     </tr>
 156     <tr>
 157       <td>
 158         <div align="center">-jabaws URL</div>
 159       <td>
 160         <div align="left">Specify the URL of the preferred JABAWS
 161           server</div>
 162       </td>
 163     </tr>
 164     <tr>
 165       <td>
 166         <div align="center">-vdoc VAMSAS DOCUMENT FILE/URL</div>
 167       <td>
 168         <div align="left">
 169           Import the given vamsas document into a new session.<br>
 170           <em>New in 2.5</em>
 171         </div>
 172       </td>
 173     </tr>
 174     <tr>
 175       <td>
 176         <div align="center">-vsess VAMSAS SESSION URL</div>
 177       <td>
 178         <div align="left">
 179           Join the given vamsas session<br>If a document was also
 180           specified, this will be imported first and then committed as
 181           new data from Jalview to the specified session (Experimental -
 182           not yet enabled!).<em>New in 2.5</em>
 183         </div>
 184         </div>
 185       </td>
 186     </tr>
 187     <tr>
 188       <td>
 189         <div align="center">-fasta FILE</div>
 190       </td>
 191
 192       <td>
 193         <div align="left">Create alignment file FILE in Fasta
 194           format.</div>
 195       </td>
 196     </tr>
 197     <tr>
 198       <td><div align="center">-clustal FILE</div></td>
 199       <td><div align="left">Create alignment file FILE in
 200           Clustal format.</div></td>
 201     </tr>
 202     <tr>
 203       <td><div align="center">-msf FILE</div></td>
 204
 205       <td><div align="left">Create alignment file FILE in MSF
 206           format.</div></td>
 207     </tr>
 208     <tr>
 209       <td><div align="center">-pileup FILE</div></td>
 210       <td><div align="left">Create alignment file FILE in
 211           Pileup format.</div></td>
 212     </tr>
 213     <tr>
 214       <td><div align="center">-pir FILE</div></td>
 215
 216       <td><div align="left">Create alignment file FILE in PIR
 217           format.</div></td>
 218     </tr>
 219     <tr>
 220       <td><div align="center">-pfam FILE</div></td>
 221       <td><div align="left">Create alignment file FILE in
 222           PFAM format.</div></td>
 223     </tr>
 224     <tr>
 225       <td><div align="center">-blc FILE</div></td>
 226       <td><div align="left">Create alignment file FILE in BLC
 227           format.</div></td>
 228     </tr>
 229     <tr>
 230       <td><div align="center">-json FILE</div></td>
 231       <td><div align="left">Create alignment file FILE in
 232           JSON format.</div></td>
 233     </tr>
 234     <tr>
 235       <td><div align="center">-jalview FILE</div></td>
 236
 237       <td><div align="left">Create alignment file FILE in
 238           Jalview format.</div></td>
 239     </tr>
 240     <tr>
 241       <td><div align="center">-png FILE</div></td>
 242       <td><div align="left">Create PNG image FILE from
 243           alignment.</div></td>
 244     </tr>
 245     <tr>
 246       <td><div align="center">-imgMap FILE</div></td>
 247
 248       <td><div align="left">Create HTML file FILE with image
 249           map of PNG image.</div></td>
 250     </tr>
 251     <tr>
 252       <td><div align="center">-eps FILE</div></td>
 253       <td><div align="left">Create EPS file FILE from
 254           alignment.</div></td>
 255     </tr>
 256     <tr>
 257       <td><div align="center">-svg FILE</div></td>
 258       <td><div align="left">Create Scalable Vector Graphics
 259           file FILE from alignment.</div></td>
 260     </tr>
 261     <tr>
 262       <td><div align="center">-biojsMSA FILE</div></td>
 263       <td><div align="left">Write an HTML page to display
 264           the alignment with the <a href="biojsmsa.html">
 265           BioJS MSAviewer MSA</a>
 266           </div>
 267       </td>
 268     </tr>
 269   </table>
 270 </body>
 271 </html>