Full name:
org.apache.rat:apache-rat-plugin:0.11:check
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| basedir | File | - | The base directory, in which to search for files. Default value is: ${basedir}. User property is: rat.basedir. |
| Name | Type | Since | Description |
|---|---|---|---|
| addDefaultLicenseMatchers | boolean | - | Whether to add the default list of license matchers. Default value is: true. User property is: rat.addDefaultLicenseMatchers. |
| addLicenseHeaders | String | - | Whether to add license headers; possible values are
forced, true, and false
(default). Default value is: false. User property is: rat.addLicenseHeaders. |
| copyrightMessage | String | - | Copyright message to add to license headers. This option is
ignored, unless addLicenseHeaders is set to
true, or forced. User property is: rat.copyrightMessage. |
| excludeSubProjects | boolean | - | Whether to exclude subprojects. This is recommended, if you want a
separate apache-rat-plugin report for each subproject. Default value is: true. User property is: rat.excludeSubprojects. |
| excludes | String[] | - | Specifies files, which are excluded in the report. By default, no
files are excluded. |
| ignoreErrors | boolean | 0.9 | Will ignore rat errors and display a log message if any. Its use is
NOT RECOMMENDED, but quite convenient on occasion. Default value is: false. User property is: rat.ignoreErrors. |
| includes | String[] | - | Specifies files, which are included in the report. By default, all
files are included. |
| licenseFamilies | ILicenseFamily[] | 0.8 | Specifies the license families to accept. |
| licenseMatchers | HeaderMatcherSpecification[] | - | Deprecated. Use licenses instead. |
| licenses | IHeaderMatcher[] | 0.8 | Specifies the licenses to accept. By default, these are added to
the default licenses, unless you set
addDefaultLicenseMatchers to false. |
| numUnapprovedLicenses | int | - | Maximum number of files with unapproved licenses. Default value is: 0. User property is: rat.numUnapprovedLicenses. |
| reportFile | File | - | Where to store the report. Default value is: ${project.build.directory}/rat.txt. User property is: rat.outputFile. |
| reportStyle | String | - | 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. Default value is: plain. User property is: rat.outputStyle. |
| skip | boolean | 0.11 | Will skip the plugin execution, e.g. for technical builds that do
not take licence compliance into account. Default value is: false. User property is: rat.skip. |
| useDefaultExcludes | boolean | - | Whether to use the default excludes when scanning for files. The
default excludes are:
Default value is: true. User property is: rat.useDefaultExcludes. |
| useEclipseDefaultExcludes | boolean | - | 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 .classpath and
.project files, the .settings directory,
and so on. Default value is: true. User property is: rat.useEclipseDefaultExcludes. |
| useIdeaDefaultExcludes | boolean | - | 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 *.iml, *.ipr
and *.iws files and the .idea directory. Default value is: true. User property is: rat.useIdeaDefaultExcludes. |
| useMavenDefaultExcludes | boolean | - | 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 target directory,
the cobertura.ser file, and so on. Default value is: true. User property is: rat.useMavenDefaultExcludes. |
skip: