| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2016-09-04 --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| <title>Apache Rat™ Plugin for Apache Maven – apache-rat:check</title> |
| <style type="text/css" media="all"> |
| @import url("./css/maven-base.css"); |
| @import url("./css/maven-theme.css"); |
| @import url("./css/site.css"); |
| </style> |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| <meta name="Date-Revision-yyyymmdd" content="20160904" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| |
| <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Mate+SC" type="text/css"/> |
| |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <a href="https://www.apache.org/" id="bannerLeft"> |
| <img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" title="The Apache Software Foundation" /> |
| </a> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| |
| <div class="xleft"> |
| <span id="publishDate">Last Published: 2016-09-04</span> |
| | <span id="projectVersion">Version: 0.13-SNAPSHOT</span> |
| | <a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a> |
| > |
| <a href="https://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a> |
| > |
| <a href="https://creadur.apache.org/rat/" class="externalLink" title="Rat">Rat</a> |
| > |
| <a href="./" title="Apache Rat™ Plugin for Apache Maven">Apache Rat™ Plugin for Apache Maven</a> |
| > |
| apache-rat:check |
| </div> |
| <div class="xright"> |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| |
| <h5>Parent Project</h5> |
| <ul> |
| <li class="none"> |
| <a href="../index.html" title="Apache Creadur Rat">Apache Creadur Rat</a> |
| </li> |
| </ul> |
| <h5>Overview</h5> |
| <ul> |
| <li class="none"> |
| <a href="index.html" title="Introduction">Introduction</a> |
| </li> |
| <li class="none"> |
| <a href="plugin-info.html" title="Goals">Goals</a> |
| </li> |
| <li class="none"> |
| <a href="usage.html" title="Usage">Usage</a> |
| </li> |
| <li class="none"> |
| <a href="faq.html" title="FAQ">FAQ</a> |
| </li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| <li class="none"> |
| <a href="examples/basic.html" title="Basic use">Basic use</a> |
| </li> |
| <li class="none"> |
| <a href="examples/verify.html" title="Running the plugin automatically">Running the plugin automatically</a> |
| </li> |
| <li class="none"> |
| <a href="examples/site.html" title="Adding a report to the site">Adding a report to the site</a> |
| </li> |
| <li class="none"> |
| <a href="examples/custom-license.html" title="Custom license">Custom license</a> |
| </li> |
| </ul> |
| <h5>Project Documentation</h5> |
| <ul> |
| <li class="collapsed"> |
| <a href="project-info.html" title="Project Information">Project Information</a> |
| </li> |
| <li class="collapsed"> |
| <a href="project-reports.html" title="Project Reports">Project Reports</a> |
| </li> |
| </ul> |
| <h5>Apache Rat™</h5> |
| <ul> |
| <li class="none"> |
| <a href="../index.html" title="Introducing Rat">Introducing Rat</a> |
| </li> |
| <li class="none"> |
| <a href="../apidocs/index.html" title="Javadocs">Javadocs</a> |
| </li> |
| <li class="none"> |
| <a href="../download_rat.cgi" title="Downloads">Downloads</a> |
| </li> |
| <li class="none"> |
| <a href="../RELEASE_NOTES.txt" title="Changes">Changes</a> |
| </li> |
| </ul> |
| <h5>Running Rat</h5> |
| <ul> |
| <li class="none"> |
| <a href="../apache-rat/index.html" title="From The Command Line">From The Command Line</a> |
| </li> |
| <li class="none"> |
| <a href="../apache-rat-tasks/index.html" title="With Ant">With Ant</a> |
| </li> |
| <li class="none"> |
| <a href="../apache-rat-plugin/index.html" title="With Maven">With Maven</a> |
| </li> |
| </ul> |
| <h5>Apache Creadur™</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://creadur.apache.org" class="externalLink" title="Creadur Project Home">Creadur Project Home</a> |
| </li> |
| <li class="none"> |
| <a href="https://creadur.apache.org/tentacles" class="externalLink" title="Apache Tentacles">Apache Tentacles</a> |
| </li> |
| <li class="none"> |
| <a href="https://creadur.apache.org/whisker" class="externalLink" title="Apache Whisker">Apache Whisker</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/security/" class="externalLink" title="Security">Security</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/licenses/" class="externalLink" title="License">License</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a> |
| </li> |
| </ul> |
| <h5>The Apache Software Foundation</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation" class="externalLink" title="About the Foundation">About the Foundation</a> |
| </li> |
| <li class="none"> |
| <a href="https://projects.apache.org" class="externalLink" title="The projects">The projects</a> |
| </li> |
| <li class="none"> |
| <a href="https://people.apache.org" class="externalLink" title="The people">The people</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How we work">How we work</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/how-it-works.html#history" class="externalLink" title="Our history">Our history</a> |
| </li> |
| <li class="none"> |
| <a href="https://blogs.apache.org/foundation/" class="externalLink" title="News">News</a> |
| </li> |
| </ul> |
| <h5>Contribute</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">Get Involved</a> |
| </li> |
| </ul> |
| <h5>Committer Info</h5> |
| <ul> |
| <li class="none"> |
| <a href="https://www.apache.org/dev/committers.html" class="externalLink" title="ASF Committers' FAQ">ASF Committers' FAQ</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/dev/new-committers-guide.html" class="externalLink" title="New Committers Guide">New Committers Guide</a> |
| </li> |
| <li class="none"> |
| <a href="../site-publish.html" title="Howto publish this site">Howto publish this site</a> |
| </li> |
| <li class="none"> |
| <a href="https://planet.apache.org/committers/" class="externalLink" title="Plant Apache">Plant Apache</a> |
| </li> |
| <li class="none"> |
| <a href="https://community.apache.org/" class="externalLink" title="Community">Community</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/legal/" class="externalLink" title="Legal">Legal</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/foundation/marks/" class="externalLink" title="Branding">Branding</a> |
| </li> |
| <li class="none"> |
| <a href="https://www.apache.org/press/" class="externalLink" title="Media Relations">Media Relations</a> |
| </li> |
| </ul> |
| <a href="https://maven.apache.org/" title="Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> |
| </a> |
| |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| |
| |
| <div class="section"> |
| <h2><a name="apache-rat:check"></a>apache-rat:check</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.apache.rat:apache-rat-plugin:0.13-SNAPSHOT:check</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Run Rat to perform a violation check.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>validate</tt>.</li> |
| </ul> |
| |
| <div class="section"> |
| <h3><a name="Required_Parameters"></a>Required Parameters</h3> |
| |
| <table class="bodyTable" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#basedir">basedir</a></b></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>The base directory, in which to search for files.<br /><b>Default value is</b>: <tt>${basedir}</tt>.<br /><b>User property is</b>: <tt>rat.basedir</tt>.</td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</h3> |
| |
| <table class="bodyTable" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#addDefaultLicenseMatchers">addDefaultLicenseMatchers</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to add the default list of license matchers.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>rat.addDefaultLicenseMatchers</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#addLicenseHeaders">addLicenseHeaders</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to add license headers; possible values are |
| <tt>forced</tt>, <tt>true</tt>, and <tt>false</tt> |
| (default).<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>rat.addLicenseHeaders</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#consoleOutput">consoleOutput</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>0.12</tt></td> |
| |
| <td>Whether to output the names of files that have unapproved licenses |
| to the console.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>rat.consoleOutput</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#copyrightMessage">copyrightMessage</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Copyright message to add to license headers. This option is |
| ignored, unless <tt>addLicenseHeaders</tt> is set to |
| <tt>true</tt>, or <tt>forced</tt>.<br /><b>User property is</b>: <tt>rat.copyrightMessage</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#excludeSubProjects">excludeSubProjects</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to exclude subprojects. This is recommended, if you want a |
| separate apache-rat-plugin report for each subproject.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>rat.excludeSubprojects</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#excludes">excludes</a></b></td> |
| |
| <td><tt>String[]</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Specifies files, which are excluded in the report. By default, no |
| files are excluded.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#excludesFile">excludesFile</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Specifies a file, from which to read excludes. Basically, an |
| alternative to specifying the excludes as a list. The excludesFile |
| is assumed to be using the UFT8 character set.<br /><b>User property is</b>: <tt>rat.excludesFile</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#excludesFileCharset">excludesFileCharset</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Specifies the include files character set. Defaults to |
| @code{${project.build.sourceEncoding}), or @code{UTF8}.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.<br /><b>User property is</b>: <tt>rat.excludesFileCharset</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#ignoreErrors">ignoreErrors</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>0.9</tt></td> |
| |
| <td>Will ignore rat errors and display a log message if any. Its use is |
| NOT RECOMMENDED, but quite convenient on occasion.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>rat.ignoreErrors</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#includes">includes</a></b></td> |
| |
| <td><tt>String[]</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Specifies files, which are included in the report. By default, all |
| files are included.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#includesFile">includesFile</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Specifies a file, from which to read includes. Basically, an |
| alternative to specifying the includes as a list.<br /><b>User property is</b>: <tt>rat.includesFile</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#includesFileCharset">includesFileCharset</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Specifies the include files character set. Defaults to |
| @code{${project.build.sourceEncoding}), or @code{UTF8}.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.<br /><b>User property is</b>: <tt>rat.includesFileCharset</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#licenseFamilies">licenseFamilies</a></b></td> |
| |
| <td><tt>ILicenseFamily[]</tt></td> |
| |
| <td><tt>0.8</tt></td> |
| |
| <td>Specifies the license families to accept.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#licenseMatchers">licenseMatchers</a></b></td> |
| |
| <td><tt>HeaderMatcherSpecification[]</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td><b>Deprecated.</b> Use <tt>licenses</tt> instead.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#licenses">licenses</a></b></td> |
| |
| <td><tt>IHeaderMatcher[]</tt></td> |
| |
| <td><tt>0.8</tt></td> |
| |
| <td>Specifies the licenses to accept. By default, these are added to |
| the default licenses, unless you set |
| <tt>addDefaultLicenseMatchers</tt> to false.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#numUnapprovedLicenses">numUnapprovedLicenses</a></b></td> |
| |
| <td><tt>int</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Maximum number of files with unapproved licenses.<br /><b>Default value is</b>: <tt>0</tt>.<br /><b>User property is</b>: <tt>rat.numUnapprovedLicenses</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#parseSCMIgnoresAsExcludes">parseSCMIgnoresAsExcludes</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to parse source code management system (SCM) ignore files |
| and use their contents as excludes. At the moment this works for |
| the following SCMs:<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>rat.parseSCMIgnoresAsExcludes</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#reportFile">reportFile</a></b></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Where to store the report.<br /><b>Default value is</b>: <tt>${project.build.directory}/rat.txt</tt>.<br /><b>User property is</b>: <tt>rat.outputFile</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#reportStyle">reportStyle</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Output style of the report. Use "plain" (the default) for a plain |
| text report or "xml" for the raw XML report. Alternatively you can |
| give the path of an XSL transformation that will be applied on the |
| raw XML to produce the report written to the output file.<br /><b>Default value is</b>: <tt>plain</tt>.<br /><b>User property is</b>: <tt>rat.outputStyle</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#skip">skip</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>0.11</tt></td> |
| |
| <td>Will skip the plugin execution, e.g. for technical builds that do |
| not take license compliance into account.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>rat.skip</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#useDefaultExcludes">useDefaultExcludes</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to use the default excludes when scanning for files. The |
| default excludes are: |
| |
| <ul> |
| |
| <li>meta data files for source code management / revision control |
| systems, see <tt>SourceCodeManagementSystems</tt></li> |
| |
| <li>temporary files used by Maven, see <a href="#useMavenDefaultExcludes">useMavenDefaultExcludes</a></li> |
| |
| <li>configuration files for Eclipse, see <a href="#useEclipseDefaultExcludes">useEclipseDefaultExcludes</a></li> |
| |
| <li>configuration files for IDEA, see <a href="#useIdeaDefaultExcludes">useIdeaDefaultExcludes</a></li> |
| </ul><br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>rat.useDefaultExcludes</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#useEclipseDefaultExcludes">useEclipseDefaultExcludes</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to use the Eclipse specific default excludes when scanning |
| for files. Eclipse specific default excludes are given by the |
| constant ECLIPSE_DEFAULT_EXCLUDES: The <tt>.classpath</tt> and |
| <tt>.project</tt> files, the <tt>.settings</tt> directory, |
| and so on.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>rat.useEclipseDefaultExcludes</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#useIdeaDefaultExcludes">useIdeaDefaultExcludes</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to use the IDEA specific default excludes when scanning for |
| files. IDEA specific default excludes are given by the constant |
| IDEA_DEFAULT_EXCLUDES: The <tt>*.iml</tt>, <tt>*.ipr</tt> |
| and <tt>*.iws</tt> files and the <tt>.idea</tt> directory.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>rat.useIdeaDefaultExcludes</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#useMavenDefaultExcludes">useMavenDefaultExcludes</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Whether to use the Maven specific default excludes when scanning |
| for files. Maven specific default excludes are given by the |
| constant MAVEN_DEFAULT_EXCLUDES: The <tt>target</tt> directory, |
| the <tt>cobertura.ser</tt> file, and so on.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>rat.useMavenDefaultExcludes</tt>.</td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| |
| <p><b><a name="addDefaultLicenseMatchers">addDefaultLicenseMatchers</a>:</b></p> |
| |
| <div>Whether to add the default list of license matchers.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.addDefaultLicenseMatchers</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /> |
| <p><b><a name="addLicenseHeaders">addLicenseHeaders</a>:</b></p> |
| |
| <div>Whether to add license headers; possible values are |
| <tt>forced</tt>, <tt>true</tt>, and <tt>false</tt> |
| (default).</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.addLicenseHeaders</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /> |
| <p><b><a name="basedir">basedir</a>:</b></p> |
| |
| <div>The base directory, in which to search for files.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>Yes</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.basedir</tt></li> |
| |
| <li><b>Default</b>: <tt>${basedir}</tt></li> |
| </ul><hr /> |
| <p><b><a name="consoleOutput">consoleOutput</a>:</b></p> |
| |
| <div>Whether to output the names of files that have unapproved licenses |
| to the console.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Since</b>: <tt>0.12</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.consoleOutput</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /> |
| <p><b><a name="copyrightMessage">copyrightMessage</a>:</b></p> |
| |
| <div>Copyright message to add to license headers. This option is |
| ignored, unless <tt>addLicenseHeaders</tt> is set to |
| <tt>true</tt>, or <tt>forced</tt>.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.copyrightMessage</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludeSubProjects">excludeSubProjects</a>:</b></p> |
| |
| <div>Whether to exclude subprojects. This is recommended, if you want a |
| separate apache-rat-plugin report for each subproject.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.excludeSubprojects</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludes">excludes</a>:</b></p> |
| |
| <div>Specifies files, which are excluded in the report. By default, no |
| files are excluded.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String[]</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludesFile">excludesFile</a>:</b></p> |
| |
| <div>Specifies a file, from which to read excludes. Basically, an |
| alternative to specifying the excludes as a list. The excludesFile |
| is assumed to be using the UFT8 character set.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.excludesFile</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludesFileCharset">excludesFileCharset</a>:</b></p> |
| |
| <div>Specifies the include files character set. Defaults to |
| @code{${project.build.sourceEncoding}), or @code{UTF8}.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.excludesFileCharset</tt></li> |
| |
| <li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li> |
| </ul><hr /> |
| <p><b><a name="ignoreErrors">ignoreErrors</a>:</b></p> |
| |
| <div>Will ignore rat errors and display a log message if any. Its use is |
| NOT RECOMMENDED, but quite convenient on occasion.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Since</b>: <tt>0.9</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.ignoreErrors</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /> |
| <p><b><a name="includes">includes</a>:</b></p> |
| |
| <div>Specifies files, which are included in the report. By default, all |
| files are included.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String[]</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /> |
| <p><b><a name="includesFile">includesFile</a>:</b></p> |
| |
| <div>Specifies a file, from which to read includes. Basically, an |
| alternative to specifying the includes as a list.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.includesFile</tt></li> |
| </ul><hr /> |
| <p><b><a name="includesFileCharset">includesFileCharset</a>:</b></p> |
| |
| <div>Specifies the include files character set. Defaults to |
| @code{${project.build.sourceEncoding}), or @code{UTF8}.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.includesFileCharset</tt></li> |
| |
| <li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li> |
| </ul><hr /> |
| <p><b><a name="licenseFamilies">licenseFamilies</a>:</b></p> |
| |
| <div>Specifies the license families to accept.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>org.apache.rat.license.ILicenseFamily[]</tt></li> |
| |
| <li><b>Since</b>: <tt>0.8</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /> |
| <p><b><a name="licenseMatchers">licenseMatchers</a>:</b></p> |
| |
| <div><b>Deprecated.</b> Use <tt>licenses</tt> instead.</div> |
| |
| <div>Specifies the licenses to accept. Deprecated, use |
| <tt>licenses</tt> instead.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>org.apache.rat.mp.HeaderMatcherSpecification[]</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /> |
| <p><b><a name="licenses">licenses</a>:</b></p> |
| |
| <div>Specifies the licenses to accept. By default, these are added to |
| the default licenses, unless you set |
| <tt>addDefaultLicenseMatchers</tt> to false.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>org.apache.rat.analysis.IHeaderMatcher[]</tt></li> |
| |
| <li><b>Since</b>: <tt>0.8</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /> |
| <p><b><a name="numUnapprovedLicenses">numUnapprovedLicenses</a>:</b></p> |
| |
| <div>Maximum number of files with unapproved licenses.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>int</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.numUnapprovedLicenses</tt></li> |
| |
| <li><b>Default</b>: <tt>0</tt></li> |
| </ul><hr /> |
| <p><b><a name="parseSCMIgnoresAsExcludes">parseSCMIgnoresAsExcludes</a>:</b></p> |
| |
| <div>Whether to parse source code management system (SCM) ignore files |
| and use their contents as excludes. At the moment this works for |
| the following SCMs:</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.parseSCMIgnoresAsExcludes</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /> |
| <p><b><a name="reportFile">reportFile</a>:</b></p> |
| |
| <div>Where to store the report.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.outputFile</tt></li> |
| |
| <li><b>Default</b>: <tt>${project.build.directory}/rat.txt</tt></li> |
| </ul><hr /> |
| <p><b><a name="reportStyle">reportStyle</a>:</b></p> |
| |
| <div>Output style of the report. Use "plain" (the default) for a plain |
| text report or "xml" for the raw XML report. Alternatively you can |
| give the path of an XSL transformation that will be applied on the |
| raw XML to produce the report written to the output file.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.outputStyle</tt></li> |
| |
| <li><b>Default</b>: <tt>plain</tt></li> |
| </ul><hr /> |
| <p><b><a name="skip">skip</a>:</b></p> |
| |
| <div>Will skip the plugin execution, e.g. for technical builds that do |
| not take license compliance into account.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Since</b>: <tt>0.11</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.skip</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /> |
| <p><b><a name="useDefaultExcludes">useDefaultExcludes</a>:</b></p> |
| |
| <div>Whether to use the default excludes when scanning for files. The |
| default excludes are: |
| |
| <ul> |
| |
| <li>meta data files for source code management / revision control |
| systems, see <tt>SourceCodeManagementSystems</tt></li> |
| |
| <li>temporary files used by Maven, see <a href="#useMavenDefaultExcludes">useMavenDefaultExcludes</a></li> |
| |
| <li>configuration files for Eclipse, see <a href="#useEclipseDefaultExcludes">useEclipseDefaultExcludes</a></li> |
| |
| <li>configuration files for IDEA, see <a href="#useIdeaDefaultExcludes">useIdeaDefaultExcludes</a></li> |
| </ul></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.useDefaultExcludes</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /> |
| <p><b><a name="useEclipseDefaultExcludes">useEclipseDefaultExcludes</a>:</b></p> |
| |
| <div>Whether to use the Eclipse specific default excludes when scanning |
| for files. Eclipse specific default excludes are given by the |
| constant ECLIPSE_DEFAULT_EXCLUDES: The <tt>.classpath</tt> and |
| <tt>.project</tt> files, the <tt>.settings</tt> directory, |
| and so on.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.useEclipseDefaultExcludes</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /> |
| <p><b><a name="useIdeaDefaultExcludes">useIdeaDefaultExcludes</a>:</b></p> |
| |
| <div>Whether to use the IDEA specific default excludes when scanning for |
| files. IDEA specific default excludes are given by the constant |
| IDEA_DEFAULT_EXCLUDES: The <tt>*.iml</tt>, <tt>*.ipr</tt> |
| and <tt>*.iws</tt> files and the <tt>.idea</tt> directory.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.useIdeaDefaultExcludes</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /> |
| <p><b><a name="useMavenDefaultExcludes">useMavenDefaultExcludes</a>:</b></p> |
| |
| <div>Whether to use the Maven specific default excludes when scanning |
| for files. Maven specific default excludes are given by the |
| constant MAVEN_DEFAULT_EXCLUDES: The <tt>target</tt> directory, |
| the <tt>cobertura.ser</tt> file, and so on.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>rat.useMavenDefaultExcludes</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| <?xml version="1.0" encoding="UTF-8"?> |
| <footer>Copyright © 2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache Rat, Apache Tentacles, Apache Whisker, Apache and the Apache feather logo are trademarks |
| of The Apache Software Foundation. |
| Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners.</footer> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
