diff --git a/docs/csaf_checker.md b/docs/csaf_checker.md index 09d0656..6036a55 100644 --- a/docs/csaf_checker.md +++ b/docs/csaf_checker.md @@ -1,16 +1,21 @@ ## csaf_checker -Following options are supported: +### Usage -| Options | Description | -| ------------------------------------------ | ---------------------------------------------- | -| -o, --output=REPORT-FILE | File name of the generated report | -| -f, --format=[json | html] | -| -t, --tlp=[csaf\|white\|green\|amber\|red] | Format of report (default: json) | -| --insecure | o not check TLS certificates from provider | -| --client-cert=CERT-FILE | TLS client certificate file (PEM encoded data) | -| --client-key=KEY-FILE | TLS client private key file (PEM encoded data) | -| --version | Display version of the binary | +``` + csaf_checker [OPTIONS] + +Application Options: + -o, --output=REPORT-FILE File name of the generated report + -f, --format=[json|html] Format of report (default: json) + --insecure Do not check TLS certificates from provider + --client-cert=CERT-FILE TLS client certificate file (PEM encoded data) + --client-key=KEY-FILE TLS client private key file (PEM encoded data) + --version Display version of the binary + +Help Options: + -h, --help Show this help message +``` Usage example: ` ./csaf_checker example.com -f html -o check-results.html`