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</edi The copyright message String
editLicense="true" tCopyright> to use in the license
editCopyright="data" headers. Usually in
> the form of
</rat:report> "Copyright 2008 Foo".
Only valid with
--edit-license
--edit-overwrite <rat:report <editOverwrite>true</ed Forces any changes in -- none --
editLicense="true" itOverwrite> files to be written
editOverwrite="true" directly to the
> source files so that
</rat:report> new files are not
created. Only valid
with --edit-license.
--edit-license <rat:report <editLicense>true</edit Add the Apache-2.0 -- none --
editLicense="true"> License> 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 names for system File
<configs> <fileset <file>File1</file> configuration.
file='data' /> <file>File2</file>
</configs> </config>
</rat:report>
--configuration-no-def <rat:report <configurationNoDefault Ignore default -- none --
aults configurationNoDefau s>true</configuration configuration.
lts="true"> NoDefaults>
</rat:report>
--licenses-approved <rat:report> <licensesApproved>Licen A comma separated list LicenseID
<licensesApproved><lst seID</licensesApprove of approved License
>data</lst> d> IDs. These licenses
</licensesApproved> will be added to the
</rat:report> list of approved
licenses.
--licenses-approved-fi <rat:report> <licensesApprovedFile>F Name of file containing File
le <licensesApproved> ile</licensesApproved comma separated lists
<fileset file='data' File> of approved License
/> IDs.
</licensesApproved>
</rat:report>
--license-families-app <rat:report> <licenseFamiliesApprove A comma separated list FamilyID
roved <licenseFamiliesApprov d>FamilyID</licenseFa of approved license
ed><lst>data</lst> miliesApproved> family IDs. These
</licenseFamiliesAppro license families will
ved> be added to the list
</rat:report> of approved license
families.
--license-families-app <rat:report> <licenseFamiliesApprove Name of file containing File
roved-file <licenseFamiliesApprov dFile>File</licenseFa comma separated lists
ed> <fileset miliesApprovedFile> of approved family
file='data' /> IDs.
</licenseFamiliesAppro
ved>
</rat:report>
--licenses-denied <rat:report> <licensesDenied>License A comma separated list LicenseID
<licensesDenied><lst>d ID</licensesDenied> of denied License
ata</lst> IDs. These licenses
</licensesDenied> will be removed from
</rat:report> the list of approved
licenses. Once
licenses are removed
they can not be added
back.
--licenses-denied-file <rat:report> <licensesDeniedFile>Fil Name of file containing File
<licensesDenied> e</licensesDeniedFile comma separated lists
<fileset file='data' > of the denied license
/> IDs. These licenses
</licensesDenied> will be removed from
</rat:report> 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</licenseFami of denied License
><lst>data</lst> liesDenied> 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> <licenseFamiliesDeniedF Name of file containing File
ied-file <licenseFamiliesDenied ile>File</licenseFami comma separated lists
> <fileset liesDeniedFile> of denied license
file='data' /> IDs. These license
</licenseFamiliesDenie families will be
d> removed from the list
</rat:report> of approved licenses.
Once license families
are removed they can
not be added back.
--counter-max <rat:report> <counterMax> The acceptable maximum CounterPattern
<counterMaxs><cntr>dat number for the
a</cntr> <counterPattern>Count specified counter. A
</counterMaxs> erPattern1</counterPa value of '-1'
</rat:report> ttern> specifies an
unlimited number.
<counterPattern>Count
erPattern2</counterPa
ttern>
</counterMax>
--counter-min <rat:report> <counterMin> The minimum number for CounterPattern
<counterMins><cntr>dat the specified
a</cntr> <counterPattern>Count counter.
</counterMins> erPattern1</counterPa
</rat:report> ttern>
<counterPattern>Count
erPattern2</counterPa
ttern>
</counterMin>
--input-source <inputSource> A file containing file File
<file>File1</file> names to process.
<file>File2</file> File names must use
</inputSource> 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> Excludes files matching Expression
<inputExcludes><expr>d <Expression>.
ata</expr> <expression>Expressio
</inputExcludes> n1</expression>
</rat:report>
<expression>Expressio
n2</expression>
</inputExclude>
--input-exclude-file <rat:report> <inputExcludeFile>File< Reads <Expression> File
<inputExcludes> /inputExcludeFile> entries from a file.
<fileset file='data' Entries will be
/> excluded from
</inputExcludes> processing.
</rat:report>
--input-exclude-std <rat:report> <inputExcludeStd> Excludes files defined StandardCollection
<inputExcludes><std>da in standard
ta</std> <standardCollection>S collections based on
</inputExcludes> tandardCollection1</s commonly occurring
</rat:report> tandardCollection> groups. Excludes any
path matcher actions
<standardCollection>S but DOES NOT exclude
tandardCollection2</s any file processor
tandardCollection> actions.
</inputExcludeStd>
--input-exclude-size <rat:report <inputExcludeSize>Integ Excludes files with Integer
inputExcludeSize="da er</inputExcludeSize> sizes less than the
ta"> number of bytes
</rat:report> specified.
--input-include <rat:report> <inputInclude> Includes files matching Expression
<inputIncludes><expr>d <Expression>. Will
ata</expr> <expression>Expressio override excluded
</inputIncludes> n1</expression> files.
</rat:report>
<expression>Expressio
n2</expression>
</inputInclude>
--input-include-file <rat:report> <inputIncludeFile>File< Reads <Expression> File
<inputIncludes> /inputIncludeFile> entries from a file.
<fileset file='data' Entries will override
/> excluded files.
</inputIncludes>
</rat:report>
--input-include-std <rat:report> <inputIncludeStd> Includes files defined StandardCollection
<inputIncludes><std>da in standard
ta</std> <standardCollection>S collections based on
</inputIncludes> tandardCollection1</s commonly occurring
</rat:report> tandardCollection> groups. Includes any
path matcher actions
<standardCollection>S but DOES NOT include
tandardCollection2</s any file processor
tandardCollection> actions.
</inputIncludeStd>
--input-exclude-parsed <rat:report> <inputExcludeParsedScm> Parse SCM based StandardCollection
-scm <inputExcludeParsedScm exclusion files to
s><std>data</std> <standardCollection>S exclude specified
</inputExcludeParsedSc tandardCollection1</s files and
ms> tandardCollection> directories. This
</rat:report> action can apply to
<standardCollection>S any standard
tandardCollection2</s collection that
tandardCollection> implements a file
</inputExcludeParsedScm processor.
>
--output-style <rat:report <outputStyle>StyleSheet XSLT stylesheet to use StyleSheet
outputStyle="data"> </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>License List the defined LicenseFilter
outputLicenses="data Filter</outputLicense licenses.
"> s>
</rat:report>
--output-families <rat:report <outputFamilies>License List the defined LicenseFilter
outputFamilies="data Filter</outputFamilie license families.
"> s>
</rat:report>
--log-level Sets the log level. LogLevel
--dry-run <rat:report <dryRun>true</dryRun> If set do not update -- none --
dryRun="true"> the files but
</rat:report> generate the reports.
--output-file <rat:report <outputFile>File</outpu Define the output file File
outputFile="data"> tFile> where to write a
</rat:report> report to.
--output-archive <rat:report <outputArchive>Processi Specifies the level of ProcessingType
outputArchive="data" ngType</outputArchive detail in ARCHIVE
> > file reporting.
</rat:report>
--output-standard <rat:report <outputStandard>Process Specifies the level of ProcessingType
outputStandard="data ingType</outputStanda detail in STANDARD
"> rd> file reporting.
</rat:report>
--help-licenses <helpLicenses>true</hel Print information about -- none --
pLicenses> registered licenses.
--help Print help for the RAT -- none --
command line
interface and exit.