utils/jalopy/docs/plugin-console-usage.html

   1
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
   4  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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>6.2.&nbsp;Usage</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="plugin-console.html" title="Chapter&nbsp;6.&nbsp;Console Application"><link rel="previous" href="plugin-console.html" title="Chapter&nbsp;6.&nbsp;Console Application"><link rel="next" href="plugin-console-license.html" title="6.3.&nbsp;License"><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="subsection" href="plugin-console-usage.html#synopsis" title="6.2.1.&nbsp;Synopsis"><link rel="subsection" href="plugin-console-usage.html#plugin-console-usage-example" title="6.2.2.&nbsp;Examples">
  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">6.2.&nbsp;Usage</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="plugin-console.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;6.&nbsp;Console Application</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="plugin-console-license.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="plugin-console-usage"></a>6.2.&nbsp;Usage</h2></div></div><div></div></div><p>
  36 Presents the available command line options along with some usage examples.
  37 </p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="synopsis"></a>6.2.1.&nbsp;Synopsis</h4></div></div><div></div></div><a class="indexterm" name="d0e5901"></a><a class="indexterm" name="d0e5904"></a><a class="indexterm" name="d0e5907"></a><p>
  38 To start Jalopy from the command line you may either use
  39 </p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  40 jalopy [-options] <i class="replaceable"><tt>args</tt></i>...
  41 </pre></td></tr></table><p>
  42 or
  43 </p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  44 java Jalopy [-options] <i class="replaceable"><tt>args</tt></i>...
  45 </pre></td></tr></table><p>
  46 or
  47 </p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  48 java -jar jalopy-<i class="replaceable"><tt>&lt;version&gt;</tt></i>.jar [-options] <i class="replaceable"><tt>args</tt></i>...
  49 </pre></td></tr></table><p>
  50 depending on your installation option.
  51 </p><p><a name="usage-options"></a>
  52 You can specify as many <i class="replaceable"><tt>args</tt></i> as you want,
  53 where <i class="replaceable"><tt>args</tt></i> describes either files,
  54 directories or filter expressions. You can use any valid Perl5 (5.003)
  55 regular expression as a filter expression.
  56 </p><a class="indexterm" name="d0e5944"></a><a class="indexterm" name="d0e5949"></a><a class="indexterm" name="d0e5954"></a><div class="simplesect" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="options"></a>Options</h5></div></div><div></div></div><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="screen">
  57 -c, --convention=FILE   use FILE as code convention file
  58     --disclaimer        print software disclaimer
  59 -d, --dest=DIR          use DIR as base output directory
  60 -e, --encoding=WORD     assume WORD as encoding of input files where WORD
  61                         describes one of the JDK supported encodings
  62                         (if omitted, the platform default is used)
  63 -f, --format=WORD       use WORD as output file format where WORD can be
  64                         either UNIX, DOS, MAC, AUTO (the default) or DEFAULT
  65                         (all case-insensitive)
  66     --force             force formatting even if file up-to-date
  67 -h, --help              display this help
  68     --nobackup          don't keep backup files
  69 -r, --recursive{=NUM}   recurse into directories, up to NUM levels
  70                         if NUM is omitted, recurses indefinitely
  71 -t, --thread=NUM        use NUM processing threads
  72 -v, --version           print product version and exit
  73 </pre></td></tr></table><p>
  74 If no input file(s) are given, Jalopy starts listening on <span class="emphasis"><em>STDIN</em></span>.
  75 </p></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="plugin-console-usage-example"></a>6.2.2.&nbsp;Examples</h4></div></div><div></div></div><p>
  76 </p><div class="example"><a name="ex-command-line-one"></a><p class="title"><b>Example&nbsp;6.1.&nbsp;Sample command line usage</b></p><a class="indexterm" name="d0e5975"></a><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  77 jalopy -r <i class="replaceable"><tt>myDirectory</tt></i>
  78 </pre></td></tr></table><p>
  79 Formats all Java source files found in directory <i class="replaceable"><tt>myDirectory</tt></i>
  80 and all subdirectories. Creates backup copies of all files. The file format
  81 of the original source files will be kept.
  82 </p></div><p>
  83
  84 </p><div class="example"><a name="ex-command-line-two"></a><p class="title"><b>Example&nbsp;6.2.&nbsp;Sample command line usage</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  85 jalopy -d <i class="replaceable"><tt>/directory</tt></i> -f DOS
  86 <i class="replaceable"><tt>myFile1.java myFile2.java</tt></i>
  87 </pre></td></tr></table><p>
  88 Formats the two files <i class="replaceable"><tt>myFile1.java</tt></i> and
  89 <i class="replaceable"><tt>myFile2.java</tt></i> and writes the new files into
  90 directory <i class="replaceable"><tt>/directory</tt></i>. Uses DOS as the file
  91 format of the new files.
  92 </p></div><p>
  93
  94 </p><div class="example"><a name="ex-command-line-three"></a><p class="title"><b>Example&nbsp;6.3.&nbsp;Sample command line usage</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
  95 jalopy -r 3 -d <i class="replaceable"><tt>/directory</tt></i> ^A.*java
  96 </pre></td></tr></table><p>
  97 Formats all Java source files found in the current directory and three
  98 levels down that begin with a captial 'A' and writes the new files into
  99 directory <i class="replaceable"><tt>/tmp</tt></i>. The file format of the
 100 original source files will be kept.
 101 </p></div><p>
 102
 103 </p><div class="example"><a name="ex-command-line-four"></a><p class="title"><b>Example&nbsp;6.4.&nbsp;Sample command line usage</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
 104 type f:\test\in.java | jalopy &gt; out.java
 105 </pre></td></tr></table><p>
 106 Formats the file <tt class="filename">f:\test\in.java</tt> read from STDIN and
 107 outputs its formatted contents to the file <tt class="filename">out.java</tt> in the
 108 current directory.
 109 </p></div><p>
 110
 111 </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="plugin-console.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="plugin-console.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="plugin-console-license.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;6.&nbsp;Console Application&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.3.&nbsp;License</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">
 112             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>