Skip to content

Commit eeea4bf

Browse files
authored
Add output option examples to MANUAL.md (#612)
1 parent 17a7f72 commit eeea4bf

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

MANUAL.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,52 @@ This option allows you to specify the filename for the report, rather than havin
178178
### -f {csv,json,console}, --format {csv,json,console}
179179

180180
This option allows the CVE Binary Tool to produce a report in an alternate format. This is useful if you have other tools which only take a specific format. The default is `console` which pretty-prints the information.
181+
1. `--format csv` - prints in csv (comma separated) format.
182+
```
183+
libgcrypt,1.6.0,CVE-2017-9526,MEDIUM
184+
libgcrypt,1.6.0,CVE-2018-0495,MEDIUM
185+
libgcrypt,1.6.0,CVE-2018-6829,HIGH
186+
```
187+
2. `--format json` - prints in json (javascript object notation) format.
188+
```json
189+
[
190+
{
191+
"package": "libgcrypt",
192+
"version": "1.6.0",
193+
"cve_number": "CVE-2017-9526",
194+
"severity": "MEDIUM"
195+
},
196+
{
197+
"package": "libgcrypt",
198+
"version": "1.6.0",
199+
"cve_number": "CVE-2018-0495",
200+
"severity": "MEDIUM"
201+
},
202+
{
203+
"package": "libgcrypt",
204+
"version": "1.6.0",
205+
"cve_number": "CVE-2018-6829",
206+
"severity": "HIGH"
207+
}
208+
]
209+
```
210+
3. `--format console` - prints in nice tabular format.
211+
```console
212+
+=================================================================+
213+
| CVE Binary Tool Report Generated: 2020-04-29 10:04:06 |
214+
+=================================================================+
215+
216+
+=================================================================+
217+
| MODULE NAME | VERSION | CVE NUMBER | SEVERITY |
218+
+=================================================================+
219+
| bzip2 | 1.0.2 | CVE-2005-0953 | LOW |
220+
+--------------------+-----------+--------------------+-----------+
221+
| bzip2 | 1.0.2 | CVE-2005-1260 | MEDIUM |
222+
+--------------------+-----------+--------------------+-----------+
223+
| bzip2 | 1.0.2 | CVE-2008-1372 | MEDIUM |
224+
+--------------------+-----------+--------------------+-----------+
225+
226+
```
181227

182228
### Output verbosity
183229

0 commit comments

Comments
 (0)