running jalview from the command line.
authorjprocter <Jim Procter>
Fri, 9 Feb 2007 18:02:17 +0000 (18:02 +0000)
committerjprocter <Jim Procter>
Fri, 9 Feb 2007 18:02:17 +0000 (18:02 +0000)
help/html/features/clarguments.html [new file with mode: 0644]
help/html/features/commandline.html [new file with mode: 0644]

diff --git a/help/html/features/clarguments.html b/help/html/features/clarguments.html
new file mode 100644 (file)
index 0000000..45dfab5
--- /dev/null
@@ -0,0 +1,82 @@
+<html>
+<title>Jalview Command Line Arguments
+</title>
+<body>
+ <p><strong>The Jalview Executable's Command Line
+ Arguments</strong></p>
+ See <a href="commandline.html">running Jalview from the command
+ line</a> for more information.<br>
+ <table width="100%" border="1" cellspacing="0" cellpadding="0">
+ <tr > 
+ <td width="27%"><div align="center">-nodisplay</div></td>
+ <td width="73%"><div align="left">Run Jalview without User Interface.</div></td>
+ </tr>
+
+ <tr> 
+ <td><div align="center">-props FILE</div></td>
+ <td><div align="left">Use the given Jalview properties file instead 
+ of users default.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-features FILE</div></td>
+ <td><div align="left"> 
+ <p>Use the given file to add sequence features to an alignment. 
+ See <a href="featuresFormat.html" target="NEW">Features 
+ File</a> (Known as Groups file prior to 2.08) description. </p>
+
+ </div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-annotations FILE</div></td>
+ <td>Add precalculated annotations to the alignment. See <a href="annotationsFormat.html" target="NEW">Annotation 
+ File</a> description.</td>
+ </tr>
+ <tr> 
+ <td><div align="center">-fasta FILE</div></td>
+
+ <td><div align="left">Create alignment file FILE in Fasta format.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-clustal FILE</div></td>
+ <td><div align="left">Create alignment file FILE in Clustal format.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-msf FILE</div></td>
+
+ <td><div align="left">Create alignment file FILE in MSF format.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-pileup FILE</div></td>
+ <td><div align="left">Create alignment file FILE in Pileup format.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-pir FILE</div></td>
+
+ <td><div align="left">Create alignment file FILE in PIR format.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-blc FILE</div></td>
+ <td><div align="left">Create alignment file FILE in BLC format.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-jalview FILE</div></td>
+
+ <td><div align="left">Create alignment file FILE in Jalview format.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-png FILE</div></td>
+ <td><div align="left">Create PNG image FILE from alignment.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-imgMap FILE</div></td>
+
+ <td><div align="left">Create HTML file FILE with image map of PNG 
+ image.</div></td>
+ </tr>
+ <tr> 
+ <td><div align="center">-eps FILE</div></td>
+ <td><div align="left">Create EPS file FILE from alignment.</div></td>
+ </tr>
+ </table>
+</body>
+</html>
diff --git a/help/html/features/commandline.html b/help/html/features/commandline.html
new file mode 100644 (file)
index 0000000..fadddce
--- /dev/null
@@ -0,0 +1,35 @@
+<html>\r
+<head><title>Running Jalview from the command line</title></head>\r
+<body>\r
+ <p><strong>Running Jalview from the command line</strong></p>\r
+ <p>Jalview is most easily run from the command line if you have built\r
+ it from source, or via the 'Jalview' executable created from the\r
+ InstallAnywhere jalview installation. Both of these mechanisms allow\r
+ true command line execution of jalview - allowing you to provide\r
+ additional options.</p><p>\r
+The Java Webstart version of\r
+ jalview can be executed from the command line using something like\r
+ :\r
+ <pre>javaws http://www.jalview.org/webstart/jalview.jnlp -open\r
+ <em>yourFileName</em></pre>\r
+ But, this is not guaranteed to work on all versions of webstart on all\r
+ operating systems, and doesn't let you execute Jalview with any\r
+ additional parameters.\r
+ <p><strong>Running jalview from the InstallAnywhere\r
+ installation</strong></p>\r
+ <p>If you install with InstallAnywhere you can use several more commands. \r
+ However, if you call the application with the link provided by InstallAnywhere \r
+ any output from the application will be sent to output.txt, not standard \r
+ out.<br>\r
+ The jalview application also requires a number of additional\r
+ libraries on the class path. The command line below adds the Jalview\r
+ installation's 'lib' directory to the list of directories that are\r
+ searched for jars to be added to the classpath:</p>\r
+<pre>java -Djava.ext.dirs=$INSTALL_DIR$/lib -cp $INSTALL_DIR$/jalview.jar jalview.bin.Jalview -open [FILE] </pre>\r
+ <p>Use '-help' to get more information on the <a\r
+ href="clarguments.html">command line arguments</a> that Jalview\r
+ accepts.</p>\r
+ <p>&nbsp;</p>\r
+ <p>&nbsp;</p>\r
+ </body>\r
+ </html>\r