juplo.de Git - website/blob - dist/hibernate4-maven-plugin-1.1.0/help-mojo.html

   1 <!DOCTYPE html>
   2 <!-- Generated by Apache Maven Doxia Site Renderer 1.6 at 2015-09-08 -->
   3                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         <!-- Current: help-mojo.html -->
   4 <!-- Active: index.html -->
   5 <!-- Path: $path -->
   6 <!-- Skiplist: [index.html, configuration.html, export-mojo.html, debugging.html, skip.html, force.html, pitfalls.html] -->
   7 <html>
   8   <head>
   9     <title>juplo - Hibernate 4 Maven Plugin &#x2013; hibernate4:help</title>
  10     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  11     <link rel="canonical" href="http://juplo.de/hibernate4-maven-plugin/help-mojo.html"/>
  12     <meta name="viewport" content="width=device-width, initial-scale=1" />
  13     <link rel="stylesheet" type="text/css" href="/css/base.css" />
  14     <style type="text/css">
  15       @import '/css/screen.css' screen;
  16     </style>
  17     <script src="/js/prettify.js"></script>
  18     <!--[if lt IE 9]>
  19       <script src="/js/html5shiv.js"></script>
  20     <![endif]-->
  21     <!--[if IE 8]>
  22       <link rel="stylesheet" type="text/css" href="/css/ie8.css" />
  23     <![endif]-->
  24
  25   </head>
  26   <body class="menu" onload="prettyPrint()">
  27     <div id="page" class="cf">
  28       <header id="header">
  29         <h1 id="logo"><a href="/" title="Home" class="l">juplo</a></h1>
  30         <span id="slogan"><strong>Java</strong> bits from nerds for nerds</span>
  31         <hr class="h" />
  32       </header>
  33       <div id="breadcrumb">
  34         <strong class="b title">You are here:</strong>
  35         <ol class="b">
  36           <li class="b"><a class="b" href="/">Home</a></li>
  37           <li class="b"><a class="b" href="/projects.html">Projects</a></li>
  38                       <li class="b"><a class="b" href="./index.html">Hibernate 4 Maven Plugin</a></li>
  39                         <li class="b"><strong class="b">hibernate4:help</strong></li>
  40                   </ol>
  41         <a class="hide" href="#navigation">Jump to navigation</a>
  42         <hr class="b" />
  43       </div>
  44       <main class="content cf">
  45         <article id="content" class="main">
  46           <header><h1>hibernate4:help</h1></header>
  47
  48
  49     <div class="section">
  50 <h2><a name="hibernate4:help"></a>hibernate4:help</h2>
  51
  52 <p><b>Full name</b>:</p>
  53
  54 <p>de.juplo:hibernate4-maven-plugin:1.1.0:help</p>
  55
  56 <p><b>Description</b>:</p>
  57
  58 <div>Display help information on hibernate4-maven-plugin.<br />
  59 Call <tt>mvn hibernate4:help -Ddetail=true
  60 -Dgoal=&lt;goal-name&gt;</tt> to display parameter details.</div>
  61
  62 <p><b>Attributes</b>:</p>
  63
  64 <ul>
  65
  66 <li>The goal is thread-safe and supports parallel builds.</li>
  67       </ul>
  68
  69 <div class="section">
  70 <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
  71
  72 <table class="bodyTable" border="0">
  73
  74 <tr class="a">
  75
  76 <th>Name</th>
  77
  78 <th>Type</th>
  79
  80 <th>Since</th>
  81
  82 <th>Description</th>
  83           </tr>
  84
  85 <tr class="b">
  86
  87 <td><b><a href="#detail">detail</a></b></td>
  88
  89 <td><tt>boolean</tt></td>
  90
  91 <td><tt>-</tt></td>
  92
  93 <td>If <tt>true</tt>, display all settable properties for each
  94 goal.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>detail</tt>.</td>
  95           </tr>
  96
  97 <tr class="a">
  98
  99 <td><b><a href="#goal">goal</a></b></td>
 100
 101 <td><tt>String</tt></td>
 102
 103 <td><tt>-</tt></td>
 104
 105 <td>The name of the goal for which to show help. If unspecified, all
 106 goals will be displayed.<br /><b>User property is</b>: <tt>goal</tt>.</td>
 107           </tr>
 108
 109 <tr class="b">
 110
 111 <td><b><a href="#indentSize">indentSize</a></b></td>
 112
 113 <td><tt>int</tt></td>
 114
 115 <td><tt>-</tt></td>
 116
 117 <td>The number of spaces per indentation level, should be positive.<br /><b>Default value is</b>: <tt>2</tt>.<br /><b>User property is</b>: <tt>indentSize</tt>.</td>
 118           </tr>
 119
 120 <tr class="a">
 121
 122 <td><b><a href="#lineLength">lineLength</a></b></td>
 123
 124 <td><tt>int</tt></td>
 125
 126 <td><tt>-</tt></td>
 127
 128 <td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <tt>80</tt>.<br /><b>User property is</b>: <tt>lineLength</tt>.</td>
 129           </tr>
 130         </table>
 131       </div>
 132
 133 <div class="section">
 134 <h3><a name="Parameter_Details"></a>Parameter Details</h3>
 135
 136 <p><b><a name="detail">detail</a>:</b></p>
 137
 138 <div>If <tt>true</tt>, display all settable properties for each
 139 goal.</div>
 140
 141 <ul>
 142
 143 <li><b>Type</b>: <tt>boolean</tt></li>
 144
 145 <li><b>Required</b>: <tt>No</tt></li>
 146
 147 <li><b>User Property</b>: <tt>detail</tt></li>
 148
 149 <li><b>Default</b>: <tt>false</tt></li>
 150         </ul><hr />
 151 <p><b><a name="goal">goal</a>:</b></p>
 152
 153 <div>The name of the goal for which to show help. If unspecified, all
 154 goals will be displayed.</div>
 155
 156 <ul>
 157
 158 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 159
 160 <li><b>Required</b>: <tt>No</tt></li>
 161
 162 <li><b>User Property</b>: <tt>goal</tt></li>
 163         </ul><hr />
 164 <p><b><a name="indentSize">indentSize</a>:</b></p>
 165
 166 <div>The number of spaces per indentation level, should be positive.</div>
 167
 168 <ul>
 169
 170 <li><b>Type</b>: <tt>int</tt></li>
 171
 172 <li><b>Required</b>: <tt>No</tt></li>
 173
 174 <li><b>User Property</b>: <tt>indentSize</tt></li>
 175
 176 <li><b>Default</b>: <tt>2</tt></li>
 177         </ul><hr />
 178 <p><b><a name="lineLength">lineLength</a>:</b></p>
 179
 180 <div>The maximum length of a display line, should be positive.</div>
 181
 182 <ul>
 183
 184 <li><b>Type</b>: <tt>int</tt></li>
 185
 186 <li><b>Required</b>: <tt>No</tt></li>
 187
 188 <li><b>User Property</b>: <tt>lineLength</tt></li>
 189
 190 <li><b>Default</b>: <tt>80</tt></li>
 191         </ul>
 192       </div>
 193     </div>
 194
 195
 196         </article>
 197         <div class="marginal">
 198           <nav id="nav">
 199             <hr class="n" />
 200             <a id="navigation"></a>
 201             <a class="hide" href="#top" title="Show Content">Jump back to the top of the page</a>
 202             <h2 class="nav menu">Section-Menu</h2>
 203             <ul id="menu">
 204               <li class="m blog"><a href="/blog/" class="m">Blog</a></li>
 205               <li class="m projects"><a href="/projects.html" class="m selected">Projects</a></li>
 206               <li class="m about"><a href="/about.html" class="m">About</a></li>
 207             </ul>
 208             <h2 class="nav submenu">
 209               <span class="s">Submenu for section</span>
 210               <a class="s selected" href="/projects.html">Projects</a>
 211             </h2>
 212             <ul id="submenu" class="s">
 213                                                               <li class="s sub">
 214                                           <a class="s selected" href="./index.html">Hibernate 4 Maven Plugin</a>
 215                                         <ul class="s active">
 216                                                                                                                                                                                                                         <li class="s off">
 217                     <a href="configuration.html" class="s" title="Configuration Examples">Configuration Examples</a>
 218                 </li>
 219                                                                                 <li class="s off">
 220                     <a href="export-mojo.html" class="s" title="Parameter Documentation">Parameter Documentation</a>
 221                 </li>
 222                                                                                 <li class="s off">
 223                     <a href="debugging.html" class="s" title="Enable Debug-Output">Enable Debug-Output</a>
 224                 </li>
 225                                                                                 <li class="s off">
 226                     <a href="skip.html" class="s" title="Skipping Execution">Skipping Execution</a>
 227                 </li>
 228                                                                                 <li class="s off">
 229                     <a href="force.html" class="s" title="Force Exceution">Force Exceution</a>
 230                 </li>
 231                                                                                 <li class="s off">
 232                     <a href="pitfalls.html" class="s" title="Known Pitfalls (FAQ)">Known Pitfalls (FAQ)</a>
 233                 </li>
 234                                                                                                                                                                                                                                                                                                                 <li class="s sub off">
 235                     <a href="project-info.html" class="s" title="Project Information">Project Information</a>
 236                 </li>
 237                                                                                                                                                                 <li class="s sub off">
 238                     <a href="project-reports.html" class="s" title="Project Reports">Project Reports</a>
 239                 </li>
 240                                                                                               </ul>
 241                   </li>
 242                                           </ul>
 243             <hr class="n" />
 244           </nav>
 245           <aside class="m">
 246             <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
 247               <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
 248             </a>
 249           </aside>
 250         </div>
 251       </main>
 252       <footer id="footer">
 253         <hr class="f" />
 254         <ul id="footerlinks">
 255           <li class="f" id="copyright">&#xa9; <strong>mo</strong>             2015
 256       </li>
 257           <li class="f"><a class="f" href="/impressum.html">Impressum</a></li>
 258           <li class="f about"><a class="f" href="/about.html">About</a></li>
 259         </ul>
 260       </footer>
 261     </div>
 262         <script type="text/javascript"><!--//--><![CDATA[//><!--
 263       var _gaq = _gaq || [];
 264       _gaq.push(['_setAccount', 'UA-571104-3']);
 265       _gaq.push(['_trackPageview']);
 266       (function() {
 267         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 268         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 269         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 270       })();
 271     //--><!]]>
 272     </script>
 273       </body>
 274 </html>