-
<!--
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
+ * Copyright (C) 2014 The Jalview Authors
*
* This file is part of Jalview.
*
* Jalview is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- *
+ *
* Jalview is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
-->
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+ <html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>6.2. 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 6. Console Application"><link rel="previous" href="plugin-console.html" title="Chapter 6. Console Application"><link rel="next" href="plugin-console-license.html" title="6.3. 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 I. Jalopy core"><link rel="chapter" href="installation.html" title="Chapter 1. Installation"><link rel="chapter" href="build.html" title="Chapter 2. Building"><link rel="chapter" href="usage.html" title="Chapter 3. Usage"><link rel="chapter" href="settings.html" title="Chapter 4. Settings"><link rel="part" href="part-plugins.html" title="Part II. Plug-ins"><link rel="chapter" href="plugin-ant.html" title="Chapter 5. Ant Plug-in task"><link rel="chapter" href="plugin-console.html" title="Chapter 6. Console Application"><link rel="chapter" href="plugin-eclipse.html" title="Chapter 7. Eclipse Plug-in"><link rel="chapter" href="plugin-jbuilder.html" title="Chapter 8. JBuilder OpenTool"><link rel="chapter" href="plugin-jdev.html" title="Chapter 9. JDeveloper Extension"><link rel="chapter" href="plugin-jedit.html" title="Chapter 10. jEdit Plug-in"><link rel="chapter" href="plugin-netbeans.html" title="Chapter 11. NetBeans/Sun ONE Studio module"><link rel="appendix" href="dependencies.html" title="Appendix A. Library Dependencies"><link rel="appendix" href="license-bsd.html" title="Appendix B. The Jalopy BSD License"><link rel="appendix" href="license-antlr.html" title="Appendix C. ANTLR SOFTWARE RIGHTS"><link rel="appendix" href="license-apache.html" title="Appendix D. The Apache Software License, Version 1.1"><link rel="appendix" href="license-gnu.html" title="Appendix E. GNU GENERAL PUBLIC LICENSE Version 2, June 1991"><link rel="appendix" href="license-gnu-doc.html" title="Appendix F. GNU Free Documentation License Version 1.1, March 2000"><link rel="appendix" href="license-common-public.html" title="Appendix G. Common Public License Version 1.0"><link rel="appendix" href="license-sun-public.html" title="Appendix H. 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. Synopsis"><link rel="subsection" href="plugin-console-usage.html#plugin-console-usage-example" title="6.2.2. Examples">
+ <meta name="description" content="Jalopy Java Source Code Formatter Beautifier Pretty Printer">
+ <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))'>
+ </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> •
+ <a href="./download.html" class="navlink">Download</a> •
+ <a href="./docs.html" class="navlink">Documentation</a> •
+ <a href="./plugins.html" class="navlink">Plug-ins</a> •
+ <a href="./links.html" class="navlink">Links</a> •
+ <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> |
+ <a href="./history.html" class="navlink2">History</a> |
+ <a href="./manual.html" class="navlink2">Manual</a> |
+ <a href="./faq.html" class="navlink2">FAQ</a> |
+ <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">
+ 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. Usage</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="plugin-console.html">Prev</a> </td><th width="60%" align="center">Chapter 6. Console Application</th><td width="20%" align="right"> <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. Usage</h2></div></div><div></div></div><p>
+Presents the available command line options along with some usage examples.
+</p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="synopsis"></a>6.2.1. 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>
+To start Jalopy from the command line you may either use
+</p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
+jalopy [-options] <i class="replaceable"><tt>args</tt></i>...
+</pre></td></tr></table><p>
+or
+</p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
+java Jalopy [-options] <i class="replaceable"><tt>args</tt></i>...
+</pre></td></tr></table><p>
+or
+</p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
+java -jar jalopy-<i class="replaceable"><tt><version></tt></i>.jar [-options] <i class="replaceable"><tt>args</tt></i>...
+</pre></td></tr></table><p>
+depending on your installation option.
+</p><p><a name="usage-options"></a>
+You can specify as many <i class="replaceable"><tt>args</tt></i> as you want,
+where <i class="replaceable"><tt>args</tt></i> describes either files,
+directories or filter expressions. You can use any valid Perl5 (5.003)
+regular expression as a filter expression.
+</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">
+-c, --convention=FILE use FILE as code convention file
+ --disclaimer print software disclaimer
+-d, --dest=DIR use DIR as base output directory
+-e, --encoding=WORD assume WORD as encoding of input files where WORD
+ describes one of the JDK supported encodings
+ (if omitted, the platform default is used)
+-f, --format=WORD use WORD as output file format where WORD can be
+ either UNIX, DOS, MAC, AUTO (the default) or DEFAULT
+ (all case-insensitive)
+ --force force formatting even if file up-to-date
+-h, --help display this help
+ --nobackup don't keep backup files
+-r, --recursive{=NUM} recurse into directories, up to NUM levels
+ if NUM is omitted, recurses indefinitely
+-t, --thread=NUM use NUM processing threads
+-v, --version print product version and exit
+</pre></td></tr></table><p>
+If no input file(s) are given, Jalopy starts listening on <span class="emphasis"><em>STDIN</em></span>.
+</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. Examples</h4></div></div><div></div></div><p>
+</p><div class="example"><a name="ex-command-line-one"></a><p class="title"><b>Example 6.1. Sample command line usage</b></p><a class="indexterm" name="d0e5975"></a><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
+jalopy -r <i class="replaceable"><tt>myDirectory</tt></i>
+</pre></td></tr></table><p>
+Formats all Java source files found in directory <i class="replaceable"><tt>myDirectory</tt></i>
+and all subdirectories. Creates backup copies of all files. The file format
+of the original source files will be kept.
+</p></div><p>
+
+</p><div class="example"><a name="ex-command-line-two"></a><p class="title"><b>Example 6.2. Sample command line usage</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
+jalopy -d <i class="replaceable"><tt>/directory</tt></i> -f DOS
+<i class="replaceable"><tt>myFile1.java myFile2.java</tt></i>
+</pre></td></tr></table><p>
+Formats the two files <i class="replaceable"><tt>myFile1.java</tt></i> and
+<i class="replaceable"><tt>myFile2.java</tt></i> and writes the new files into
+directory <i class="replaceable"><tt>/directory</tt></i>. Uses DOS as the file
+format of the new files.
+</p></div><p>
+
+</p><div class="example"><a name="ex-command-line-three"></a><p class="title"><b>Example 6.3. Sample command line usage</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
+jalopy -r 3 -d <i class="replaceable"><tt>/directory</tt></i> ^A.*java
+</pre></td></tr></table><p>
+Formats all Java source files found in the current directory and three
+levels down that begin with a captial 'A' and writes the new files into
+directory <i class="replaceable"><tt>/tmp</tt></i>. The file format of the
+original source files will be kept.
+</p></div><p>
+
+</p><div class="example"><a name="ex-command-line-four"></a><p class="title"><b>Example 6.4. Sample command line usage</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="synopsis">
+type f:\test\in.java | jalopy > out.java
+</pre></td></tr></table><p>
+Formats the file <tt class="filename">f:\test\in.java</tt> read from STDIN and
+outputs its formatted contents to the file <tt class="filename">out.java</tt> in the
+current directory.
+</p></div><p>
+
+</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> </td><td width="20%" align="center"><a accesskey="u" href="plugin-console.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="plugin-console-license.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 6. Console Application </td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top"> 6.3. 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">
+ Copyright © 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&type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>
git://source.jalview.org / jalview.git / blobdiff