Files
DependencyCheck/css/dependency-check-cli/arguments.html
2013-12-01 10:05:10 -05:00

371 lines
8.8 KiB
HTML

<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2013-12-01
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<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="20131201" />
<meta http-equiv="Content-Language" content="en" />
<title>dependency-check-cli - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
<style type="text/css">#bannerLeft { margin-top:50px !important }</style>
</head>
<body class="topBarDisabled">
<a href="http://github.com/jeremylong/DependencyCheck">
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
alt="Fork me on GitHub">
</a>
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<h2>dependency-check-cli</h2>
</div>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class="">
<a href="../../../../../../../../../../../../c:/Users/jeremy/Documents/NetBeansProjects/DependencyCheck/target/site/1.0.6/#" title="">
</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="../index.html" title="dependency-check">
dependency-check</a>
</li>
<li class="divider ">/</li>
<li class=""></li>
<li id="publishDate" class="pull-right">Last Published: 2013-12-01</li> <li class="divider pull-right">|</li>
<li id="projectVersion" class="pull-right">Version: 1.0.6</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Getting Started</li>
<li>
<a href="installation.html" title="Installation">
<i class="none"></i>
Installation</a>
</li>
<li class="active">
<a href="#"><i class="none"></i>Configuration</a>
</li>
<li class="nav-header">Project Documentation</li>
<li>
<a href="project-info.html" title="Project Information">
<i class="icon-chevron-right"></i>
Project Information</a>
</li>
<li>
<a href="project-reports.html" title="Project Reports">
<i class="icon-chevron-right"></i>
Project Reports</a>
</li>
</ul>
<hr class="divider" />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div id="twitter">
<a href="https://twitter.com/ctxt" class="twitter-follow-button" data-show-count="true" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ctxt</a>
<script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
</div>
<div id="bodyColumn" class="span9" >
<h1>Command Line Arguments</h1>
<p>The following table lists the command line arguments:</p>
<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>Requirement</th>
</tr>
</thead>
<tbody>
<tr class="b">
<td>-a </td>
<td>--app </td>
<td>&lt;name&gt; </td>
<td>The name of the application being scanned. This is a required argument. </td>
</tr>
<tr class="a">
<td>-c </td>
<td>--connectiontimeout </td>
<td>&lt;timeout&gt; </td>
<td>The connection timeout (in milliseconds) to use when downloading resources. </td>
<td>Optional</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>Optional</td>
</tr>
<tr class="a">
<td>-f </td>
<td>--format </td>
<td>&lt;format&gt; </td>
<td>The output format to write to (XML, HTML, VULN, ALL). The default is HTML. </td>
</tr>
<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>
<td>&lt;file&gt; </td>
<td>The file path to write verbose logging information. </td>
<td>Optional</td>
</tr>
<tr class="b">
<td>-n </td>
<td>--noupdate </td>
<td> </td>
<td>Disables the automatic updating of the CPE data. </td>
<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>-pp </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>-pu </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>
</tr>
<tr class="b">
<td>-sf </td>
<td>--suppression </td>
<td>&lt;file&gt; </td>
<td>The file path to the suppression XML file. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td>-u </td>
<td>--proxyurl </td>
<td>&lt;url&gt; </td>
<td>The proxy url to use when downloading resources. </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>
</tbody>
</table>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row span12">Copyright &copy; 2012-2013
<a href="http://www.owasp.org">OWASP</a>.
All Rights Reserved.
</div>
</div>
</footer>
</body>
</html>