rat017/apache-rat-tasks/report.html - creadur-site - Git at Google

 <!DOCTYPE html>
 <!--
  | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/apt/report.apt.vm at 2025-05-04

  | 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™ Task Library for Apache Ant &#x2013; The Report Task</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: 2025-05-04</span>
            | <span id="projectVersion">Version: 0.17-SNAPSHOT</span>
           | <a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a> &gt;
 <a href="https://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a> &gt;
 <a href="https://creadur.apache.org/rat/" class="externalLink" title="Rat">Rat</a> &gt;
 <a href="index.html" title="Apache Rat™ Task Library for Apache Ant">Apache Rat™ Task Library for Apache Ant</a> &gt;
 The Report Task
       </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"><strong>Report Task</strong></li>
     </ul>
        <h5>Examples</h5>
     <ul>
      <li class="none"><a href="examples/basic.html" title="Basic Usage">Basic Usage</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="../download_rat.cgi" title="Downloads">Downloads</a></li>
      <li class="none"><a href="../changes-report.html" title="Changes">Changes</a></li>
     </ul>
        <h5>Rat from the Command Line</h5>
     <ul>
      <li class="none"><a href="../apache-rat/index.html" title="Command Line Introduction">Command Line Introduction</a></li>
      <li class="none"><a href="../apache-rat-core/exclusion_expression.html" title="Exclusion Expressions">Exclusion Expressions</a></li>
     </ul>
        <h5>Rat from Ant</h5>
     <ul>
      <li class="none"><a href="../apache-rat-tasks/index.html" title="Ant Task Introduction">Ant Task Introduction</a></li>
     </ul>
        <h5>Rat from Maven</h5>
     <ul>
      <li class="none"><a href="../apache-rat-plugin/index.html" title="Maven Plugin Introduction">Maven Plugin Introduction</a></li>
     </ul>
        <h5>Configuring Rat</h5>
     <ul>
      <li class="none"><a href="../license_def.html" title="Defining New Licenses">Defining New Licenses</a></li>
      <li class="none"><a href="../apache-rat/name_xref.html" title="Option Name Cross Reference">Option Name Cross Reference</a></li>
      <li class="none"><a href="../apache-rat/default_licenses.html" title="Default Licenses, etc">Default Licenses, etc</a></li>
      <li class="none"><a href="../apache-rat/xsd.html" title="Configuration XSD">Configuration XSD</a></li>
      <li class="none"><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml" class="externalLink" title="Default Configuration">Default Configuration</a></li>
     </ul>
        <h5>Rat Output</h5>
     <ul>
      <li class="none"><a href="../apache-rat/output/example.html" title="Standard Output Example">Standard Output Example</a></li>
      <li class="none"><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd" class="externalLink" title="Output XSD">Output XSD</a></li>
      <li class="none"><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl" class="externalLink" title="XSLT - Plain text">XSLT - Plain text</a></li>
      <li class="none"><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl" class="externalLink" title="XSLT - Missing headers list">XSLT - Missing headers list</a></li>
      <li class="none"><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl" class="externalLink" title="XSLT - Unapproved licenses list">XSLT - Unapproved licenses list</a></li>
     </ul>
        <h5>Developing Rat</h5>
     <ul>
      <li class="none"><a href="../architecture.html" title="Architecture">Architecture</a></li>
      <li class="none"><a href="../apidocs/index.html" title="Javadocs">Javadocs</a></li>
      <li class="none"><a href="../apache-rat-core/development/document_name.html" title="Document Name concept">Document Name concept</a></li>
      <li class="none"><a href="../development/ui_implementation.html" title="UI Development">UI Development</a></li>
      <li class="none"><a href="../apache-rat-core/development/write_file_processor.html" title="Writing a File Processor">Writing a File Processor</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="https://gitbox.apache.org/repos/asf/creadur-site/blob/asf-site/README.md" class="externalLink" title="How to publish this site">How to 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="Report_Task"></a>Report Task</h2>
 <p>The Report task is the heart of the Apache Rat Ant Task Library, it runs Rat on a given set of resources and generates the report.</p>
 <p>The task can work on any Ant <a class="externalLink" href="https://ant.apache.org/manual/Types/resources.html">resource or resource collection</a> and the usual Ant selectors can be applied to restrict things even further.</p>
 <p>Reports can use Rat's internal XML or plain text format or be styled by a custom XSLT stylesheet.</p>
 <p>It is possible to define custom matchers for licenses not directly supported by Rat via nested elements to the Report task.</p><section>
 <h3><a name="Report_Task_Attributes"></a>Report Task Attributes</h3><section>
 <h4><a name="Current"></a>Current</h4>
 <table border="1" class="bodyTable"><caption>The attribute value types are listed in a table at the bottom of this page.</caption>
 <tr class="a">
 <td align="left">Name</td>
 <td align="left">Description</td>
 <td align="left">Value Type</td>
 <td align="left">Required</td></tr>
 <tr class="b">
 <td align="left">editCopyright</td>
 <td align="left">The copyright message to use in the license headers. Usually in the form of &quot;Copyright 2008 Foo&quot;. Only valid with editLicense attribute</td>
 <td align="left">Arg</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">editOverwrite</td>
 <td align="left">Forces any changes in files to be written directly to the source files so that new files are not created. Only valid with editLicense attribute.</td>
 <td align="left">boolean</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">editLicense</td>
 <td align="left">Add the default 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 editOverwrite attribute option.</td>
 <td align="left">boolean</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">configurationNoDefaults</td>
 <td align="left">Ignore default configuration.</td>
 <td align="left">boolean</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">inputExcludeSize</td>
 <td align="left">Excludes files with sizes less than the given argument.</td>
 <td align="left">Integer</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">outputStyle</td>
 <td align="left">XSLT stylesheet to use when creating the report. Either an external xsl file may be specified or one of the internal named sheets.</td>
 <td align="left">StyleSheet</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">outputLicenses</td>
 <td align="left">List the defined licenses.</td>
 <td align="left">LicenseFilter</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">outputFamilies</td>
 <td align="left">List the defined license families.</td>
 <td align="left">LicenseFilter</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">dryRun</td>
 <td align="left">If set do not update the files but generate the reports.</td>
 <td align="left">boolean</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">outputFile</td>
 <td align="left">Define the output file where to write a report to.</td>
 <td align="left">File</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">outputArchive</td>
 <td align="left">Specifies the level of detail in ARCHIVE file reporting.</td>
 <td align="left">ProcessingType</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">outputStandard</td>
 <td align="left">Specifies the level of detail in STANDARD file reporting.</td>
 <td align="left">ProcessingType</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">helpLicenses</td>
 <td align="left">Print information about registered licenses.</td>
 <td align="left">boolean</td>
 <td align="left">false</td></tr></table></section><section>
 <h4><a name="Deprecated"></a>Deprecated </h4>
 <table border="1" class="bodyTable"><caption>The attribute value types are listed in a table at the bottom of this page.</caption>
 <tr class="a">
 <td align="left">Name</td>
 <td align="left">Description</td>
 <td align="left">Argument Type</td>
 <td align="left">Deprecated</td></tr>
 <tr class="b">
 <td align="left">copyright</td>
 <td align="left">The copyright message to use in the license headers.</td>
 <td align="left">Arg</td>
 <td align="left">Deprecated for removal since 0.17: Use editCopyright attribute instead.</td></tr>
 <tr class="a">
 <td align="left">force</td>
 <td align="left">Forces any changes in files to be written directly to the source files so that new files are not created.</td>
 <td align="left">boolean</td>
 <td align="left">Deprecated for removal since 0.17: Use editOverwrite attribute instead.</td></tr>
 <tr class="b">
 <td align="left">addLicense</td>
 <td align="left">Add the default license header to any file with an unknown license that is not in the exclusion list.</td>
 <td align="left">boolean</td>
 <td align="left">Deprecated for removal since 0.17: Use editLicense attribute instead.</td></tr>
 <tr class="a">
 <td align="left">noDefaultLicenses</td>
 <td align="left">Ignore default configuration.</td>
 <td align="left">boolean</td>
 <td align="left">Deprecated for removal since 0.17: Use configurationNoDefaults attribute instead.</td></tr>
 <tr class="b">
 <td align="left">excludeFile</td>
 <td align="left">Reads <i>Expression</i> entries from a file. Entries will be excluded from processing.</td>
 <td align="left">File</td>
 <td align="left">Deprecated for removal since 0.17: Use inputExcludeFile attribute instead.</td></tr>
 <tr class="a">
 <td align="left">includesFile</td>
 <td align="left">Reads <i>Expression</i> entries from a file. Entries will be excluded from processing.</td>
 <td align="left">File</td>
 <td align="left">Deprecated for removal since 0.17: Use inputIncludeFile attribute instead.</td></tr>
 <tr class="b">
 <td align="left">scanHiddenDirectories</td>
 <td align="left">Scans hidden directories.</td>
 <td align="left">boolean</td>
 <td align="left">Deprecated for removal since 0.17: Use <i>inputIncludeStd</i> with 'HIDDEN_DIR' argument instead.</td></tr>
 <tr class="a">
 <td align="left">stylesheet</td>
 <td align="left">XSLT stylesheet to use when creating the report.</td>
 <td align="left">StyleSheet</td>
 <td align="left">Deprecated for removal since 0.17: Use outputStyle attribute instead.</td></tr>
 <tr class="b">
 <td align="left">xml</td>
 <td align="left">forces XML output rather than the textual report.</td>
 <td align="left">boolean</td>
 <td align="left">Deprecated for removal since 0.17: Use outputStyle attribute with the 'xml' argument instead.</td></tr>
 <tr class="a">
 <td align="left">listLicenses</td>
 <td align="left">List the defined licenses.</td>
 <td align="left">LicenseFilter</td>
 <td align="left">Deprecated for removal since 0.17: Use outputLicenses attribute instead.</td></tr>
 <tr class="b">
 <td align="left">listFamilies</td>
 <td align="left">List the defined license families.</td>
 <td align="left">LicenseFilter</td>
 <td align="left">Deprecated for removal since 0.17: Use outputFamilies attribute instead.</td></tr>
 <tr class="a">
 <td align="left">out</td>
 <td align="left">Define the output file where to write a report to.</td>
 <td align="left">File</td>
 <td align="left">Deprecated for removal since 0.17: Use outputFile attribute instead.</td></tr></table></section></section><section>
 <h3><a name="Report_Task_Nested_Elements"></a>Report Task Nested Elements</h3><section>
 <h4><a name="Current"></a>Current</h4>
 <table border="1" class="bodyTable"><caption>The element value types are listed in a table at the bottom of this page.</caption>
 <tr class="a">
 <td align="left">Name</td>
 <td align="left">Description</td>
 <td align="left">Value Type</td>
 <td align="left">Required</td></tr>
 <tr class="b">
 <td align="left">config</td>
 <td align="left">File names for system configuration.</td>
 <td align="left">File</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">licensesApproved</td>
 <td align="left">A comma separated list of approved License IDs. These licenses will be added to the list of approved licenses.</td>
 <td align="left">LicenseID</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">licenseFamiliesApproved</td>
 <td align="left">A comma separated list of approved license family IDs. These license families will be added to the list of approved license families.</td>
 <td align="left">FamilyID</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">licensesDenied</td>
 <td align="left">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.</td>
 <td align="left">LicenseID</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">licenseFamiliesDenied</td>
 <td align="left">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.</td>
 <td align="left">FamilyID</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">counterMax</td>
 <td align="left">The acceptable maximum number for the specified counter. A value of '-1' specifies an unlimited number.</td>
 <td align="left">CounterPattern</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">counterMin</td>
 <td align="left">The minimum number for the specified counter.</td>
 <td align="left">CounterPattern</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">inputExclude</td>
 <td align="left">Excludes files matching <i>Expression</i>.</td>
 <td align="left">Expression</td>
 <td align="left">false</td></tr>
 <tr class="b">
 <td align="left">inputInclude</td>
 <td align="left">Includes files matching <i>Expression</i>. Will override excluded files.</td>
 <td align="left">Expression</td>
 <td align="left">false</td></tr>
 <tr class="a">
 <td align="left">inputExcludeParsedScm</td>
 <td align="left">Parse SCM based exclusion files to exclude specified files and directories.</td>
 <td align="left">StandardCollection</td>
 <td align="left">false</td></tr></table></section><section>
 <h4><a name="Deprecated"></a>Deprecated </h4>
 <table border="1" class="bodyTable"><caption>The element value types are listed in a table at the bottom of this page.</caption>
 <tr class="a">
 <td align="left">Name</td>
 <td align="left">Description</td>
 <td align="left">Argument Type</td>
 <td align="left">Deprecated</td></tr>
 <tr class="b">
 <td align="left">licenses</td>
 <td align="left">File names for system configuration.</td>
 <td align="left">File</td>
 <td align="left">Deprecated for removal since 0.17: Use <i>config</i> instead.</td></tr>
 <tr class="a">
 <td align="left">exclude</td>
 <td align="left">Excludes files matching <i>Expression</i>.</td>
 <td align="left">Expression</td>
 <td align="left">Deprecated for removal since 0.17: Use <i>inputExclude</i> instead.</td></tr>
 <tr class="b">
 <td align="left">include</td>
 <td align="left">Includes files matching <i>Expression</i>. Will override excluded files.</td>
 <td align="left">Expression</td>
 <td align="left">Deprecated for removal since 0.17: Use <i>inputInclude</i> instead.</td></tr></table></section></section><section>
 <h3><a name="Argument_Types"></a>Argument Types</h3></section></section><section>
 <h2><i></i></h2></section><section>
 <h2><a name="Arg_A_string"></a><i>Arg</i> A string</h2></section><section>
 <h2><a name="CounterPattern_A_pattern_comprising_one_of_the_following_prefixes_followed_by_a_colon_and_a_count_.28e.g._UNAPPROVED:5.29._Prefixes_are"></a><i>CounterPattern</i> A pattern comprising one of the following prefixes followed by a colon and a count (e.g. UNAPPROVED:5). Prefixes are</h2>
 <p>APPROVED: A count of approved licenses. Default range [0, unlimited]</p>
 <p>ARCHIVES: A count of archive files. Default range [0, unlimited]</p>
 <p>BINARIES: A count of binary files. Default range [0, unlimited]</p>
 <p>DOCUMENT_TYPES: A count of distinct document types. Default range [1, unlimited]</p>
 <p>IGNORED: A count of ignored files. Default range [0, unlimited]</p>
 <p>LICENSE_CATEGORIES: A count of distinct license categories. Default range [1, unlimited]</p>
 <p>LICENSE_NAMES: A count of distinct license names. Default range [1, unlimited]</p>
 <p>NOTICES: A count of notice files. Default range [0, unlimited]</p>
 <p>STANDARDS: A count of standard files. Default range [1, unlimited]</p>
 <p>UNAPPROVED: A count of unapproved licenses. Default range [0, 0]</p>
 <p>UNKNOWN: A count of unknown file types. Default range [0, unlimited].</p></section><section>
 <h2><a name="DirOrArchive_A_directory_or_archive_file_to_scan."></a><i>DirOrArchive</i> A directory or archive file to scan.</h2></section><section>
 <h2><a name="Expression_A_file_matching_pattern_usually_of_the_form_used_in_Ant_build_files_and_.27.gitignore.27_files_.28see_https:.2F.2Fant.apache.org.2Fmanual.2Fdirtasks.html.23patterns_for_examples.29._Regular_expression_patterns_may_be_specified_by_surrounding_the_pattern_with_.27.25regex.5B.27_and_.27.5D.27._For_example_.27.25regex.5B.5BA-Z.5D..2A.5D.27_would_match_files_and_directories_that_start_with_uppercase_latin_letters."></a><i>Expression</i> 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.</h2></section><section>
 <h2><a name="FamilyID_The_ID_for_a_license_family."></a><i>FamilyID</i> The ID for a license family.</h2></section><section>
 <h2><a name="File_A_file_name."></a><i>File</i> A file name.</h2></section><section>
 <h2><a name="Integer_An_integer_value."></a><i>Integer</i> An integer value.</h2></section><section>
 <h2><a name="LicenseFilter_A_defined_filter_for_the_licenses_to_include._Valid_values:_ALL.2C_APPROVED.2C_NONE."></a><i>LicenseFilter</i> A defined filter for the licenses to include. Valid values: ALL, APPROVED, NONE.</h2></section><section>
 <h2><a name="LicenseID_The_ID_for_a_license."></a><i>LicenseID</i> The ID for a license.</h2></section><section>
 <h2><a name="LogLevel_The_log_level_to_use._Valid_values_DEBUG.2C_INFO.2C_WARN.2C_ERROR.2C_OFF."></a><i>LogLevel</i> The log level to use. Valid values DEBUG, INFO, WARN, ERROR, OFF.</h2></section><section>
 <h2><a name="ProcessingType_Specifies_how_to_process_file_types._Valid_values_are:_NOTIFICATION:_List_file_as_present"></a><i>ProcessingType</i> Specifies how to process file types. Valid values are: NOTIFICATION: List file as present</h2>
 <p>PRESENCE: List any licenses found</p>
 <p>ABSENCE: List licenses found and any unknown licences</p></section><section>
 <h2><a name="StandardCollection_Defines_standard_expression_patterns_.28see_above.29._Valid_values_are:_ALL:_All_of_the_Standard_Excludes_combined."></a><i>StandardCollection</i> Defines standard expression patterns (see above). Valid values are: ALL: All of the Standard Excludes combined.</h2>
 <p>ARCH: The files and directories created by an ARCH source code control based tool.</p>
 <p>BAZAAR: The files and directories created by a Bazaar source code control based tool.</p>
 <p>BITKEEPER: The files and directories created by a Bitkeeper source code control based tool.</p>
 <p>CVS: The files and directories created by a CVS source code control based tool.</p>
 <p>DARCS: The files and directories created by a DARCS source code control based tool.</p>
 <p>ECLIPSE: The files and directories created by an Eclipse IDE based tool.</p>
 <p>GIT: The files and directories created by GIT source code control to support GIT, also processes files listed in '.gitignore'.</p>
 <p>HIDDEN_DIR: The hidden directories. Directories with names that start with '.'</p>
 <p>HIDDEN_FILE: The hidden files. Directories with names that start with '.'</p>
 <p>IDEA: The files and directories created by an IDEA IDE based tool.</p>
 <p>MAC: The .DS_Store files on Mac computers.</p>
 <p>MAVEN: The files and directories created by Maven build system based project.</p>
 <p>MERCURIAL: The files and directories created by a Mercurial source code control based tool.</p>
 <p>MISC: The set of miscellaneous files generally left by editors and the like.</p>
 <p>MKS: The files and directories created by an MKS source code control based tool.</p>
 <p>RCS: The files and directories created by a RCS source code control based tool.</p>
 <p>SCCS: The files and directories created by a SCCS source code control based tool.</p>
 <p>SERENA_DIMENSIONS_10: The files and directories created by a Serena Dimensions V10 change control system based tool.</p>
 <p>STANDARD_PATTERNS: A standard collection of generally accepted patterns to ignore.</p>
 <p>STANDARD_SCMS: A standard collection of SCMs</p>
 <p>SUBVERSION: The files and directories created by a Subversion source code control based tool.</p>
 <p>SURROUND_SCM: The files and directories created by a Surround SCM source code control based tool.</p>
 <p>VSS: The files and directories created by a Visual Source Safe source code control based tool.</p></section><section>
 <h2><a name="StyleSheet_Either_an_external_xsl_file_or_one_of_the_internal_named_sheets._Internal_sheets_are:_plain-rat:_The_default_style."></a><i>StyleSheet</i> Either an external xsl file or one of the internal named sheets. Internal sheets are: plain-rat: The default style.</h2>
 <p>missing-headers: Produces a report of files that are missing headers.</p>
 <p>unapproved-licenses: Produces a report of the files with unapproved licenses.</p>
 <p>xml: Produces output in pretty-printed XML.</p><section>
 <h3><a name="Examples"></a>Examples</h3>
 <p>The files to be checked by Rat are specified as nested <a class="externalLink" href="https://ant.apache.org/manual/Types/resources.html"> resource (collection)(s)</a>, the most basic one would probably be a <a class="externalLink" href="https://ant.apache.org/manual/Types/fileset.html"> fileset</a>.</p>
 <p>For example the following would check all Java files in the <code>src</code> directory.</p>
 <div>
 <pre>&lt;rat:report&gt;
     &lt;fileset dir=&quot;src&quot; includes=&quot;**/*.java&quot;/&gt;
 &lt;/rat:report&gt;</pre></div></section></section>
       </div>
     </div>
     <div class="clear">
       <hr/>
     </div>
     <div id="footer">
       <div class="xright">
         Copyright &copy; 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 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>