| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <html> |
| <head> |
| <title>Apache JAMES MailetDocs Maven Plugin - |
| mailetdocs:help</title> |
| <style type="text/css" media="all"> |
| @import url("./css/maven-base.css"); |
| @import url("./css/maven-theme.css"); |
| @import url("./css/site.css"); |
| </style> |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <a href="http://james.apache.org/mailet/index.html" id="bannerLeft"> |
| |
| <img src="images/james-mailetdocs-logo.gif" alt="" /> |
| |
| </a> |
| <a href="http://www.apache.org/index.html" id="bannerRight"> |
| |
| <img src="images/asf-logo-reduced.gif" alt="" /> |
| |
| </a> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| |
| |
| |
| |
| |
| |
| <div class="xleft"> |
| Last Published: 09/06/2009 |
| </div> |
| <div class="xright"> <a href="../../index.html">JAMES Project</a> |
| | |
| <a href="../../server/index.html">Server</a> |
| | |
| <a href="../../mailet/index.html">Mailets</a> |
| | |
| <a href="../../jspf/index.html">jSPF</a> |
| | |
| <a href="../../mime4j/index.html">Mime4J</a> |
| | |
| <a href="../../jsieve/index.html">JSieve</a> |
| | |
| <a href="../../postage/index.html">Postage</a> |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| |
| |
| |
| |
| |
| |
| <h5>MailetDocs Maven Plugin</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="index.html">Introduction</a> |
| </li> |
| |
| <li class="none"> |
| <a href="plugin-info.html">Goals</a> |
| </li> |
| |
| <li class="none"> |
| <a href="usage.html">Usage</a> |
| </li> |
| |
| <li class="none"> |
| <a href="release-notes.html">Release Notes</a> |
| </li> |
| |
| <li class="none"> |
| <a href="doap_maven-mailetdocs-plugin.rdf">DOAP</a> |
| </li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="examples/standard.html">Large Catalog</a> |
| </li> |
| </ul> |
| <h5>Mailet</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/api">API</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/base">Basic Toolkit</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/crypto">Crypto</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/jsieve/mailet/index.html">Sieve</a> |
| </li> |
| |
| <li class="none"> |
| <a href="">MailetDocs</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/standard">Standard</a> |
| </li> |
| </ul> |
| <h5>Project Documentation</h5> |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="collapsed"> |
| <a href="project-info.html">Project Information</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="collapsed"> |
| <a href="project-reports.html">Project Reports</a> |
| </li> |
| </ul> |
| <h5>Downloads</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="../../download.cgi">Stable releases</a> |
| </li> |
| |
| <li class="none"> |
| <a href="../../downloadunstable.cgi">Unstable releases</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://people.apache.org/builds/james/nightly/">Nightly builds</a> |
| </li> |
| </ul> |
| <a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"> |
| <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img> |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| |
| |
| |
| <a name="mailetdocs:help"></a><div class="section"><h2>mailetdocs:help</h2> |
| <p><strong>Full name</strong>:</p> |
| <p>org.apache.james:maven-mailetdocs-plugin:0.2-SNAPSHOT:help</p> |
| <p><strong>Description</strong>:</p> |
| <div>Display help information on maven-mailetdocs-plugin.<br></br> |
| Call |
| |
| <pre> |
| mvn mailetdocs:help -Ddetail=true -Dgoal=<goal-name> |
| </pre> |
| |
| to display parameter details.</div> |
| <p><strong>Attributes</strong>:</p> |
| <ul></ul> |
| <a name="Optional Parameters"></a><div class="section"><h3>Optional Parameters</h3> |
| <table class="bodyTable"> |
| <tr class="a"> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th> |
| </tr> |
| <tr class="b"> |
| <td><strong><a href="#detail">detail</a></strong></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>If <code>true</code>, display all settable properties for each |
| goal.<br></br><strong>Default value is</strong>: <code>false</code>.</td> |
| </tr> |
| <tr class="a"> |
| <td><strong><a href="#goal">goal</a></strong></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>The name of the goal for which to show help. If unspecified, all |
| goals will be displayed.<br></br></td> |
| </tr> |
| <tr class="b"> |
| <td><strong><a href="#indentSize">indentSize</a></strong></td> |
| <td><code>int</code></td> |
| <td><code>-</code></td> |
| <td>The number of spaces per indentation level, should be positive.<br></br><strong>Default value is</strong>: <code>2</code>.</td> |
| </tr> |
| <tr class="a"> |
| <td><strong><a href="#lineLength">lineLength</a></strong></td> |
| <td><code>int</code></td> |
| <td><code>-</code></td> |
| <td>The maximum length of a display line, should be positive.<br></br><strong>Default value is</strong>: <code>80</code>.</td> |
| </tr> |
| </table> |
| </div> |
| <a name="Parameter Details"></a><div class="section"><h3>Parameter Details</h3> |
| <p><strong><a name="detail">detail</a>:</strong></p> |
| <div>If <code>true</code>, display all settable properties for each |
| goal.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Expression</strong>: <code>${detail}</code></li> |
| <li><strong>Default</strong>: <code>false</code></li> |
| </ul><hr></hr><strong><a name="goal">goal</a>:</strong> |
| <div>The name of the goal for which to show help. If unspecified, all |
| goals will be displayed.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Expression</strong>: <code>${goal}</code></li> |
| </ul><hr></hr><strong><a name="indentSize">indentSize</a>:</strong> |
| <div>The number of spaces per indentation level, should be positive.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>int</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Expression</strong>: <code>${indentSize}</code></li> |
| <li><strong>Default</strong>: <code>2</code></li> |
| </ul><hr></hr><strong><a name="lineLength">lineLength</a>:</strong> |
| <div>The maximum length of a display line, should be positive.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>int</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Expression</strong>: <code>${lineLength}</code></li> |
| <li><strong>Default</strong>: <code>80</code></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright">© |
| 2008-2009 |
| |
| The Apache Software Foundation |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"> |
| </script> |
| <script type="text/javascript"> |
| _uacct = "UA-1384591-1"; |
| urchinTracker(); |
| </script> |
| </body> |
| </html> |
