| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.12.0:report at 2024-04-28 |
| |
| | Rendered using Apache Maven Default Skin |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> |
| <title>Apache Rat™ Plugin for Apache Maven – apache-rat:check</title> |
| <link rel="stylesheet" href="./css/maven-base.css" /> |
| <link rel="stylesheet" href="./css/maven-theme.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <link href="https://creadur.apache.org/font/matesc.css" type="text/css" rel="stylesheet" /> |
| </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: 2024-04-28</span> |
| | <span id="projectVersion">Version: 0.17-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="index.html" 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://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Privacy">Privacy</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://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"> |
| <section> |
| <h2><a name="apache-rat:check"></a>apache-rat:check</h2><a name="apache-rat:check"></a> |
| <p><strong>Full name</strong>:</p> |
| <p>org.apache.rat:apache-rat-plugin:0.17-SNAPSHOT:check</p> |
| <p><strong>Description</strong>:</p> |
| <p>Run Rat to perform a violation check.</p> |
| <p><strong>Attributes</strong>:</p> |
| <ul> |
| <li>Requires a Maven project to be executed.</li> |
| <li>The goal is thread-safe and supports parallel builds.</li> |
| <li>Binds by default to the <a class="externalLink" href="https://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>validate</code>.</li></ul><section> |
| <h3><a name="Required_Parameters"></a>Required Parameters</h3><a name="Required_Parameters"></a> |
| <table border="0" class="bodyTable"> |
| <tr class="a"> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td align="left"><a href="#basedir"><code><basedir></code></a></td> |
| <td><code>File</code></td> |
| <td><code>-</code></td> |
| <td>The base directory, in which to search for files.<br /><strong>Default</strong>: <code>${basedir}</code><br /><strong>User Property</strong>: <code>rat.basedir</code></td></tr></table></section><section> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> |
| <table border="0" class="bodyTable"> |
| <tr class="a"> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td align="left"><a href="#addDefaultLicenseMatchers"><code><addDefaultLicenseMatchers></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to add the default list of license matchers.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.addDefaultLicenseMatchers</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#addDefaultLicenses"><code><addDefaultLicenses></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to add the default list of licenses.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.addDefaultLicenses</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#addLicenseHeaders"><code><addLicenseHeaders></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>Whether to add license headers; possible values are <code>forced</code>, <code>true</code>, and <code>false</code> (default).<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>rat.addLicenseHeaders</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#additionalLicenseFiles"><code><additionalLicenseFiles></code></a></td> |
| <td><code>String[]</code></td> |
| <td><code>-</code></td> |
| <td>No description.</td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#approvedLicenseFile"><code><approvedLicenseFile></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>No description.<br /><strong>User Property</strong>: <code>rat.approvedFile</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#approvedLicenses"><code><approvedLicenses></code></a></td> |
| <td><code>String[]</code></td> |
| <td><code>-</code></td> |
| <td>No description.</td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#consoleOutput"><code><consoleOutput></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>0.12</code></td> |
| <td>Whether to output the names of files that have unapproved licenses to the console. Defaults to <code>true</code> to ease builds in containers where you are unable to access rat.txt easily.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.consoleOutput</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#copyrightMessage"><code><copyrightMessage></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>Copyright message to add to license headers. This option is ignored, unless <code>addLicenseHeaders</code> is set to <code>true</code>, or <code>forced</code>.<br /><strong>User Property</strong>: <code>rat.copyrightMessage</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#defaultLicenseFiles"><code><defaultLicenseFiles></code></a></td> |
| <td><code>String[]</code></td> |
| <td><code>0.8</code></td> |
| <td>Specifies the licenses to accept. By default, these are added to the default licenses, unless you set <code>addDefaultLicenseMatchers</code><!-- no javadoc sites associated --> to false.</td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#excludeSubProjects"><code><excludeSubProjects></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to exclude subprojects. This is recommended, if you want a separate apache-rat-plugin report for each subproject.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.excludeSubprojects</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#excludes"><code><excludes></code></a></td> |
| <td><code>String[]</code></td> |
| <td><code>-</code></td> |
| <td>Specifies files, which are excluded in the report. By default, no files are excluded.</td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#excludesFile"><code><excludesFile></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></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 /><strong>User Property</strong>: <code>rat.excludesFile</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#excludesFileCharset"><code><excludesFileCharset></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.<br /><strong>Default</strong>: <code>${project.build.sourceEncoding}</code><br /><strong>User Property</strong>: <code>rat.excludesFileCharset</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#families"><code><families></code></a></td> |
| <td><code>Family[]</code></td> |
| <td><code>-</code></td> |
| <td>No description.</td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#ignoreErrors"><code><ignoreErrors></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>0.9</code></td> |
| <td>Will ignore rat errors and display a log message if any. Its use is NOT RECOMMENDED, but quite convenient on occasion.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>rat.ignoreErrors</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#includes"><code><includes></code></a></td> |
| <td><code>String[]</code></td> |
| <td><code>-</code></td> |
| <td>Specifies files, which are included in the report. By default, all files are included.</td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#includesFile"><code><includesFile></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>Specifies a file, from which to read includes. Basically, an alternative to specifying the includes as a list.<br /><strong>User Property</strong>: <code>rat.includesFile</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#includesFileCharset"><code><includesFileCharset></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.<br /><strong>Default</strong>: <code>${project.build.sourceEncoding}</code><br /><strong>User Property</strong>: <code>rat.includesFileCharset</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#licenseFamilies"><code><licenseFamilies></code></a></td> |
| <td><code>SimpleLicenseFamily[]</code></td> |
| <td><code>0.8</code></td> |
| <td> |
| <div><strong>Deprecated.</strong><br />No reason given</div><br />Specifies the license families to accept.</td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#licenses"><code><licenses></code></a></td> |
| <td><code>Object[]</code></td> |
| <td><code>-</code></td> |
| <td> |
| <div><strong>Deprecated.</strong><br />No reason given</div><br />This is an object to accept both License of DeprecatedConfig objects.</td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#numUnapprovedLicenses"><code><numUnapprovedLicenses></code></a></td> |
| <td><code>int</code></td> |
| <td><code>-</code></td> |
| <td>Maximum number of files with unapproved licenses.<br /><strong>Default</strong>: <code>0</code><br /><strong>User Property</strong>: <code>rat.numUnapprovedLicenses</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#parseSCMIgnoresAsExcludes"><code><parseSCMIgnoresAsExcludes></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></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 /><strong>See also:</strong> org.apache.rat.config.SourceCodeManagementSystems<!-- no javadoc sites associated --><br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.parseSCMIgnoresAsExcludes</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#reportFile"><code><reportFile></code></a></td> |
| <td><code>File</code></td> |
| <td><code>-</code></td> |
| <td>Where to store the report.<br /><strong>Default</strong>: <code>${project.build.directory}/rat.txt</code><br /><strong>User Property</strong>: <code>rat.outputFile</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#reportStyle"><code><reportStyle></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></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 /><strong>Default</strong>: <code>plain</code><br /><strong>User Property</strong>: <code>rat.outputStyle</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#scanHiddenDirectories"><code><scanHiddenDirectories></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>No description.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>rat.scanHiddenDirectories</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#skip"><code><skip></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>0.11</code></td> |
| <td>Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>rat.skip</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#useDefaultExcludes"><code><useDefaultExcludes></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></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 <code>org.apache.rat.config.SourceCodeManagementSystems</code><!-- no javadoc sites associated --></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 /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.useDefaultExcludes</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#useEclipseDefaultExcludes"><code><useEclipseDefaultExcludes></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></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 <code>.classpath</code> and <code>.project</code> files, the <code>.settings</code> directory, and so on.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.useEclipseDefaultExcludes</code></td></tr> |
| <tr class="b"> |
| <td align="left"><a href="#useIdeaDefaultExcludes"><code><useIdeaDefaultExcludes></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></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 <code>*.iml</code>, <code>*.ipr</code> and <code>*.iws</code> files and the <code>.idea</code> directory.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.useIdeaDefaultExcludes</code></td></tr> |
| <tr class="a"> |
| <td align="left"><a href="#useMavenDefaultExcludes"><code><useMavenDefaultExcludes></code></a></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></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 <code>target</code> directory, the <code>cobertura.ser</code> file, and so on.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>rat.useMavenDefaultExcludes</code></td></tr></table></section><section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="addDefaultLicenseMatchers"><section> |
| <h4><a name="a.3CaddDefaultLicenseMatchers.3E"></a><addDefaultLicenseMatchers></h4><a name="a.3CaddDefaultLicenseMatchers.3E"></a></a> |
| <div>Whether to add the default list of license matchers.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.addDefaultLicenseMatchers</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="addDefaultLicenses"><section> |
| <h4><a name="a.3CaddDefaultLicenses.3E"></a><addDefaultLicenses></h4><a name="a.3CaddDefaultLicenses.3E"></a></a> |
| <div>Whether to add the default list of licenses.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.addDefaultLicenses</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="addLicenseHeaders"><section> |
| <h4><a name="a.3CaddLicenseHeaders.3E"></a><addLicenseHeaders></h4><a name="a.3CaddLicenseHeaders.3E"></a></a> |
| <div>Whether to add license headers; possible values are <code>forced</code>, <code>true</code>, and <code>false</code> (default).</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.addLicenseHeaders</code></li> |
| <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="additionalLicenseFiles"><section> |
| <h4><a name="a.3CadditionalLicenseFiles.3E"></a><additionalLicenseFiles></h4><a name="a.3CadditionalLicenseFiles.3E"></a></a> |
| <div>No description.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String[]</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="approvedLicenseFile"><section> |
| <h4><a name="a.3CapprovedLicenseFile.3E"></a><approvedLicenseFile></h4><a name="a.3CapprovedLicenseFile.3E"></a></a> |
| <div>No description.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.approvedFile</code></li></ul><hr /></section><a name="approvedLicenses"><section> |
| <h4><a name="a.3CapprovedLicenses.3E"></a><approvedLicenses></h4><a name="a.3CapprovedLicenses.3E"></a></a> |
| <div>No description.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String[]</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="basedir"><section> |
| <h4><a name="a.3Cbasedir.3E"></a><basedir></h4><a name="a.3Cbasedir.3E"></a></a> |
| <div>The base directory, in which to search for files.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.io.File</code></li> |
| <li><strong>Required</strong>: <code>Yes</code></li> |
| <li><strong>User Property</strong>: <code>rat.basedir</code></li> |
| <li><strong>Default</strong>: <code>${basedir}</code></li></ul><hr /></section><a name="consoleOutput"><section> |
| <h4><a name="a.3CconsoleOutput.3E"></a><consoleOutput></h4><a name="a.3CconsoleOutput.3E"></a></a> |
| <div>Whether to output the names of files that have unapproved licenses to the console. Defaults to <code>true</code> to ease builds in containers where you are unable to access rat.txt easily.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>0.12</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.consoleOutput</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="copyrightMessage"><section> |
| <h4><a name="a.3CcopyrightMessage.3E"></a><copyrightMessage></h4><a name="a.3CcopyrightMessage.3E"></a></a> |
| <div>Copyright message to add to license headers. This option is ignored, unless <code>addLicenseHeaders</code> is set to <code>true</code>, or <code>forced</code>.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.copyrightMessage</code></li></ul><hr /></section><a name="defaultLicenseFiles"><section> |
| <h4><a name="a.3CdefaultLicenseFiles.3E"></a><defaultLicenseFiles></h4><a name="a.3CdefaultLicenseFiles.3E"></a></a> |
| <div>Specifies the licenses to accept. By default, these are added to the default licenses, unless you set <code>addDefaultLicenseMatchers</code><!-- no javadoc sites associated --> to false.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String[]</code></li> |
| <li><strong>Since</strong>: <code>0.8</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="excludeSubProjects"><section> |
| <h4><a name="a.3CexcludeSubProjects.3E"></a><excludeSubProjects></h4><a name="a.3CexcludeSubProjects.3E"></a></a> |
| <div>Whether to exclude subprojects. This is recommended, if you want a separate apache-rat-plugin report for each subproject.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.excludeSubprojects</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="excludes"><section> |
| <h4><a name="a.3Cexcludes.3E"></a><excludes></h4><a name="a.3Cexcludes.3E"></a></a> |
| <div>Specifies files, which are excluded in the report. By default, no files are excluded.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String[]</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="excludesFile"><section> |
| <h4><a name="a.3CexcludesFile.3E"></a><excludesFile></h4><a name="a.3CexcludesFile.3E"></a></a> |
| <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><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.excludesFile</code></li></ul><hr /></section><a name="excludesFileCharset"><section> |
| <h4><a name="a.3CexcludesFileCharset.3E"></a><excludesFileCharset></h4><a name="a.3CexcludesFileCharset.3E"></a></a> |
| <div>Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.excludesFileCharset</code></li> |
| <li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li></ul><hr /></section><a name="families"><section> |
| <h4><a name="a.3Cfamilies.3E"></a><families></h4><a name="a.3Cfamilies.3E"></a></a> |
| <div>No description.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>org.apache.rat.mp.Family[]</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="ignoreErrors"><section> |
| <h4><a name="a.3CignoreErrors.3E"></a><ignoreErrors></h4><a name="a.3CignoreErrors.3E"></a></a> |
| <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><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>0.9</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.ignoreErrors</code></li> |
| <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="includes"><section> |
| <h4><a name="a.3Cincludes.3E"></a><includes></h4><a name="a.3Cincludes.3E"></a></a> |
| <div>Specifies files, which are included in the report. By default, all files are included.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String[]</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="includesFile"><section> |
| <h4><a name="a.3CincludesFile.3E"></a><includesFile></h4><a name="a.3CincludesFile.3E"></a></a> |
| <div>Specifies a file, from which to read includes. Basically, an alternative to specifying the includes as a list.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.includesFile</code></li></ul><hr /></section><a name="includesFileCharset"><section> |
| <h4><a name="a.3CincludesFileCharset.3E"></a><includesFileCharset></h4><a name="a.3CincludesFileCharset.3E"></a></a> |
| <div>Specifies the include files character set. Defaults to @code{${project.build.sourceEncoding}), or @code{UTF8}.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.includesFileCharset</code></li> |
| <li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li></ul><hr /></section><a name="licenseFamilies"><section> |
| <h4><a name="a.3ClicenseFamilies.3E"></a><licenseFamilies></h4><a name="a.3ClicenseFamilies.3E"></a></a> |
| <div><strong>Deprecated.</strong><br />No reason given</div><br /> |
| <div>Specifies the license families to accept.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>org.apache.rat.license.SimpleLicenseFamily[]</code></li> |
| <li><strong>Since</strong>: <code>0.8</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="licenses"><section> |
| <h4><a name="a.3Clicenses.3E"></a><licenses></h4><a name="a.3Clicenses.3E"></a></a> |
| <div><strong>Deprecated.</strong><br />No reason given</div><br /> |
| <div>This is an object to accept both License of DeprecatedConfig objects.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.Object[]</code></li> |
| <li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="numUnapprovedLicenses"><section> |
| <h4><a name="a.3CnumUnapprovedLicenses.3E"></a><numUnapprovedLicenses></h4><a name="a.3CnumUnapprovedLicenses.3E"></a></a> |
| <div>Maximum number of files with unapproved licenses.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>int</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.numUnapprovedLicenses</code></li> |
| <li><strong>Default</strong>: <code>0</code></li></ul><hr /></section><a name="parseSCMIgnoresAsExcludes"><section> |
| <h4><a name="a.3CparseSCMIgnoresAsExcludes.3E"></a><parseSCMIgnoresAsExcludes></h4><a name="a.3CparseSCMIgnoresAsExcludes.3E"></a></a> |
| <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:<br /><strong>See also:</strong> org.apache.rat.config.SourceCodeManagementSystems<!-- no javadoc sites associated --></div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.parseSCMIgnoresAsExcludes</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="reportFile"><section> |
| <h4><a name="a.3CreportFile.3E"></a><reportFile></h4><a name="a.3CreportFile.3E"></a></a> |
| <div>Where to store the report.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.io.File</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.outputFile</code></li> |
| <li><strong>Default</strong>: <code>${project.build.directory}/rat.txt</code></li></ul><hr /></section><a name="reportStyle"><section> |
| <h4><a name="a.3CreportStyle.3E"></a><reportStyle></h4><a name="a.3CreportStyle.3E"></a></a> |
| <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><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.outputStyle</code></li> |
| <li><strong>Default</strong>: <code>plain</code></li></ul><hr /></section><a name="scanHiddenDirectories"><section> |
| <h4><a name="a.3CscanHiddenDirectories.3E"></a><scanHiddenDirectories></h4><a name="a.3CscanHiddenDirectories.3E"></a></a> |
| <div>No description.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.scanHiddenDirectories</code></li> |
| <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="skip"><section> |
| <h4><a name="a.3Cskip.3E"></a><skip></h4><a name="a.3Cskip.3E"></a></a> |
| <div>Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>0.11</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.skip</code></li> |
| <li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="useDefaultExcludes"><section> |
| <h4><a name="a.3CuseDefaultExcludes.3E"></a><useDefaultExcludes></h4><a name="a.3CuseDefaultExcludes.3E"></a></a> |
| <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 <code>org.apache.rat.config.SourceCodeManagementSystems</code><!-- no javadoc sites associated --></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><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.useDefaultExcludes</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="useEclipseDefaultExcludes"><section> |
| <h4><a name="a.3CuseEclipseDefaultExcludes.3E"></a><useEclipseDefaultExcludes></h4><a name="a.3CuseEclipseDefaultExcludes.3E"></a></a> |
| <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 <code>.classpath</code> and <code>.project</code> files, the <code>.settings</code> directory, and so on.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.useEclipseDefaultExcludes</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="useIdeaDefaultExcludes"><section> |
| <h4><a name="a.3CuseIdeaDefaultExcludes.3E"></a><useIdeaDefaultExcludes></h4><a name="a.3CuseIdeaDefaultExcludes.3E"></a></a> |
| <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 <code>*.iml</code>, <code>*.ipr</code> and <code>*.iws</code> files and the <code>.idea</code> directory.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.useIdeaDefaultExcludes</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="useMavenDefaultExcludes"><section> |
| <h4><a name="a.3CuseMavenDefaultExcludes.3E"></a><useMavenDefaultExcludes></h4><a name="a.3CuseMavenDefaultExcludes.3E"></a></a> |
| <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 <code>target</code> directory, the <code>cobertura.ser</code> file, and so on.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>rat.useMavenDefaultExcludes</code></li> |
| <li><strong>Default</strong>: <code>true</code></li></ul></section></section></section> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| Copyright © 2016-2024 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. |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
