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

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