<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type" />
<meta name="author" content="Oliver Burn">
<meta name="email" content="$au.getAttributeValue("email")">
<title>Checkstyle - Command Line</title>
<style type="text/css" media="all">
@import url("./css/cs-layout.css");
@import url("./css/cs-style.css");
</style>
</head>
<body>
<div class="csTopBar">
<div class="csTopBarContents">
<div class="csLeft">
<h1>Command Line</h1>
</div>
<div class="csRight">
<a href="http://checkstyle.sourceforge.net/">
<img src="images/logo.png" alt="Checkstyle Logo" height="70"/>
</a>
</div>
</div>
</div>
<div class="csMiddleContainer">
<div class="csLeftBar">
<div class="csLeftBarContents">
<!-- ============================================================ -->
<!-- start makeNavigationBar -->
<ul>
<li>
<strong>About</strong>
</li>
<li> <a href="./index.html">Checkstyle</a>
</li>
<li>
<strong>Documentation</strong>
</li>
<li> <a href="./releasenotes.html">Release Notes</a>
</li>
<li> <a href="./config.html">Configuration</a>
</li>
<li> <a href="./property_types.html"> Property Types</a>
</li>
<li> <a href="./running.html">Running</a>
</li>
<li> <a href="./anttask.html"> Ant Task</a>
</li>
<li><b> <a href="./cmdline.html"> Command Line</a>
</b></li>
<li><a href="#Description"> Description</a></li>
<li><a href="#Installation"> Installation</a></li>
<li><a href="#Usage"> Usage</a></li>
<li><a href="#Examples"> Examples</a></li>
<li> <a href="./availablechecks.html">Available Checks</a>
</li>
<li> <a href="./checks.html">Standard Checks</a>
</li>
<li> <a href="./config_javadoc.html"> Javadoc Comments</a>
</li>
<li> <a href="./config_naming.html"> Naming Conventions</a>
</li>
<li> <a href="./config_header.html"> Headers</a>
</li>
<li> <a href="./config_imports.html"> Imports</a>
</li>
<li> <a href="./config_sizes.html"> Size Violations</a>
</li>
<li> <a href="./config_whitespace.html"> Whitespace</a>
</li>
<li> <a href="./config_modifier.html"> Modifiers</a>
</li>
<li> <a href="./config_blocks.html"> Block Checks</a>
</li>
<li> <a href="./config_coding.html"> Coding</a>
</li>
<li> <a href="./config_design.html"> Class Design</a>
</li>
<li> <a href="./config_duplicates.html"> Duplicate Code</a>
</li>
<li> <a href="./config_metrics.html"> Metrics</a>
</li>
<li> <a href="./config_misc.html"> Miscellaneous</a>
</li>
<li> <a href="./optional.html">Optional Checks</a>
</li>
<li> <a href="./config_j2ee.html"> J2EE Checks</a>
</li>
<li> <a href="./extending.html">Extending Checkstyle</a>
</li>
<li> <a href="./writingchecks.html"> Writing checks</a>
</li>
<li> <a href="./writingfilters.html"> Writing filters</a>
</li>
<li> <a href="./writinglisteners.html"> Writing listeners</a>
</li>
<li> <a href="./api/index.html">Javadoc</a>
</li>
<li>
<strong>SourceForge</strong>
</li>
<li> <a href="http://sourceforge.net/mail/?group_id=29721">Mailing Lists</a>
</li>
<li> <a href="http://sourceforge.net/tracker/?atid=397078&group_id=29721&func=browse">Bug Database</a>
</li>
<li> <a href="http://sourceforge.net/tracker/?atid=397081&group_id=29721&func=browse">Feature Requests</a>
</li>
<li>
<strong>Developers</strong>
</li>
<li> <a href="http://sourceforge.net/projects/checkstyle">Project Page</a>
</li>
<li> <a href="http://checkstyle.svn.sourceforge.net/viewvc/checkstyle/">SVN Repository</a>
</li>
<li> <a href="./contributing.html">Contributing</a>
</li>
</ul>
<ul>
<li>
<strong>Hosted by:</strong>
<div align="center">
<p><a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=29721&type=1" width="88" height="31" alt="SourceForge Logo"/></a>
</p>
</div>
</li>
</ul>
<!-- end makeNavigationBar -->
<!-- ============================================================ -->
</div>
</div>
<div class="csMain">
<a id="Description"></a>
<h2>Description</h2>
<p>
This document describes how to run checkstyle using the command line
tool. The latest version of checkstyle can be found at <a href="http://checkstyle.sourceforge.net">http://checkstyle.sourceforge.net</a>.
This command line tool is included in the checkstyle distribution.
</p>
<a id="Installation"></a>
<h2>Installation</h2>
<p>
The easiest way is to include <span class="default">checkstyle-all-4.4.jar</span> in the
classpath. If you are running JDK 1.4 this contains all the classes
required to run checkstyle (JDK 1.3 users must add a JAXP compliant
XML parser implementation). Alternatively, you must include the
following in the classpath:
</p>
<ol>
<li>
<span class="default">checkstyle-4.4.jar</span>
</li>
<li>
ANTLR 2.7.2 classes. <span class="default">antlr.jar</span> is
included in the distribution.
</li>
<li>
Jakarta Commons Beanutils classes. <span class="default">commons-beanutils.jar</span> is included in the
distribution.
</li>
<li>
Jakarta Commons Collections classes. <span class="default">commons-collections.jar</span> is included in the
distribution.
</li>
<li>
Jakarta Commons Logging classes. <span class="default">commons-logging.jar</span> is included in the
distribution.
</li>
<li>
Jakarta Commons CLI (command line interface) classes. <span class="default">commons-cli.jar</span> is included in the
distribution.
</li>
<li>JDK 1.3 only: A JAXP compliant XML parser implementation.</li>
</ol>
<a id="Usage"></a>
<h2>Usage</h2>
<p>
The command line usage is:
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>java -D<property>=<value> \
com.puppycrawl.tools.checkstyle.Main \
-c <configurationFile> [-n <packageNameFile>] \
[-f <format>] [-p <propertiesFile>] [-o <file>] \
[-r <dir>] file...</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
Checkstyle will process the specified files and by default report
errors to standard out in plain format. Checkstyle requires a <a href="config.html">configuration XML file</a> that configures the
checks to apply. Command line options are:
</p>
<ul>
<li>
<span class="default">-n packageNamesFile</span> - specify a <a href="config.html#Packages">package names file</a> to use.
</li>
<li>
<span class="default">-f format</span> - specify the output
format. Options are <span class="default"> "plain"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/DefaultLogger.html">DefaultLogger</a>
and <span class="default">"xml"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/XMLLogger.html">XMLLogger</a>.
Defaults to <span class="default">"plain"</span>.
</li>
<li>
<span class="default">-p propertiesFile</span> - specify a
properties file to use.
</li>
<li>
<span class="default">-o file</span> - specify the file to output
to.
</li>
<li>
<span class="default">-r dir</span> - specify the directory to
traverse for Java source files.
</li>
</ul>
<p>
Set the properties for <a href="config.html#Properties">expanded
property values</a> by either by assigning system properties using the
<code>-D<property>=<value></code> arguments to java or
specifying a property file using the <code>-p</code> option. If a
property file is specified, the system properties are ignored.
</p>
<a id="Examples"></a>
<h2>Examples</h2>
<p>
<b>
Run checkstyle with configuration file
<code>docs/sun_checks.xml</code> on a file
</b>
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
Check.java</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>docs/sun_checks.xml</code> on all java files in a directory
</b>
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
-r src/</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>docs/sun_checks.xml</code> on a file and provide a system
property
</b>
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>java -Dcheckstyle.cache.file=target/cachefile \
com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
Check.java</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>docs/sun_checks.xml</code> on a file and use properties in a
file
</b>
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
-p myCheckstyle.properties Check.java</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>docs/sun_checks.xml</code> on a file and output to a file in
XML format
</b>
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
-f xml -o build/checkstyle_errors.xml Check.java</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
<b>
Run checkstyle with configuration file
<code>docs/sun_checks.xml</code> on a file and provide a package
names file
</b>
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>java com.puppycrawl.tools.checkstyle.Main -c docs/sun_checks.xml \
-n myPackageNames.xml Check.java</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<div class="tip">
<h4 class="tip">Tip</h4>
<p>
It is possible to run Checkstyle directly from the JAR file using
the <span class="code">-jar</span> option. An example would be:
</p>
<source><pre>
java -jar checkstyle-all-4.4.jar \
-c docs/sun_checks.xml Check.java
</pre></source>
</div>
</div>
</div>
<div class="csBottomBar">
<div class="csBottomBarContents">
Copyright © 2001-2007, Oliver Burn
</div>
</div>
</body>
</html>
<!-- end the processing -->
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
253d50e0122b162d839c0c787af1f0d6
>
files
>
5
