From 6596cb014f3ab1f895ca2b8ddb8a4d322dbb54a2 Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Sat, 30 Nov 2013 18:13:11 -0500 Subject: [PATCH] Updated to highlight the help and command line arguments Former-commit-id: 85b13cf94e984c7ca8a88860da2c19c3c0bc16a3 --- .../src/site/markdown/arguments.md | 22 +++++++++++++++++++ .../src/site/markdown/installation.md.vm | 9 +++++++- dependency-check-cli/src/site/site.xml | 1 + 3 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 dependency-check-cli/src/site/markdown/arguments.md diff --git a/dependency-check-cli/src/site/markdown/arguments.md b/dependency-check-cli/src/site/markdown/arguments.md new file mode 100644 index 000000000..4a8890867 --- /dev/null +++ b/dependency-check-cli/src/site/markdown/arguments.md @@ -0,0 +1,22 @@ +Command Line Arguments +==================== + +The following table lists the command line arguments: + +Short | Argument Name | Parameter | Description | Requirement +-------|-----------------------|-------------|-------------|------------ + \-a | \-\-app | \ | The name of the application being scanned. This is a required argument. | + \-c | \-\-connectiontimeout | \ | The connection timeout (in milliseconds) to use when downloading resources. | Optional + \-d | \-\-data | \ | The location of the data directory used to store persistent data. This option should generally not be set. | Optional + \-f | \-\-format | \ | The output format to write to (XML, HTML, VULN, ALL). The default is HTML. | + \-h | \-\-help | | Print the help message. | Optional + \-l | \-\-log | \ | The file path to write verbose logging information. | Optional + \-n | \-\-noupdate | | Disables the automatic updating of the CPE data. | Optional + \-o | \-\-out | \ | The folder to write reports to. This defaults to the current directory. | Optional + \-p | \-\-proxyport | \ | The proxy port to use when downloading resources. | Optional + \-pp | \-\-proxypass | \ | The proxy password to use when downloading resources. | Optional + \-pu | \-\-proxyuser | \ | The proxy username to use when downloading resources. | Optional + \-s | \-\-scan | \ | The path to scan \- this option can be specified multiple times. | + \-sf | \-\-suppression | \ | The file path to the suppression XML file. | Optional + \-u | \-\-proxyurl | \ | The proxy url to use when downloading resources. | Optional + \-v | \-\-version | | Print the version information. | Optional \ No newline at end of file diff --git a/dependency-check-cli/src/site/markdown/installation.md.vm b/dependency-check-cli/src/site/markdown/installation.md.vm index 5193cb892..1012b0fee 100644 --- a/dependency-check-cli/src/site/markdown/installation.md.vm +++ b/dependency-check-cli/src/site/markdown/installation.md.vm @@ -13,4 +13,11 @@ To scan a folder on the system you can run: dependency-check.bat --app "My App Name" --scan "c:\java\application\lib" ### \*nix - dependency-check.sh --app "My App Name" --scan "/java/application/lib" \ No newline at end of file + dependency-check.sh --app "My App Name" --scan "/java/application/lib" + +To view the command line arguments, see the arguments page, or you can run: +### Windows + dependency-check.bat --help + +### \*nix + dependency-check.sh --help \ No newline at end of file diff --git a/dependency-check-cli/src/site/site.xml b/dependency-check-cli/src/site/site.xml index 5a4d92552..4da054dab 100644 --- a/dependency-check-cli/src/site/site.xml +++ b/dependency-check-cli/src/site/site.xml @@ -27,6 +27,7 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved. +