utils/jalopy/docs/plugin-console.html

   1
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
   4  * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  20   <html><head>
  21       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  22    <title>Chapter&nbsp;6.&nbsp;Console Application</title><link rel="stylesheet" href="site.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="manual.html" title="Jalopy User Manual"><link rel="up" href="part-plugins.html" title="Part&nbsp;II.&nbsp;Plug-ins"><link rel="previous" href="plugin-ant-license.html" title="5.4.&nbsp;License"><link rel="next" href="plugin-console-usage.html" title="6.2.&nbsp;Usage"><link rel="preface" href="dedication.html" title="Dedication"><link rel="preface" href="acknowledge.html" title="Acknowledgements"><link rel="preface" href="introduction.html" title="Introduction"><link rel="part" href="part-core.html" title="Part&nbsp;I.&nbsp;Jalopy core"><link rel="chapter" href="installation.html" title="Chapter&nbsp;1.&nbsp;Installation"><link rel="chapter" href="build.html" title="Chapter&nbsp;2.&nbsp;Building"><link rel="chapter" href="usage.html" title="Chapter&nbsp;3.&nbsp;Usage"><link rel="chapter" href="settings.html" title="Chapter&nbsp;4.&nbsp;Settings"><link rel="part" href="part-plugins.html" title="Part&nbsp;II.&nbsp;Plug-ins"><link rel="chapter" href="plugin-ant.html" title="Chapter&nbsp;5.&nbsp;Ant Plug-in task"><link rel="chapter" href="plugin-console.html" title="Chapter&nbsp;6.&nbsp;Console Application"><link rel="chapter" href="plugin-eclipse.html" title="Chapter&nbsp;7.&nbsp;Eclipse Plug-in"><link rel="chapter" href="plugin-jbuilder.html" title="Chapter&nbsp;8.&nbsp;JBuilder OpenTool"><link rel="chapter" href="plugin-jdev.html" title="Chapter&nbsp;9.&nbsp;JDeveloper Extension"><link rel="chapter" href="plugin-jedit.html" title="Chapter&nbsp;10.&nbsp;jEdit Plug-in"><link rel="chapter" href="plugin-netbeans.html" title="Chapter&nbsp;11.&nbsp;NetBeans/Sun ONE Studio module"><link rel="appendix" href="dependencies.html" title="Appendix&nbsp;A.&nbsp;Library Dependencies"><link rel="appendix" href="license-bsd.html" title="Appendix&nbsp;B.&nbsp;The Jalopy BSD License"><link rel="appendix" href="license-antlr.html" title="Appendix&nbsp;C.&nbsp;ANTLR SOFTWARE RIGHTS"><link rel="appendix" href="license-apache.html" title="Appendix&nbsp;D.&nbsp;The Apache Software License, Version 1.1"><link rel="appendix" href="license-gnu.html" title="Appendix&nbsp;E.&nbsp;GNU GENERAL PUBLIC LICENSE Version 2, June 1991"><link rel="appendix" href="license-gnu-doc.html" title="Appendix&nbsp;F.&nbsp;GNU Free Documentation License Version 1.1, March 2000"><link rel="appendix" href="license-common-public.html" title="Appendix&nbsp;G.&nbsp;Common Public License Version 1.0"><link rel="appendix" href="license-sun-public.html" title="Appendix&nbsp;H.&nbsp;SUN PUBLIC LICENSE Version 1.0"><link rel="index" href="ix01.html" title="Index"><link rel="section" href="plugin-console.html#plugin-console-installation" title="6.1.&nbsp;Installation"><link rel="section" href="plugin-console-usage.html" title="6.2.&nbsp;Usage"><link rel="section" href="plugin-console-license.html" title="6.3.&nbsp;License">
  23       <meta name="description" content="Jalopy Java Source Code Formatter Beautifier Pretty Printer">
  24       <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" l gen true for "http://jalopy.sf.net" r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://jalopy.sf.net" r (n 0 s 0 v 0 l 0))'>
  25     </head><body id="toppage" bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table width="700" border="0" cellpadding="0" cellspacing="0" align="left"><tbody><tr><td><table cellpadding="0" cellspacing="0" width="100%" style="border:1px solid #336699"><tbody><tr><td height="16"></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr style="border:none"><td style="border:none"><table border="0" cellspacing="0" cellpadding="0"><tbody><tr><td class="logo">JALOPY</td><td class="sublogo" valign="bottom">Java Source Code Formatter Beautifier Pretty Printer</td></tr></tbody></table></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr><td height="10"></td></tr><tr><td bgcolor="#ff8000" height="4"></td></tr><tr><td height="20" bgcolor="#336699" style="color:#ffffff;padding-left:10px"><a href="./index.html" class="navlink">Overview</a> &#149;
  26                     <a href="./download.html" class="navlink">Download</a> &#149;
  27                     <a href="./docs.html" class="navlink">Documentation</a> &#149;
  28                     <a href="./plugins.html" class="navlink">Plug-ins</a> &#149;
  29                     <a href="./links.html" class="navlink">Links</a> &#149;
  30                     <a href="./contact.html" class="navlink">Contact</a></td></tr><tr><td height="1" bgcolor="#ffffff"></td></tr></tbody></table></td></tr><tr valign="top"><td valign="top" bgcolor="#ffffff"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td height="20" bgcolor="#faebd7" style="padding-left:15px"><a href="./features.html" class="navlink2">Features</a> |
  31                     <a href="./history.html" class="navlink2">History</a> |
  32                     <a href="./manual.html" class="navlink2">Manual</a> |
  33                     <a href="./faq.html" class="navlink2">FAQ</a> |
  34                     <a href="./api/index.html" class="navlink2">Javadoc</a></td></tr><tr><td height="20" bgcolor="#ffffff"></td></tr><tr><td bgcolor="#eeeecc" height="17" align="right" style="font-size:10px;padding-right:3px">
  35                     This page generated: <strong>June 8 2004</strong></td></tr></tbody></table><table border="0" width="100%" cellspacing="0" cellpadding="5"><tr><td><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;6.&nbsp;Console Application</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="plugin-ant-license.html">Prev</a>&nbsp;</td><th width="60%" align="center">Part&nbsp;II.&nbsp;Plug-ins</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="plugin-console-usage.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="plugin-console"></a>Chapter&nbsp;6.&nbsp;Console Application</h2></div></div><div></div></div><a class="indexterm" name="d0e5799"></a><a class="indexterm" name="d0e5804"></a><p>
  36 The Console application provides a powerful command line interface for Jalopy.
  37 </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="plugin-console-installation"></a>6.1.&nbsp;Installation</h2></div></div><div></div></div><p>
  38 Explains the steps involved to install the Console Plug-in.
  39 </p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="plugin-console-installation-requirements"></a>6.1.1.&nbsp;System requirements</h4></div></div><div></div></div><p>
  40 See <a href="installation.html#installation-requirements" title="1.1.&nbsp;System requirements">Section&nbsp;1.1, &#8220;System requirements&#8221;</a> for the basic requirements to
  41 run Jalopy.
  42 </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="plugin-console-installation-installation"></a>6.1.2.&nbsp;Installation</h4></div></div><div></div></div><a class="indexterm" name="d0e5824"></a><p>
  43 The Plug-in comes either as a single <tt class="filename">.zip</tt> or compressed <tt class="filename">.tar</tt> file.
  44 Unzipping either one of these files into a directory of your choice (referred
  45 to as <i class="replaceable"><tt>&lt;INST_DIR&gt;</tt></i>) will produce three
  46 subdirectories <tt class="filename">/bin</tt>, <tt class="filename">/docs</tt> and
  47 <tt class="filename">/lib</tt>.
  48 </p><p>
  49 </p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="screen">
  50 ..
  51   bin/       contains wrapper scripts for different platforms
  52   docs/      contains the documentation
  53   lib/       contains all necessary libraries
  54 </pre></td></tr></table><p>
  55 </p><p>
  56 Wrapper scripts are provided for the common platforms, so you may want to add
  57 the <tt class="filename">/bin</tt> folder to your path. If your platform
  58 is not covered you should make use of the <tt class="option">-jar</tt> option of the
  59 Java application launcher (the <span><b class="command">java -jar</b></span> command), since
  60 this requires no classpath manipulation. If you don't want to use the
  61 <tt class="option">-jar</tt> option, you have to add the <tt class="filename">.jar</tt>
  62 files as usual to your classpath.
  63 </p><p>
  64 For the Unix Bash shell, this means can be achieved using
  65 </p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  66 export CLASSPATH=${CLASSPATH}:<i class="replaceable"><tt>&lt;INST_DIR&gt;</tt></i>/lib/jalopy-console-<i class="replaceable"><tt>&lt;version&gt;</tt></i>.jar
  67 </pre></td></tr></table><p>
  68 For Windows, use something like
  69 </p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  70 set CLASSPATH=%CLASSPATH%;<i class="replaceable"><tt>&lt;INST_DIR&gt;</tt></i>\lib\jalopy-console-<i class="replaceable"><tt>&lt;version&gt;</tt></i>.jar
  71 </pre></td></tr></table><p>
  72 Refer to your system documentation on how to apply these changes more permanently.
  73 </p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="plugin-ant-license.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="part-plugins.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="plugin-console-usage.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.4.&nbsp;License&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;6.2.&nbsp;Usage</td></tr></table></div></td></tr></table></td></tr><tr><td bgcolor="#eeeecc" height="17" style="font-size:9px;padding-left:5px"><a href="#toppage">to top</a></td></tr><tr><td height="30"><br></td></tr><tr><td height="3"></td></tr><tr><td bgcolor="#336699" height="1"></td></tr><tr><td height="1"></td></tr><tr><td bgcolor="#336699" height="16"></td></tr><tr><td bgcolor="#ff9966" height="4"></td></tr><tr><td class="footer" align="center" height="15" valign="middle">
  74             Copyright &copy; 2001-2004, <a class="footer" href="./contact.html">Marco Hunsicker</a>. All rights reserved. Hosted by <a href="http://sourceforge.net">SourceForge.net</a></td></tr></tbody></table><img src="http://sourceforge.net/sflogo.php?group_id=45216&amp;type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>