version 1.1.4 of the projects documentation

This commit is contained in:
Jeremy Long
2014-03-29 10:02:40 -04:00
parent a64a31923a
commit 99d2502581
975 changed files with 36859 additions and 28147 deletions

View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2014-03-10
| Generated by Apache Maven Doxia at 2014-03-29
| Rendered using Apache Maven Fluido Skin 1.3.1
-->
<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="Date-Revision-yyyymmdd" content="20140310" />
<meta name="Date-Revision-yyyymmdd" content="20140329" />
<meta http-equiv="Content-Language" content="en" />
<title>dependency-check-cli - Command Line Arguments</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
@@ -54,7 +54,7 @@
<li class="">
<a href="../../../../../../../../../../../../c:/Users/jeremy/Documents/NetBeansProjects/DependencyCheck/target/site/1.1.3/#" title="">
<a href="../../../../../../../../../../../../c:/Users/jeremy/Documents/NetBeansProjects/DependencyCheck/target/site/1.1.4/#" title="">
</a>
<span class="divider">/</span>
</li>
@@ -67,9 +67,9 @@
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-03-10</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-03-29</li>
<li id="projectVersion" class="pull-right">
Version: 1.1.3
Version: 1.1.4
</li>
</ul>
@@ -188,26 +188,26 @@
<tr class="a">
<td>-c </td>
<td>-s </td>
<td>--connectiontimeout </td>
<td>--scan </td>
<td>&lt;timeout&gt; </td>
<td>&lt;path&gt; </td>
<td>The connection timeout (in milliseconds) to use when downloading resources. </td>
<td>The path to scan - this option can be specified multiple times. It is also possible to specify specific file types that should be scanned by supplying a scan path of &#x2018;[path]/[to]/[scan]/*.zip&#x2019;. The wild card can only be used to denote any file-name with a specific extension. </td>
<td>Optional</td>
<td>Required</td>
</tr>
<tr class="b">
<td>-d </td>
<td>-o </td>
<td>--data </td>
<td>--out </td>
<td>&lt;path&gt; </td>
<td>&lt;folder&gt; </td>
<td>The location of the data directory used to store persistent data. This option should generally not be set. </td>
<td>The folder to write reports to. This defaults to the current directory. </td>
<td>Optional</td>
</tr>
@@ -227,19 +227,6 @@
<tr class="b">
<td>-h </td>
<td>--help </td>
<td> </td>
<td>Print the help message. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td>-l </td>
<td>--log </td>
@@ -251,7 +238,7 @@
<td>Optional</td>
</tr>
<tr class="b">
<tr class="a">
<td>-n </td>
@@ -264,71 +251,6 @@
<td>Optional</td>
</tr>
<tr class="a">
<td>-o </td>
<td>--out </td>
<td>&lt;folder&gt; </td>
<td>The folder to write reports to. This defaults to the current directory. </td>
<td>Optional</td>
</tr>
<tr class="b">
<td>-p </td>
<td>--proxyport </td>
<td>&lt;port&gt; </td>
<td>The proxy port to use when downloading resources. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td> </td>
<td>--proxypass </td>
<td>&lt;pass&gt; </td>
<td>The proxy password to use when downloading resources. </td>
<td>Optional</td>
</tr>
<tr class="b">
<td> </td>
<td>--proxyuser </td>
<td>&lt;user&gt; </td>
<td>The proxy username to use when downloading resources. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td>-s </td>
<td>--scan </td>
<td>&lt;path&gt; </td>
<td>The path to scan - this option can be specified multiple times. </td>
<td>Required</td>
</tr>
<tr class="b">
<td> </td>
@@ -344,32 +266,19 @@
<tr class="a">
<td>-u </td>
<td>-h </td>
<td>--proxyurl </td>
<td>--help </td>
<td>&lt;url&gt; </td>
<td> </td>
<td>The proxy url to use when downloading resources. </td>
<td>Print the help message. </td>
<td>Optional</td>
</tr>
<tr class="b">
<td>-v </td>
<td>--version </td>
<td> </td>
<td>Print the version information. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td> </td>
<td>--advancedHelp </td>
@@ -381,69 +290,77 @@
<td>Optional</td>
</tr>
<tr class="a">
<td>-v </td>
<td>--version </td>
<td> </td>
<td>Print the version information. </td>
<td>Optional</td>
</tr>
</tbody>
</table>
<h1>Advanced Options</h1>
<table border="0" class="table table-striped">
<thead>
<tr class="a">
<th>Short </th>
<th>Argument Name </th>
<th>Parameter </th>
<th>Description </th>
<th>Default Value</th>
</tr>
</thead>
<tbody>
<tr class="b">
<td> </td>
<td>--connectionString </td>
<td>--disableArchive </td>
<td>&lt;connStr&gt; </td>
<td> </td>
<td>The connection string to the database. </td>
<td>Sets whether the Archive Analyzer will be used. </td>
<td>Optional</td>
<td>false</td>
</tr>
<tr class="a">
<td> </td>
<td>--dbDriverName </td>
<td>--zipExtensions </td>
<td>&lt;driver&gt; </td>
<td>&lt;strings&gt; </td>
<td>The database driver name. </td>
<td>A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. </td>
<td>Optional</td>
<td>&#160;</td>
</tr>
<tr class="b">
<td> </td>
<td>--dbDriverPath </td>
<td>&lt;path&gt; </td>
<td>The path to the database driver; note, this does not need to be set unless the JAR is outside of the class path. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td>--disableJar </td>
<td> </td>
<td>--dbPassword </td>
<td>Sets whether Jar Analyzer will be used. </td>
<td>&lt;password&gt; </td>
<td>The password for connecting to the database. </td>
<td>Optional</td>
</tr>
<tr class="b">
<td> </td>
<td>--dbUser </td>
<td>&lt;user&gt; </td>
<td>The username used to connect to the database. </td>
<td>Optional</td>
<td>false</td>
</tr>
<tr class="a">
@@ -454,25 +371,38 @@
<td> </td>
<td>Disable the Nexus Analyzer. </td>
<td>Sets whether Nexus Analyzer will be used. </td>
<td>Optional</td>
<td>false</td>
</tr>
<tr class="b">
<td> </td>
<td>--disableNexus </td>
<td> </td>
<td>Disable the Nexus Analyzer. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td> </td>
<td>--nexus </td>
<td>&lt;url&gt; </td>
<td>The url to the Nexus Server. </td>
<td>Optional</td>
<td><a class="externalLink" href="https://repository.sonatype.org/service/local/">https://repository.sonatype.org/service/local/</a></td>
</tr>
<tr class="a">
<tr class="b">
<td> </td>
@@ -482,20 +412,33 @@
<td>Whether or not the defined proxy should be used when connecting to Nexus. </td>
<td>Optional</td>
<td>true</td>
</tr>
<tr class="a">
<td> </td>
<td>--disableNuspec </td>
<td> </td>
<td>Sets whether or not the .NET Nuget Nuspec Analyzer will be used. </td>
<td>false</td>
</tr>
<tr class="b">
<td> </td>
<td>--zipExtensions </td>
<td>--disableAssembly </td>
<td>&lt;strings&gt; </td>
<td> </td>
<td>A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. </td>
<td>Sets whether or not the .NET Assembly Analyzer should be used. </td>
<td>Optional</td>
<td>false</td>
</tr>
<tr class="a">
@@ -508,7 +451,150 @@
<td>The path to Mono for .NET Assembly analysis on non-windows systems. </td>
<td>Optional</td>
<td>&#160;</td>
</tr>
<tr class="b">
<td> </td>
<td>--proxyurl </td>
<td>&lt;url&gt; </td>
<td>The proxy url to use when downloading resources. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td> </td>
<td>--proxyport </td>
<td>&lt;port&gt; </td>
<td>The proxy port to use when downloading resources. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td> </td>
<td>--connectiontimeout </td>
<td>&lt;timeout&gt; </td>
<td>The connection timeout (in milliseconds) to use when downloading resources. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td> </td>
<td>--proxypass </td>
<td>&lt;pass&gt; </td>
<td>The proxy password to use when downloading resources. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td> </td>
<td>--proxyuser </td>
<td>&lt;user&gt; </td>
<td>The proxy username to use when downloading resources. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td> </td>
<td>--connectionString </td>
<td>&lt;connStr&gt; </td>
<td>The connection string to the database. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td> </td>
<td>--dbDriverName </td>
<td>&lt;driver&gt; </td>
<td>The database driver name. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td> </td>
<td>--dbDriverPath </td>
<td>&lt;path&gt; </td>
<td>The path to the database driver; note, this does not need to be set unless the JAR is outside of the class path. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td> </td>
<td>--dbPassword </td>
<td>&lt;password&gt; </td>
<td>The password for connecting to the database. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td> </td>
<td>--dbUser </td>
<td>&lt;user&gt; </td>
<td>The username used to connect to the database. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td>-d </td>
<td>--data </td>
<td>&lt;path&gt; </td>
<td>The location of the data directory used to store persistent data. This option should generally not be set. </td>
<td>&#160;</td>
</tr>
</tbody>
</table>