| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/apt/examples/basic.apt.vm at 2024-05-07 |
| |
| | 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 – Basic Usage Examples</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: 2024-05-07</span> |
| | <span id="projectVersion">Version: 0.17-SNAPSHOT</span> |
| | <a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a> > |
| <a href="https://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a> > |
| <a href="https://creadur.apache.org/rat/" class="externalLink" title="Rat">Rat</a> > |
| <a href="../index.html" title="Apache Rat™ Task Library for Apache Ant">Apache Rat™ Task Library for Apache Ant</a> > |
| Basic Usage Examples |
| </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"><a href="../report.html" title="Report Task">Report Task</a></li> |
| <li class="none"><a href="../types.html" title="Types">Types</a></li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| <li class="none"><strong>Basic Usage</strong></li> |
| <li class="none"><a href="../examples/custom.html" title="Custom Types">Custom Types</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="../../apidocs/index.html" title="Javadocs">Javadocs</a></li> |
| <li class="none"><a href="../../download_rat.cgi" title="Downloads">Downloads</a></li> |
| <li class="none"><a href="../../RELEASE_NOTES.txt" title="Changes">Changes</a></li> |
| </ul> |
| <h5>Running Rat</h5> |
| <ul> |
| <li class="none"><a href="../../apache-rat/index.html" title="From The Command Line">From The Command Line</a></li> |
| <li class="none"><a href="../../apache-rat-tasks/index.html" title="With Ant">With Ant</a></li> |
| <li class="none"><a href="../../apache-rat-plugin/index.html" title="With Maven">With Maven</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="../../site-publish.html" title="Howto publish this site">Howto 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="Examples"></a>Examples</h2> |
| <p>These examples assume you have installed the Rat Antlib in a way that provides the Report task in the XML namespace associated with the prefix <code>rat</code>.</p><section> |
| <h3><a name="Run_Rat_in_default_configuration_on_all_files_in_directory_src."></a>Run Rat in default configuration on all files in directory <code>src</code>.</h3> |
| <div> |
| <pre><rat:report> |
| <fileset dir="src"/> |
| </rat:report></pre></div> |
| <p>The report will be written to Ant's logging system.</p> |
| <p>This corresponds to the command line</p> |
| <div class="source"> |
| <pre>java -jar apache-rat-0.17-SNAPSHOT.jar src</pre></div> |
| <p>except that Ant's default excludes will be applied when looking for documents to check.</p></section><section> |
| <h3><a name="Run_Rat_on_multiple_directories"></a>Run Rat on multiple directories</h3> |
| <div> |
| <pre><rat:report> |
| <fileset dir="module1/src/main"/> |
| <fileset dir="module2/src/test"/> |
| </rat:report></pre></div></section><section> |
| <h3><a name="Adding_license_headers"></a>Adding license headers</h3> |
| <p>The equivalent of</p> |
| <div class="source"> |
| <pre>java -jar apache-rat-0.17-SNAPSHOT.jar --addlicense |
| --copyright "Copyright 2008 Foo" |
| /path/to/project</pre></div> |
| <p>is</p> |
| <div> |
| <pre><rat:report addLicenseHeaders="true" |
| coprightMessage="Copyright 2008 Foo"> |
| <fileset dir="/path/to/project"/> |
| </rat:report></pre></div></section><section> |
| <h3><a name="Create_a_styled_HTML_report"></a>Create a styled HTML report</h3> |
| <div> |
| <pre><rat:report format="styled" reportFile="rat.html"> |
| <fileset dir="src"/> |
| <stylesheet> |
| <file file="my/rat-xml-2-html.xslt"/> |
| </stylesheet> |
| </rat:report></pre></div></section><section> |
| <h3><a name="Run_Rat_on_a_tarball_located_on_a_webserver"></a>Run Rat on a tarball located on a webserver</h3> |
| <div> |
| <pre><rat:report> |
| <tarfileset> |
| <gzipresource> |
| <url url="http://example.org/some.tar.gz"/> |
| </gzipresource> |
| </tarfileset> |
| </rat:report></pre></div></section><section> |
| <h3><a name="Run_Rat_but_make_the_Apache_License_Version_2.0_the_only_one_accepted"></a>Run Rat but make the Apache License Version 2.0 the only one accepted</h3> |
| <div> |
| <pre><rat:report addDefaultLicenseMatchers="false"> |
| <fileset dir="src"/> |
| <rat:asl20/> |
| </rat:report></pre></div></section><section> |
| <h3><a name="Run_Rat_on_all_files_in_src_that_have_been_modified_today"></a>Run Rat on all files in <code>src</code> that have been modified today</h3> |
| <div> |
| <pre><tstamp/> |
| <rat:report xmlns:rat="antlib:org.apache.rat.anttasks"> |
| <restrict> |
| <fileset dir="src"/> |
| <date when="after" datetime="${DSTAMP}" pattern="yyyyMMdd"/> |
| </restrict> |
| </rat:report></pre></div></section><section> |
| <h3><a name="Make_Rat_only_detect_your_custom_license_and_mark_this_license_approved."></a>Make Rat only detect your custom license and mark this license approved.</h3> |
| <div> |
| <pre><rat:report addDefaultLicenseMatchers="false"> |
| <fileset dir="src"/> |
| <rat:substringMatcher licenseFamilyCategory="YASL1" |
| licenseFamilyName="Yet Another Software License, Version 1.0"> |
| <pattern substring="Yet Another Software License, 1.0"/> |
| </rat:substringMatcher> |
| <rat:approvedLicense |
| familyName="Yet Another Software License, Version 1.0"/> |
| </rat:report></pre></div></section></section> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| Copyright © 2016-2024 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> |
