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"
  71       >Annotation 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">Disable check for <a href="../webServices/newsreader.html">Jalview news</a> on startup (not recommended other than for classroom / demo usage)</div>
 102       </td>
 103     </tr>
 104     <tr>
 105       <td>
 106         <div align="center">-nousagestats</div>
 107       <td>
 108         <div align="left">Turn off google analytics usage tracking</div>
 109       </td>
 110     </tr>
 111     <tr>
 112       <td>
 113         <div align="center">-[no]sortbytree</div>
 114       <td>
 115         <div align="left">Enable or disable automatic sorting of
 116           associated view when a new tree is displayed</div>
 117       </td>
 118     </tr>
 119     <tr>
 120       <td>
 121         <div align="center">-dasserver nickname=URL</div>
 122       <td>
 123         <div align="left">
 124           Add and enable a <a href="dassettings.html">DAS server</a>
 125           with given nickname (alphanumeric or underscores only) for
 126           retrieval of features for all alignments<br> Sources that
 127           also support the sequence command may be specified by
 128           prepending the URL with 'sequence:'<br> <em>e.g.</em>
 129           sequence:http://localdas.somewhere.org/das/source
 130         </div>
 131       </td>
 132     </tr>
 133     <tr>
 134       <td>
 135         <div align="center">-fetchfrom nickname</div>
 136       <td>
 137         <div align="left">
 138           Query a <a href="dassettings.html">DAS source</a> called
 139           nickname for features for the alignments and display them
 140         </div>
 141       </td>
 142     </tr>
 143     <tr>
 144       <td>
 145         <div align="center">-groovy FILE/URL</div>
 146       <td>
 147         <div align="left">Execute groovy script in FILE (where
 148           FILE may be 'STDIN' to read from the standard input) after all
 149           other arguments have been processed</div>
 150       </td>
 151     </tr>
 152     <tr>
 153       <td>
 154         <div align="center">-jabaws URL</div>
 155       <td>
 156         <div align="left">Specify the URL of the preferred JABAWS
 157           server</div>
 158       </td>
 159     </tr>
 160     <tr>
 161       <td>
 162         <div align="center">-vdoc VAMSAS DOCUMENT FILE/URL</div>
 163       <td>
 164         <div align="left">
 165           Import the given vamsas document into a new session.<br>
 166           <em>New in 2.5</em>
 167         </div>
 168       </td>
 169     </tr>
 170     <tr>
 171       <td>
 172         <div align="center">-vsess VAMSAS SESSION URL</div>
 173       <td>
 174         <div align="left">
 175           Join the given vamsas session<br>If a document was also
 176           specified, this will be imported first and then committed as
 177           new data from Jalview to the specified session (Experimental -
 178           not yet enabled!).<em>New in 2.5</em>
 179         </div>
 180         </div>
 181       </td>
 182     </tr>
 183     <tr>
 184       <td>
 185         <div align="center">-fasta FILE</div>
 186       </td>
 187
 188       <td>
 189         <div align="left">Create alignment file FILE in Fasta
 190           format.</div>
 191       </td>
 192     </tr>
 193     <tr>
 194       <td><div align="center">-clustal FILE</div></td>
 195       <td><div align="left">Create alignment file FILE in
 196           Clustal format.</div></td>
 197     </tr>
 198     <tr>
 199       <td><div align="center">-msf FILE</div></td>
 200
 201       <td><div align="left">Create alignment file FILE in MSF
 202           format.</div></td>
 203     </tr>
 204     <tr>
 205       <td><div align="center">-pileup FILE</div></td>
 206       <td><div align="left">Create alignment file FILE in
 207           Pileup format.</div></td>
 208     </tr>
 209     <tr>
 210       <td><div align="center">-pir FILE</div></td>
 211
 212       <td><div align="left">Create alignment file FILE in PIR
 213           format.</div></td>
 214     </tr>
 215     <tr>
 216       <td><div align="center">-pfam FILE</div></td>
 217       <td><div align="left">Create alignment file FILE in
 218           PFAM format.</div></td>
 219     </tr>
 220     <tr>
 221       <td><div align="center">-blc FILE</div></td>
 222       <td><div align="left">Create alignment file FILE in BLC
 223           format.</div></td>
 224     </tr>
 225     <tr>
 226       <td><div align="center">-json FILE</div></td>
 227       <td><div align="left">Create alignment file FILE in
 228           JSON format.</div></td>
 229     </tr>
 230     <tr>
 231       <td><div align="center">-jalview FILE</div></td>
 232
 233       <td><div align="left">Create alignment file FILE in
 234           Jalview format.</div></td>
 235     </tr>
 236     <tr>
 237       <td><div align="center">-png FILE</div></td>
 238       <td><div align="left">Create PNG image FILE from
 239           alignment.</div></td>
 240     </tr>
 241     <tr>
 242       <td><div align="center">-imgMap FILE</div></td>
 243
 244       <td><div align="left">Create HTML file FILE with image
 245           map of PNG image.</div></td>
 246     </tr>
 247     <tr>
 248       <td><div align="center">-eps FILE</div></td>
 249       <td><div align="left">Create EPS file FILE from
 250           alignment.</div></td>
 251     </tr>
 252     <tr>
 253       <td><div align="center">-svg FILE</div></td>
 254       <td><div align="left">Create Scalable Vector Graphics
 255           file FILE from alignment.</div></td>
 256     </tr>
 257   </table>
 258 </body>
 259 </html>