From 2e362d9fb97c3f860c879b122ad5b767e09d89f4 Mon Sep 17 00:00:00 2001 From: Sean Whalen Date: Tue, 16 Oct 2018 14:25:48 -0400 Subject: [PATCH] Update documentation --- README.rst | 11 ++++++----- docs/index.rst | 10 ++++++---- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 688264a..400faa9 100644 --- a/README.rst +++ b/README.rst @@ -55,10 +55,10 @@ CLI help :: - usage: parsedmarc [-h] [-o OUTPUT] [-n NAMESERVERS [NAMESERVERS ...]] - [-t TIMEOUT] [-H HOST] [-u USER] [-p PASSWORD] - [--imap-port IMAP_PORT] [--imap-no-ssl] [-r REPORTS_FOLDER] - [-a ARCHIVE_FOLDER] [-d] + usage: parsedmarc [-h] [--strip-attachment-payloads] [-o OUTPUT] + [-n NAMESERVERS [NAMESERVERS ...]] [-t TIMEOUT] [-H HOST] + [-u USER] [-p PASSWORD] [--imap-port IMAP_PORT] + [--imap-no-ssl] [-r REPORTS_FOLDER] [-a ARCHIVE_FOLDER] [-d] [-E [ELASTICSEARCH_HOST [ELASTICSEARCH_HOST ...]]] [--elasticsearch-index-prefix ELASTICSEARCH_INDEX_PREFIX] [--elasticsearch-index-suffix ELASTICSEARCH_INDEX_SUFFIX] @@ -84,6 +84,8 @@ CLI help optional arguments: -h, --help show this help message and exit + --strip-attachment-payloads + Remove attachment payloads from forensic report output -o OUTPUT, --output OUTPUT Write output files to the given directory -n NAMESERVERS [NAMESERVERS ...], --nameservers NAMESERVERS [NAMESERVERS ...] @@ -162,7 +164,6 @@ CLI help --debug Print debugging information -v, --version show program's version number and exit - Sample aggregate report output ============================== diff --git a/docs/index.rst b/docs/index.rst index 0c8c951..06fcf28 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -61,10 +61,10 @@ CLI help :: - usage: parsedmarc [-h] [-o OUTPUT] [-n NAMESERVERS [NAMESERVERS ...]] - [-t TIMEOUT] [-H HOST] [-u USER] [-p PASSWORD] - [--imap-port IMAP_PORT] [--imap-no-ssl] [-r REPORTS_FOLDER] - [-a ARCHIVE_FOLDER] [-d] + usage: parsedmarc [-h] [--strip-attachment-payloads] [-o OUTPUT] + [-n NAMESERVERS [NAMESERVERS ...]] [-t TIMEOUT] [-H HOST] + [-u USER] [-p PASSWORD] [--imap-port IMAP_PORT] + [--imap-no-ssl] [-r REPORTS_FOLDER] [-a ARCHIVE_FOLDER] [-d] [-E [ELASTICSEARCH_HOST [ELASTICSEARCH_HOST ...]]] [--elasticsearch-index-prefix ELASTICSEARCH_INDEX_PREFIX] [--elasticsearch-index-suffix ELASTICSEARCH_INDEX_SUFFIX] @@ -90,6 +90,8 @@ CLI help optional arguments: -h, --help show this help message and exit + --strip-attachment-payloads + Remove attachment payloads from forensic report output -o OUTPUT, --output OUTPUT Write output files to the given directory -n NAMESERVERS [NAMESERVERS ...], --nameservers NAMESERVERS [NAMESERVERS ...]