juplo.de Git - website/blob

   1 ---
   2 title: Goal — hibernate:help
   3 weight: 24
   4 url: /projects/hibernate-maven-plugin/2.1.2-SNAPSHOT/help-mojo.html
   5 layout: article
   6 params:
   7   canonical: hibernate-maven-plugin/help-mojo.html
   8 ---
   9 <div id="sili-body">
  10
  11
  12     <section>
  13 <h2><a name="hibernate:help"></a>hibernate:help</h2>
  14
  15 <p><b>Full name</b>:</p>
  16
  17 <p>de.juplo:hibernate-maven-plugin:2.1.2-SNAPSHOT:help</p>
  18
  19 <p><b>Description</b>:</p>
  20
  21 <div>Display help information on hibernate-maven-plugin.<br />
  22 Call <code>mvn hibernate:help -Ddetail=true
  23 -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</div>
  24
  25 <p><b>Attributes</b>:</p>
  26
  27 <ul>
  28
  29 <li>The goal is thread-safe and supports parallel builds.</li>
  30       </ul>
  31       <section>
  32 <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
  33
  34 <table class="bodyTable" border="0">
  35
  36 <tr class="a">
  37
  38 <th>Name</th>
  39
  40 <th>Type</th>
  41
  42 <th>Since</th>
  43
  44 <th>Description</th>
  45           </tr>
  46
  47 <tr class="b">
  48
  49 <td><b><a href="#detail">detail</a></b></td>
  50
  51 <td><code>boolean</code></td>
  52
  53 <td><code>-</code></td>
  54
  55 <td>If <code>true</code>, display all settable properties for each
  56 goal.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>detail</code>.</td>
  57           </tr>
  58
  59 <tr class="a">
  60
  61 <td><b><a href="#goal">goal</a></b></td>
  62
  63 <td><code>String</code></td>
  64
  65 <td><code>-</code></td>
  66
  67 <td>The name of the goal for which to show help. If unspecified, all
  68 goals will be displayed.<br /><b>User property is</b>: <code>goal</code>.</td>
  69           </tr>
  70
  71 <tr class="b">
  72
  73 <td><b><a href="#indentSize">indentSize</a></b></td>
  74
  75 <td><code>int</code></td>
  76
  77 <td><code>-</code></td>
  78
  79 <td>The number of spaces per indentation level, should be positive.<br /><b>Default value is</b>: <code>2</code>.<br /><b>User property is</b>: <code>indentSize</code>.</td>
  80           </tr>
  81
  82 <tr class="a">
  83
  84 <td><b><a href="#lineLength">lineLength</a></b></td>
  85
  86 <td><code>int</code></td>
  87
  88 <td><code>-</code></td>
  89
  90 <td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <code>80</code>.<br /><b>User property is</b>: <code>lineLength</code>.</td>
  91           </tr>
  92         </table>
  93       </section>
  94       <section>
  95 <h3><a name="Parameter_Details"></a>Parameter Details</h3>
  96
  97 <p><b><a name="detail">detail</a>:</b></p>
  98
  99 <div>If <code>true</code>, display all settable properties for each
 100 goal.</div>
 101
 102 <ul>
 103
 104 <li><b>Type</b>: <code>boolean</code></li>
 105
 106 <li><b>Required</b>: <code>No</code></li>
 107
 108 <li><b>User Property</b>: <code>detail</code></li>
 109
 110 <li><b>Default</b>: <code>false</code></li>
 111         </ul><hr />
 112 <p><b><a name="goal">goal</a>:</b></p>
 113
 114 <div>The name of the goal for which to show help. If unspecified, all
 115 goals will be displayed.</div>
 116
 117 <ul>
 118
 119 <li><b>Type</b>: <code>java.lang.String</code></li>
 120
 121 <li><b>Required</b>: <code>No</code></li>
 122
 123 <li><b>User Property</b>: <code>goal</code></li>
 124         </ul><hr />
 125 <p><b><a name="indentSize">indentSize</a>:</b></p>
 126
 127 <div>The number of spaces per indentation level, should be positive.</div>
 128
 129 <ul>
 130
 131 <li><b>Type</b>: <code>int</code></li>
 132
 133 <li><b>Required</b>: <code>No</code></li>
 134
 135 <li><b>User Property</b>: <code>indentSize</code></li>
 136
 137 <li><b>Default</b>: <code>2</code></li>
 138         </ul><hr />
 139 <p><b><a name="lineLength">lineLength</a>:</b></p>
 140
 141 <div>The maximum length of a display line, should be positive.</div>
 142
 143 <ul>
 144
 145 <li><b>Type</b>: <code>int</code></li>
 146
 147 <li><b>Required</b>: <code>No</code></li>
 148
 149 <li><b>User Property</b>: <code>lineLength</code></li>
 150
 151 <li><b>Default</b>: <code>80</code></li>
 152         </ul>
 153       </section>
 154     </section>
 155
 156
 157 </div>
 158 <!-- PREPARING ROOT-ENTRY - name: Hibernate Maven Plugin ref: index.html -->
 159 <!-- READING MENU - name: Project Documentation ref: reports -->
 160 <!-- VISITING PAGE - href: /project-info.html / name: Project Information -->
 161 <!-- VISITING PAGE - href: ci-management.html / name: CI Management -->
 162 <!-- VISITING PAGE - href: dependencies.html / name: Dependencies -->
 163 <!-- VISITING PAGE - href: dependency-info.html / name: Maven Coordinates -->
 164 <!-- VISITING PAGE - href: distribution-management.html / name: Distribution Management -->
 165 <!-- VISITING PAGE - href: index.html / name: About -->
 166 <!-- RENAMING already seen PAGE: href=index.html, FROM name=Hibernate Maven Plugin TO name=About -->
 167 <!-- VISITING PAGE - href: licenses.html / name: Licenses -->
 168 <!-- VISITING PAGE - href: plugin-management.html / name: Plugin Management -->
 169 <!-- VISITING PAGE - href: plugins.html / name: Plugins -->
 170 <!-- VISITING PAGE - href: scm.html / name: Source Code Management -->
 171 <!-- VISITING PAGE - href: summary.html / name: Summary -->
 172 <!-- VISITING PAGE - href: team.html / name: Team -->
 173 <!-- VISITING PAGE - href: /project-reports.html / name: Project Reports -->
 174 <!-- VISITING PAGE - href: testapidocs/index.html / name: Test JavaDocs -->
 175 <!-- VISITING PAGE - href: apidocs/index.html / name: JavaDocs -->
 176 <!-- VISITING PAGE - href: xref/index.html / name: Source Xref -->
 177 <!-- VISITING PAGE - href: xref-test/index.html / name: Test Source Xref -->
 178 <!-- VISITING PAGE - href: cpd.html / name: CPD -->
 179 <!-- VISITING PAGE - href: pmd.html / name: PMD -->
 180 <!-- VISITING PAGE - href: plugin-info.html / name: Plugin Documentation -->
 181 <!-- READING MENU - name: $menu.name ref: $menu.ref -->
 182 <!-- VISITING PAGE - href: index.html / name: About -->
 183 <!-- RENAMING already seen PAGE: href=index.html, FROM name=About TO name=About -->
 184 <!-- VISITING PAGE - href: configuration.html / name: Configuration Examples -->
 185 <!-- VISITING PAGE - href: create-mojo.html / name: Goal — hibernate:create -->
 186 <!-- VISITING PAGE - href: update-mojo.html / name: Goal — hibernate:update -->
 187 <!-- VISITING PAGE - href: drop-mojo.html / name: Goal — hibernate:drop -->
 188 <!-- VISITING PAGE - href: help-mojo.html / name: Goal — hibernate:help -->
 189 <!-- VISITING PAGE - href: debugging.html / name: Enable Debugging-Output -->
 190 <!-- VISITING PAGE - href: skip.html / name: Skipping Execution -->
 191 <!-- VISITING PAGE - href: force.html / name: Force Exceution -->
 192 <!-- VISITING PAGE - href: pitfalls.html / name: Known Pitfalls (FAQ) -->
 193 <!-- VISITING PAGE - href: project-info.html / name: Project Information -->
 194 <!-- RENAMING already seen PAGE: href=project-info.html, FROM name=Project Information TO name=Project Information -->
 195 <!-- VISITING PAGE - href: project-reports.html / name: Project Reports -->
 196 <!-- RENAMING already seen PAGE: href=project-reports.html, FROM name=Project Reports TO name=Project Reports -->