| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/apt/ant_options.apt at 2025-09-21 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Ant Elements and Attributes – Apache RAT\u2122 Task Library for Apache Ant</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-2.1.0.min.js"></script> |
| <link href="https://creadur.apache.org/font/matesc.css" type="text/css" rel="stylesheet" /> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/creadur-rat" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/"><img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" /> Apache RAT</a></h1></div></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2025-09-21<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 0.17-SNAPSHOT<span class="divider">|</span></li> |
| <li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li> |
| <li><a href="../../">Creadur</a><span class="divider">/</span></li> |
| <li><a href="../">RAT</a><span class="divider">/</span></li> |
| <li><a href="index.html">Apache RAT\u2122 Task Library for Apache Ant</a><span class="divider">/</span></li> |
| <li class="active">Ant Elements and Attributes</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Parent Project</li> |
| <li><a href="../index.html">Apache Creadur RAT</a></li> |
| <li class="nav-header">Overview</li> |
| <li><a href="index.html">Introduction</a></li> |
| <li><a href="report.html">Report Task</a></li> |
| <li class="nav-header">Examples</li> |
| <li><a href="examples/basic.html">Basic Usage</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| <li class="nav-header">Apache RAT™</li> |
| <li><a href="../index.html">Introducing RAT</a></li> |
| <li><a href="../download_rat.cgi">Downloads</a></li> |
| <li><a href="../changes.html">Changes</a></li> |
| <li class="nav-header">RAT from the Command Line</li> |
| <li><a href="../apache-rat/index.html">Command Line Introduction</a></li> |
| <li><a href="../apache-rat/cli_options.html">Command Line Options</a></li> |
| <li><a href="../apache-rat/env_vars.html">Environment Variables</a></li> |
| <li><a href="../apache-rat-core/exclusion_expression.html">Exclusion Expressions</a></li> |
| <li><a href="../apache-rat/standard_collections.html">Standard Collections</a></li> |
| <li class="nav-header">RAT from Ant</li> |
| <li><a href="../apache-rat-tasks/index.html">Ant Task Introduction</a></li> |
| <li><a href="../apache-rat-tasks/ant_options.html">Ant Elements and Attributes</a></li> |
| <li class="nav-header">RAT from Maven</li> |
| <li><a href="../apache-rat-plugin/index.html">Maven Plugin Introduction</a></li> |
| <li><a href="../apache-rat-plugin/mvn_options.html">Maven Options</a></li> |
| <li><a href="../apache-rat-plugin/examples/index.html">Maven Examples</a></li> |
| <li class="nav-header">Configuring RAT</li> |
| <li><a href="../apache-rat/name_xref.html">Option Name Cross Reference</a></li> |
| <li><a href="../apache-rat/default_licenses.html">Default Licenses</a></li> |
| <li><a href="../apache-rat/default_matchers.html">Default Matchers</a></li> |
| <li><a href="../license_def.html">Defining New Licenses</a></li> |
| <li><a href="../apache-rat/xsd.html">Configuration XSD</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml">Default Configuration</a></li> |
| <li><a href="../apache-rat/detecting_generated_files.html">Detecting Generated Files</a></li> |
| <li class="nav-header">RAT Output</li> |
| <li><a href="../apache-rat/output/example.html">Standard Output Example</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd">Output XSD</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl">XSLT - Plain text</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl">XSLT - Missing headers list</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl">XSLT - Unapproved licenses list</a></li> |
| <li class="nav-header">Developing RAT</li> |
| <li><a href="../architecture.html">Architecture</a></li> |
| <li><a href="../apidocs/index.html">Javadocs</a></li> |
| <li><a href="../apache-rat-core/development/document_name.html">Document Name concept</a></li> |
| <li><a href="../development/ui_implementation.html">UI Development</a></li> |
| <li><a href="../apache-rat-core/development/write_file_processor.html">Writing a File Processor</a></li> |
| <li class="nav-header">Apache Creadur™</li> |
| <li><a href="../..">Creadur Project Home</a></li> |
| <li><a href="../../tentacles">Apache Tentacles</a></li> |
| <li><a href="../../whisker">Apache Whisker</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="nav-header">The Apache Software Foundation</li> |
| <li><a href="https://www.apache.org/foundation">About the Foundation</a></li> |
| <li><a href="https://projects.apache.org">The projects</a></li> |
| <li><a href="https://people.apache.org">The people</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How we work</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html#history">Our history</a></li> |
| <li><a href="https://blogs.apache.org/foundation/">News</a></li> |
| <li class="nav-header">Contribute</li> |
| <li><a href="https://www.apache.org/foundation/getinvolved.html">Get Involved</a></li> |
| <li class="nav-header">Committer Info</li> |
| <li><a href="https://www.apache.org/dev/committers.html">ASF Committers' FAQ</a></li> |
| <li><a href="https://www.apache.org/dev/new-committers-guide.html">New Committers Guide</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-site/blob/asf-site/README.md">How to publish this site</a></li> |
| <li><a href="https://community.apache.org/">Community</a></li> |
| <li><a href="https://www.apache.org/legal/">Legal</a></li> |
| <li><a href="https://www.apache.org/foundation/marks/">Branding</a></li> |
| <li><a href="https://www.apache.org/press/">Media Relations</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy"><img class="builtBy" src="https://maven.apache.org/images/logos/maven-feather.png" /> Maven</a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <section><a id="Ant_Elements_and_Attributes"></a> |
| <h1>Ant Elements and Attributes</h1> |
| <p>The RAT Ant Task Library has many of the same options as the command line as well as a few that are specific to the Ant environment. The Ant UI implements the RAT options as attributes or child nodes.</p><section><a id="Root_Node"></a> |
| <h2>Root Node</h2> |
| <p>The <code>report</code> is the root node for the RAT report. All child nodes must be enclosed within it. All attributes listed below are attributes applied to the <code>report</code> node. The report node must have a fileSet to specify the files to process.</p> |
| <pre class="prettyprint"><code><project |
| xmlns:rat="antlib:org.apache.rat.anttasks" |
| xmlns="antlib:org.apache.tools.ant"> |
| ... |
| <rat:report> |
| <fileset dir="path/to/source"/> |
| </rat:report> |
| ... |
| </project></code></pre></section><section><a id="The_Child_Nodes"></a> |
| <h2>The Child Nodes</h2> |
| <p>The argument types specified in the list below are defined in a section following.</p><section><a id="a.3Cconfig.3E"></a> |
| <h3><config></h3> |
| <p>File names for system configuration.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <File></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <config> <fileset file='data' /> </config> </rat:report></li></ul></section><section><a id="a.3CcounterMax.3E"></a> |
| <h3><counterMax></h3> |
| <p>The acceptable maximum number for the specified counter. A value of '-1' specifies an unlimited number.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <CounterPattern></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <counterMax><cntr>data</cntr> </counterMax> </rat:report></li></ul></section><section><a id="a.3CcounterMin.3E"></a> |
| <h3><counterMin></h3> |
| <p>The minimum number for the specified counter.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <CounterPattern></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <counterMin><cntr>data</cntr> </counterMin> </rat:report></li></ul></section><section><a id="a.3Cexclude.3E"></a> |
| <h3><exclude></h3> |
| <p><b>Deprecated for removal since 0.17: Use <inputExclude> instead.</b> Excludes files matching <Expression>.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <Expression></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <exclude><expr>data</expr> </exclude> </rat:report></li></ul></section><section><a id="a.3Cinclude.3E"></a> |
| <h3><include></h3> |
| <p><b>Deprecated for removal since 0.17: Use <inputInclude> instead.</b> Includes files matching <Expression>. Will override excluded files.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <Expression></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <include><expr>data</expr> </include> </rat:report></li></ul></section><section><a id="a.3CinputExclude.3E"></a> |
| <h3><inputExclude></h3> |
| <p>Excludes files matching <Expression>.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <Expression></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <inputExclude><expr>data</expr> </inputExclude> </rat:report></li></ul></section><section><a id="a.3CinputExcludeParsedScm.3E"></a> |
| <h3><inputExcludeParsedScm></h3> |
| <p>Parse SCM based exclusion files to exclude specified files and directories. This action can apply to any standard collection that implements a file processor.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <StandardCollection></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <inputExcludeParsedScm><std>data</std> </inputExcludeParsedScm> </rat:report></li></ul></section><section><a id="a.3CinputInclude.3E"></a> |
| <h3><inputInclude></h3> |
| <p>Includes files matching <Expression>. Will override excluded files.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <Expression></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <inputInclude><expr>data</expr> </inputInclude> </rat:report></li></ul></section><section><a id="a.3ClicenseFamiliesApproved.3E"></a> |
| <h3><licenseFamiliesApproved></h3> |
| <p>A comma separated list of approved license family IDs. These license families will be added to the list of approved license families.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <FamilyID></li> |
| <li>Argument Count: 1</li> |
| <li>Example: <rat:report> <licenseFamiliesApproved><lst>data</lst> </licenseFamiliesApproved> </rat:report></li></ul></section><section><a id="a.3ClicenseFamiliesDenied.3E"></a> |
| <h3><licenseFamiliesDenied></h3> |
| <p>A comma separated list of denied License family IDs. These license families will be removed from the list of approved licenses. Once license families are removed they can not be added back.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <FamilyID></li> |
| <li>Argument Count: 1</li> |
| <li>Example: <rat:report> <licenseFamiliesDenied><lst>data</lst> </licenseFamiliesDenied> </rat:report></li></ul></section><section><a id="a.3Clicenses.3E"></a> |
| <h3><licenses></h3> |
| <p><b>Deprecated for removal since 0.17: Use <config> instead.</b> File names for system configuration.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <File></li> |
| <li>Argument Count: Unlimited.</li> |
| <li>Example: <rat:report> <licenses> <fileset file='data' /> </licenses> </rat:report></li></ul></section><section><a id="a.3ClicensesApproved.3E"></a> |
| <h3><licensesApproved></h3> |
| <p>A comma separated list of approved License IDs. These licenses will be added to the list of approved licenses.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <LicenseID></li> |
| <li>Argument Count: 1</li> |
| <li>Example: <rat:report> <licensesApproved><lst>data</lst> </licensesApproved> </rat:report></li></ul></section><section><a id="a.3ClicensesDenied.3E"></a> |
| <h3><licensesDenied></h3> |
| <p>A comma separated list of denied License IDs. These licenses will be removed from the list of approved licenses. Once licenses are removed they can not be added back.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Argument Type: <LicenseID></li> |
| <li>Argument Count: 1</li> |
| <li>Example: <rat:report> <licensesDenied><lst>data</lst> </licensesDenied> </rat:report></li></ul></section></section><section><a id="The_Attributes"></a> |
| <h2>The Attributes</h2> |
| <p>The attributes apply to the <code>report</code> element.</p><section><a id="addLicense_attribute"></a> |
| <h3>addLicense attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use editLicense attribute instead.</b> Add the Apache-2.0 license header to any file with an unknown license that is not in the exclusion list.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report addLicense="true"> </rat:report></li></ul></section><section><a id="configurationNoDefaults_attribute"></a> |
| <h3>configurationNoDefaults attribute</h3> |
| <p>Ignore default configuration.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report configurationNoDefaults="true"> </rat:report></li></ul></section><section><a id="copyright_attribute"></a> |
| <h3>copyright attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use editCopyright attribute instead.</b> The copyright message to use in the license headers.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report editLicense="true" copyright="data"> </rat:report></li></ul></section><section><a id="dryRun_attribute"></a> |
| <h3>dryRun attribute</h3> |
| <p>If set do not update the files but generate the reports.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report dryRun="true"> </rat:report></li></ul></section><section><a id="editCopyright_attribute"></a> |
| <h3>editCopyright attribute</h3> |
| <p>The copyright message to use in the license headers. Usually in the form of "Copyright 2008 Foo". Only valid with --edit-license</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report editLicense="true" editCopyright="data"> </rat:report></li></ul></section><section><a id="editLicense_attribute"></a> |
| <h3>editLicense attribute</h3> |
| <p>Add the Apache-2.0 license header to any 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.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report editLicense="true"> </rat:report></li></ul></section><section><a id="editOverwrite_attribute"></a> |
| <h3>editOverwrite attribute</h3> |
| <p>Forces any changes in files to be written directly to the source files so that new files are not created. Only valid with --edit-license.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report editLicense="true" editOverwrite="true"> </rat:report></li></ul></section><section><a id="excludeFile_attribute"></a> |
| <h3>excludeFile attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use inputExcludeFile attribute instead.</b> Reads <Expression> entries from a file. Entries will be excluded from processing.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report excludeFile="data"> </rat:report></li></ul></section><section><a id="force_attribute"></a> |
| <h3>force attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use editOverwrite attribute instead.</b> Forces any changes in files to be written directly to the source files so that new files are not created.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report editLicense="true" force="true"> </rat:report></li></ul></section><section><a id="helpLicenses_attribute"></a> |
| <h3>helpLicenses attribute</h3> |
| <p>Print information about registered licenses.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report helpLicenses="true"> </rat:report></li></ul></section><section><a id="includesFile_attribute"></a> |
| <h3>includesFile attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use inputIncludeFile attribute instead.</b> Reads <Expression> entries from a file. Entries will be excluded from processing.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report includesFile="data"> </rat:report></li></ul></section><section><a id="inputExcludeSize_attribute"></a> |
| <h3>inputExcludeSize attribute</h3> |
| <p>Excludes files with sizes less than the number of bytes specified.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report inputExcludeSize="data"> </rat:report></li></ul></section><section><a id="listFamilies_attribute"></a> |
| <h3>listFamilies attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use outputFamilies attribute instead.</b> List the defined license families.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report listFamilies="data"> </rat:report></li></ul></section><section><a id="listLicenses_attribute"></a> |
| <h3>listLicenses attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use outputLicenses attribute instead.</b> List the defined licenses.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report listLicenses="data"> </rat:report></li></ul></section><section><a id="noDefaultLicenses_attribute"></a> |
| <h3>noDefaultLicenses attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use configurationNoDefaults attribute instead.</b> Ignore default configuration.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report noDefaultLicenses="true"> </rat:report></li></ul></section><section><a id="out_attribute"></a> |
| <h3>out attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use outputFile attribute instead.</b> Define the output file where to write a report to.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report out="data"> </rat:report></li></ul></section><section><a id="outputArchive_attribute"></a> |
| <h3>outputArchive attribute</h3> |
| <p>Specifies the level of detail in ARCHIVE file reporting.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report outputArchive="data"> </rat:report></li></ul></section><section><a id="outputFamilies_attribute"></a> |
| <h3>outputFamilies attribute</h3> |
| <p>List the defined license families.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report outputFamilies="data"> </rat:report></li></ul></section><section><a id="outputFile_attribute"></a> |
| <h3>outputFile attribute</h3> |
| <p>Define the output file where to write a report to.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report outputFile="data"> </rat:report></li></ul></section><section><a id="outputLicenses_attribute"></a> |
| <h3>outputLicenses attribute</h3> |
| <p>List the defined licenses.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report outputLicenses="data"> </rat:report></li></ul></section><section><a id="outputStandard_attribute"></a> |
| <h3>outputStandard attribute</h3> |
| <p>Specifies the level of detail in STANDARD file reporting.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report outputStandard="data"> </rat:report></li></ul></section><section><a id="outputStyle_attribute"></a> |
| <h3>outputStyle attribute</h3> |
| <p>XSLT stylesheet to use when creating the report. Either an external xsl file may be specified or one of the internal named sheets.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report outputStyle="data"> </rat:report></li></ul></section><section><a id="scanHiddenDirectories_attribute"></a> |
| <h3>scanHiddenDirectories attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use <inputIncludeStd> with 'HIDDEN_DIR' argument instead.</b> Scans hidden directories.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report scanHiddenDirectories="true"> </rat:report></li></ul></section><section><a id="stylesheet_attribute"></a> |
| <h3>stylesheet attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use outputStyle attribute instead.</b> XSLT stylesheet to use when creating the report.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report stylesheet="data"> </rat:report></li></ul></section><section><a id="xml_attribute"></a> |
| <h3>xml attribute</h3> |
| <p><b>Deprecated for removal since 0.17: Use outputStyle attribute with the 'xml' argument instead.</b> forces XML output rather than the textual report.</p> |
| <ul> |
| <li>Required: false</li> |
| <li>Example: <rat:report xml="true"> </rat:report></li></ul></section><section><a id="Argument_Types"></a> |
| <h3>Argument Types</h3><section><a id="Arg"></a> |
| <h4>Arg</h4> |
| <p>A string</p></section><section><a id="CounterPattern"></a> |
| <h4>CounterPattern</h4> |
| <p>A pattern comprising one of the following prefixes followed by a colon and a count (e.g. UNAPPROVED:5). Prefixes are </p> |
| <ul> |
| <li>APPROVED: A count of approved licenses. Default range [0, unlimited]</li> |
| <li>ARCHIVES: A count of archive files. Default range [0, unlimited]</li> |
| <li>BINARIES: A count of binary files. Default range [0, unlimited]</li> |
| <li>DOCUMENT_TYPES: A count of distinct document types. Default range [1, unlimited]</li> |
| <li>IGNORED: A count of ignored files. Default range [0, unlimited]</li> |
| <li>LICENSE_CATEGORIES: A count of distinct license categories. Default range [1, unlimited]</li> |
| <li>LICENSE_NAMES: A count of distinct license names. Default range [1, unlimited]</li> |
| <li>NOTICES: A count of notice files. Default range [0, unlimited]</li> |
| <li>STANDARDS: A count of standard files. Default range [1, unlimited]</li> |
| <li>UNAPPROVED: A count of unapproved licenses. Default range [0, 0]</li> |
| <li>UNKNOWN: A count of unknown file types. Default range [0, unlimited]</li></ul> |
| <p>.</p></section><section><a id="DirOrArchive"></a> |
| <h4>DirOrArchive</h4> |
| <p>A directory or archive file to scan.</p></section><section><a id="Expression"></a> |
| <h4>Expression</h4> |
| <p>A file matching pattern usually of the form used in Ant build files and '.gitignore' files (see https://ant.apache.org/manual/dirtasks.html#patterns for examples). Regular expression patterns may be specified by surrounding the pattern with '%regex[' and ']'. For example '%regex[[A-Z].*]' would match files and directories that start with uppercase latin letters.</p></section><section><a id="FamilyID"></a> |
| <h4>FamilyID</h4> |
| <p>The ID for a license family.</p></section><section><a id="File"></a> |
| <h4>File</h4> |
| <p>A file name.</p></section><section><a id="Integer"></a> |
| <h4>Integer</h4> |
| <p>An integer value.</p></section><section><a id="LicenseFilter"></a> |
| <h4>LicenseFilter</h4> |
| <p>A defined filter for the licenses to include. Valid values: ALL, APPROVED, NONE.</p></section><section><a id="LicenseID"></a> |
| <h4>LicenseID</h4> |
| <p>The ID for a license.</p></section><section><a id="LogLevel"></a> |
| <h4>LogLevel</h4> |
| <p>The log level to use. Valid values DEBUG, INFO, WARN, ERROR, OFF.</p></section><section><a id="ProcessingType"></a> |
| <h4>ProcessingType</h4> |
| <p>Specifies how to process file types. Valid values are: * NOTIFICATION: List file as present</p> |
| <ul> |
| <li>PRESENCE: List any licenses found</li> |
| <li>ABSENCE: List licenses found and any unknown licences</li></ul></section><section><a id="StandardCollection"></a> |
| <h4>StandardCollection</h4> |
| <p>Defines standard expression patterns (see above). Valid values are: </p> |
| <ul> |
| <li>ALL: All of the Standard Excludes combined.</li> |
| <li>ARCH: The files and directories created by an ARCH source code control based tool.</li> |
| <li>BAZAAR: The files and directories created by a Bazaar source code control based tool.</li> |
| <li>BITKEEPER: The files and directories created by a Bitkeeper source code control based tool.</li> |
| <li>CVS: The files and directories created by a CVS source code control based tool.</li> |
| <li>DARCS: The files and directories created by a DARCS source code control based tool.</li> |
| <li>ECLIPSE: The files and directories created by an Eclipse IDE based tool.</li> |
| <li>GIT: The files and directories created by GIT source code control to support GIT, also processes files listed in '.gitignore' and (unless RAT_NO_GIT_GLOBAL_IGNORE is specified) the global gitignore.</li> |
| <li>HIDDEN_DIR: The hidden directories. Directories with names that start with '.'</li> |
| <li>HIDDEN_FILE: The hidden files. Directories with names that start with '.'</li> |
| <li>IDEA: The files and directories created by an IDEA IDE based tool.</li> |
| <li>MAC: The .DS_Store files on Mac computers.</li> |
| <li>MAVEN: The files and directories created by Maven build system based project.</li> |
| <li>MERCURIAL: The files and directories created by a Mercurial source code control based tool.</li> |
| <li>MISC: The set of miscellaneous files generally left by editors and the like.</li> |
| <li>MKS: The files and directories created by an MKS source code control based tool.</li> |
| <li>RCS: The files and directories created by a RCS source code control based tool.</li> |
| <li>SCCS: The files and directories created by a SCCS source code control based tool.</li> |
| <li>SERENA_DIMENSIONS_10: The files and directories created by a Serena Dimensions V10 change control system based tool.</li> |
| <li>STANDARD_PATTERNS: A standard collection of generally accepted patterns to ignore.</li> |
| <li>STANDARD_SCMS: A standard collection of SCMs</li> |
| <li>SUBVERSION: The files and directories created by a Subversion source code control based tool.</li> |
| <li>SURROUND_SCM: The files and directories created by a Surround SCM source code control based tool.</li> |
| <li>VSS: The files and directories created by a Visual Source Safe source code control based tool.</li></ul> |
| <p>A complete description of each of the <a href="./standard_collections.html">standard collection types</a> is available.</p></section><section><a id="StyleSheet"></a> |
| <h4>StyleSheet</h4> |
| <p>Either an external xsl file or one of the internal named sheets. Internal sheets are: </p> |
| <ul> |
| <li>plain-rat: The default style.</li> |
| <li>missing-headers: Produces a report of files that are missing headers.</li> |
| <li>unapproved-licenses: Produces a report of the files with unapproved licenses.</li> |
| <li>xml: Produces output in pretty-printed XML.</li></ul></section></section></section></section> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| Copyright © 2016-2025 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache RAT, Apache Tentacles, Apache Whisker, Apache and the ASF 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> |
| </footer> |
| </body> |
| </html> |
