From 8b04945c3eebc41a1e7905b40fd1e690de115247 Mon Sep 17 00:00:00 2001 From: Bernhard Reiter Date: Mon, 16 May 2022 16:34:02 +0200 Subject: [PATCH] Improve docs * Add --help from ./csaf_aggregator --version 0.3.1-8-gd5d48c7. --- docs/csaf_aggregator.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/csaf_aggregator.md b/docs/csaf_aggregator.md index 9182dcb..105220f 100644 --- a/docs/csaf_aggregator.md +++ b/docs/csaf_aggregator.md @@ -1,12 +1,20 @@ ## csaf_aggregator -Following options are supported: +### Usage + +``` + csaf_aggregator [OPTIONS] + +Application Options: + -c, --config=CFG-FILE File name of the configuration file (default: + aggregator.toml) + --version Display version of the binary + -i, --interim Perform an interim scan + +Help Options: + -h, --help Show this help message +``` -| Options | Description | -| --------------------- | -------------------------------------------------------------- | -| -c, --config=CFG-FILE | File name of the configuration file (default: aggregator.toml) | -| -i, --interim | Perform an interim scan | -| --version | Display version of the binary | Usage example: ``` ./csaf_aggregator -c docs/examples/aggregator.toml ```