Apache RAT
MavenOption Overview
The following lists the options that are available in all clients.
CLI Ant Maven Description Argument Type
--edit-copyright <rat:report <editCopyright>Arg</ed The copyright message to String
editLicense="true" itCopyright> use in the license
editCopyright="data" headers. Usually in
> the form of "Copyright
</rat:report> 2008 Foo". Only valid
with --edit-license
--edit-overwrite <rat:report <editOverwrite /> Forces any changes in -- none --
editLicense="true" files to be written
editOverwrite="true" directly to the source
> files so that new
</rat:report> files are not created.
Only valid with
--edit-license.
--edit-license <rat:report <editLicense /> Add the Apache-2.0 -- none --
editLicense="true"> license header to any
</rat:report> file with an unknown
license that is not in
the exclusion list. By
default new files will
be created with the
license header, to
force the modification
of existing files use
the --edit-overwrite
option.
--config <rat:report> <config>File</config> File names for system File
<config> <fileset configuration.
file='data' />
</config>
</rat:report>
--configuration-no-def <rat:report <configurationNoDefaul Ignore default -- none --
aults configurationNoDefau ts /> configuration.
lts="true">
</rat:report>
--licenses-approved <rat:report> <licensesApproved>Lice A comma separated list LicenseID
<licensesApproved><lst nseID</licensesAppro of approved License
>data</lst> ved> IDs. These licenses
</licensesApproved> will be added to the
</rat:report> list of approved
licenses.
--licenses-approved-fi <rat:report> <licensesApprovedFile> Name of file containing File
le <licensesApproved><fil File</licensesApprov comma separated lists
ename>data</filename edFile> of approved License
> IDs.
</licensesApproved>
</rat:report>
--license-families-app <rat:report> <licenseFamiliesApprov A comma separated list FamilyID
roved <licenseFamiliesApprov ed>FamilyID</license of approved license
ed><lst>data</lst> FamiliesApproved> family IDs. These
</licenseFamiliesAppro license families will
ved> be added to the list
</rat:report> of approved license
families.
--license-families-app <rat:report> <licenseFamiliesApprov Name of file containing File
roved-file <licenseFamiliesApprov edFile>File</license comma separated lists
ed><filename>data</f FamiliesApprovedFile of approved family
ilename> > IDs.
</licenseFamiliesAppro
ved>
</rat:report>
--licenses-denied <rat:report> <licensesDenied>Licens A comma separated list LicenseID
<licensesDenied><lst>d eID</licensesDenied> of denied License IDs.
ata</lst> These licenses will be
</licensesDenied> removed from the list
</rat:report> of approved licenses.
Once licenses are
removed they can not
be added back.
--licenses-denied-file <rat:report> <licensesDeniedFile>Fi Name of file containing File
<licensesDenied><filen le</licensesDeniedFi comma separated lists
ame>data</filename> le> of the denied license
</licensesDenied> IDs. These licenses
</rat:report> will be removed from
the list of approved
licenses. Once
licenses are removed
they can not be added
back.
--license-families-den <rat:report> <licenseFamiliesDenied A comma separated list FamilyID
ied <licenseFamiliesDenied >FamilyID</licenseFa of denied License
><lst>data</lst> miliesDenied> family IDs. These
</licenseFamiliesDenie license families will
d> be removed from the
</rat:report> list of approved
licenses. Once license
families are removed
they can not be added
back.
--license-families-den <rat:report> <licenseFamiliesDenied Name of file containing File
ied-file <licenseFamiliesDenied File>File</licenseFa comma separated lists
><filename>data</fil miliesDeniedFile> of denied license IDs.
ename> These license families
</licenseFamiliesDenie will be removed from
d> the list of approved
</rat:report> licenses. Once license
families are removed
they can not be added
back.
--counter-max <rat:report> <counterMax>CounterPat The acceptable maximum CounterPattern
<counterMax><cntr>data tern</counterMax> number for the
</cntr> specified counter. A
</counterMax> value of '-1'
</rat:report> specifies an unlimited
number.
--counter-min <rat:report> <counterMin>CounterPat The minimum number for CounterPattern
<counterMin><cntr>data tern</counterMin> the specified counter.
</cntr>
</counterMin>
</rat:report>
--input-source -- not supported -- <inputSource>File</inp A file containing file File
utSource> names to process. File
names must use linux
directory separator
('/') or none at all.
File names that do not
start with '/' are
relative to the
directory where the
argument is located.
--input-exclude <rat:report> <inputExclude>Expressi Excludes files matching Expression
<inputExclude><expr>da on</inputExclude> <Expression>.
ta</expr>
</inputExclude>
</rat:report>
--input-exclude-file <rat:report> <inputExcludeFile>File Reads <Expression> File
<inputExclude><filenam </inputExcludeFile> entries from a file.
e>data</filename> Entries will be
</inputExclude> excluded from
</rat:report> processing.
--input-exclude-std <rat:report> <inputExcludeStd>Stand Excludes files defined StandardCollection
<inputExclude><std>dat ardCollection</input in standard
a</std> ExcludeStd> collections based on
</inputExclude> commonly occurring
</rat:report> groups. Excludes any
path matcher actions
but DOES NOT exclude
any file processor
actions.
--input-exclude-size <rat:report <inputExcludeSize>Inte Excludes files with Integer
inputExcludeSize="da ger</inputExcludeSiz sizes less than the
ta"> e> number of bytes
</rat:report> specified.
--input-include <rat:report> <inputInclude>Expressi Includes files matching Expression
<inputInclude><expr>da on</inputInclude> <Expression>. Will
ta</expr> override excluded
</inputInclude> files.
</rat:report>
--input-include-file <rat:report> <inputIncludeFile>File Reads <Expression> File
<inputInclude><filenam </inputIncludeFile> entries from a file.
e>data</filename> Entries will override
</inputInclude> excluded files.
</rat:report>
--input-include-std <rat:report> <inputIncludeStd>Stand Includes files defined StandardCollection
<inputInclude><std>dat ardCollection</input in standard
a</std> IncludeStd> collections based on
</inputInclude> commonly occurring
</rat:report> groups. Includes any
path matcher actions
but DOES NOT include
any file processor
actions.
--input-exclude-parsed <rat:report> <inputExcludeParsedScm Parse SCM based StandardCollection
-scm <inputExcludeParsedScm >StandardCollection< exclusion files to
><std>data</std> /inputExcludeParsedS exclude specified
</inputExcludeParsedSc cm> files and directories.
m> This action can apply
</rat:report> to any standard
collection that
implements a file
processor.
--output-style <rat:report <outputStyle>StyleShee XSLT stylesheet to use StyleSheet
outputStyle="data"> t</outputStyle> when creating the
</rat:report> report. Either an
external xsl file may
be specified or one of
the internal named
sheets.
--output-licenses <rat:report <outputLicenses>Licens List the defined LicenseFilter
outputLicenses="data eFilter</outputLicen licenses.
"> ses>
</rat:report>
--output-families <rat:report <outputFamilies>Licens List the defined license LicenseFilter
outputFamilies="data eFilter</outputFamil families.
"> ies>
</rat:report>
--log-level -- not supported -- -- not supported -- Sets the log level. LogLevel
--dry-run <rat:report <dryRun /> If set do not update the -- none --
dryRun="true"> files but generate the
</rat:report> reports.
--output-file <rat:report <outputFile>File</outp Define the output file File
outputFile="data"> utFile> where to write a
</rat:report> report to.
--output-archive <rat:report <outputArchive>Process Specifies the level of ProcessingType
outputArchive="data" ingType</outputArchi detail in ARCHIVE file
> ve> reporting.
</rat:report>
--output-standard <rat:report <outputStandard>Proces Specifies the level of ProcessingType
outputStandard="data singType</outputStan detail in STANDARD
"> dard> file reporting.
</rat:report>
--help-licenses <rat:report <helpLicenses /> Print information about -- none --
helpLicenses="true"> registered licenses.
</rat:report>
--help -- not supported -- -- not supported -- Print help for the RAT -- none --
command line interface
and exit.