Skip to content

Commit adfa684

Browse files
authored
MANUAL: Add -e --exclude and move -x to deprecated (#941)
1 parent 750b9a3 commit adfa684

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

doc/MANUAL.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
- [Fixing Known Issues / What should I do if it finds something?](#fixing-known-issues--what-should-i-do-if-it-finds-something)
77
- [Limitations](#limitations)
88
- [Optional Arguments:](#optional-arguments)
9-
- [-x, --extract](#-x---extract)
109
- [-u {now,daily,never}, --update {now,daily,never}](#-u-nowdailynever---update-nowdailynever)
10+
- [-e EXCLUDE, --exclude EXCLUDE](#-e-exclude---exclude-exclude)
1111
- [Checkers Arguments:](#checkers-arguments)
1212
- [-s SKIPS, --skips SKIPS](#-s-skips---skips-skips)
1313
- [-r CHECKERS, --runs CHECKERS](#-r-checkers---runs-checkers)
@@ -21,6 +21,8 @@
2121
- [Output verbosity](#output-verbosity)
2222
- [Quiet Mode](#quiet-mode)
2323
- [Logging modes](#logging-modes)
24+
- [Deprecated Arguments:](#deprecated-arguments)
25+
- [-x, --extract](#-x---extract)
2426
- [Feedback & Contributions](#feedback--contributions)
2527
- [Security Issues](#security-issues)
2628

@@ -182,16 +184,15 @@ See the detailed description of [`--input-file`](#-i-input_file---input-file-inp
182184

183185
## Optional Arguments:
184186

185-
### -x, --extract
186-
187-
This option allows the CVE Binary Tool to extract compressed files into a temporary directory
188-
so the contents can be scanned. If the quiet flag is not used, the list of extracted files
189-
will be printed.
190187

191188
### -u {now,daily,never}, --update {now,daily,never}
192189

193190
This option controls the frequency of updates for the CVE data from the National Vulnerability Database. By default, the tool checks the staleness of the data with every run, and if the data is more than one day old, it gets an update from NVD. You may also choose to update the data `now` (in which case all cached data is deleted and a full new download is done) or `never` in which case the staleness check is not done and no update is requested. The `now` and `never` modes can be combined to produce alternative update schedules if daily is not the desired one.
194191

192+
### -e EXCLUDE, --exclude EXCLUDE
193+
194+
This option allows one the skip a comma-separated lists of paths. This can be useful for excluding certain files and directories from the scan which will also decrease the scanning time.
195+
195196
## Checkers Arguments:
196197

197198
### -s SKIPS, --skips SKIPS
@@ -396,6 +397,15 @@ indicates that CVEs may be present in the code. A good result here is 0.
396397

397398
The logging modes provide additional fine-grained control for debug information.
398399

400+
## Deprecated Arguments:
401+
402+
### -x, --extract
403+
404+
This option allows the CVE Binary Tool to extract compressed files into a temporary directory
405+
so the contents can be scanned. If the quiet flag is not used, the list of extracted files
406+
will be printed.
407+
CVE Binary Tool by default auto-extract all compressed files inside the directory path. You can always exclude certain paths by using `-e --exclude`
408+
399409
## Feedback & Contributions
400410

401411
Bugs and feature requests can be made via [GitHub issues](https://github.com/intel/cve-bin-tool).

0 commit comments

Comments
 (0)