Skip to content

Commit

Permalink
Improve consistency in the command-line options
Browse files Browse the repository at this point in the history
Use consistent spacing and punctuation for all command-line options.
  • Loading branch information
mcdonnnj committed Jan 23, 2023
1 parent e6d1098 commit 4bbf7fe
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -59,9 +59,9 @@ output will always be written to disk, defaulting to `results.csv`.

```console
-h --help Show this message.
-o --output=OUTFILE Name of output file. (Default results)
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
-o --output=OUTFILE Name of output file. (Default results)
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
--smtp-localhost=HOSTNAME The hostname to use when connecting to SMTP
servers. (Default is the FQDN of the host from
which trustymail is being run.)
Expand All @@ -70,12 +70,12 @@ output will always be written to disk, defaulting to `results.csv`.
--no-smtp-cache Do not cache SMTP results during the run. This
may results in slower scans due to testing the
same mail servers multiple times.
--mx Only check MX records
--mx Only check MX records.
--starttls Only check MX records and STARTTLS support.
(Implies --mx.)
--spf Only check SPF records
--dmarc Only check DMARC records
--json Output is in JSON format (default CSV)
--spf Only check SPF records.
--dmarc Only check DMARC records.
--json Output is in JSON format. (Default is CSV.)
--debug Output should include more verbose logging.
--dns=HOSTNAMES A comma-delimited list of DNS servers to query
against. For example, if you want to use
Expand Down
14 changes: 7 additions & 7 deletions src/trustymail/cli.py
Expand Up @@ -7,9 +7,9 @@
Options:
-h --help Show this message.
-o --output=OUTFILE Name of output file. (Default results)
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
-o --output=OUTFILE Name of output file. (Default results)
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
--smtp-localhost=HOSTNAME The hostname to use when connecting to SMTP
servers. (Default is the FQDN of the host from
which trustymail is being run.)
Expand All @@ -18,12 +18,12 @@
--no-smtp-cache Do not cache SMTP results during the run. This
may results in slower scans due to testing the
same mail servers multiple times.
--mx Only check MX records
--mx Only check MX records.
--starttls Only check MX records and STARTTLS support.
(Implies --mx.)
--spf Only check SPF records
--dmarc Only check DMARC records
--json Output is in JSON format (default CSV)
--spf Only check SPF records.
--dmarc Only check DMARC records.
--json Output is in JSON format. (Default is CSV.)
--debug Output should include more verbose logging.
--dns=HOSTNAMES A comma-delimited list of DNS servers to query
against. For example, if you want to use
Expand Down

0 comments on commit 4bbf7fe

Please sign in to comment.