Skip to content

Commit 4bbf7fe

Browse files
committed
Improve consistency in the command-line options
Use consistent spacing and punctuation for all command-line options.
1 parent e6d1098 commit 4bbf7fe

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ output will always be written to disk, defaulting to `results.csv`.
5959

6060
```console
6161
-h --help Show this message.
62-
-o --output=OUTFILE Name of output file. (Default results)
63-
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
64-
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
62+
-o --output=OUTFILE Name of output file. (Default results)
63+
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
64+
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
6565
--smtp-localhost=HOSTNAME The hostname to use when connecting to SMTP
6666
servers. (Default is the FQDN of the host from
6767
which trustymail is being run.)
@@ -70,12 +70,12 @@ output will always be written to disk, defaulting to `results.csv`.
7070
--no-smtp-cache Do not cache SMTP results during the run. This
7171
may results in slower scans due to testing the
7272
same mail servers multiple times.
73-
--mx Only check MX records
73+
--mx Only check MX records.
7474
--starttls Only check MX records and STARTTLS support.
7575
(Implies --mx.)
76-
--spf Only check SPF records
77-
--dmarc Only check DMARC records
78-
--json Output is in JSON format (default CSV)
76+
--spf Only check SPF records.
77+
--dmarc Only check DMARC records.
78+
--json Output is in JSON format. (Default is CSV.)
7979
--debug Output should include more verbose logging.
8080
--dns=HOSTNAMES A comma-delimited list of DNS servers to query
8181
against. For example, if you want to use

src/trustymail/cli.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
88
Options:
99
-h --help Show this message.
10-
-o --output=OUTFILE Name of output file. (Default results)
11-
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
12-
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
10+
-o --output=OUTFILE Name of output file. (Default results)
11+
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
12+
--smtp-timeout=TIMEOUT The SMTP connection timeout in seconds. (Default is 5.)
1313
--smtp-localhost=HOSTNAME The hostname to use when connecting to SMTP
1414
servers. (Default is the FQDN of the host from
1515
which trustymail is being run.)
@@ -18,12 +18,12 @@
1818
--no-smtp-cache Do not cache SMTP results during the run. This
1919
may results in slower scans due to testing the
2020
same mail servers multiple times.
21-
--mx Only check MX records
21+
--mx Only check MX records.
2222
--starttls Only check MX records and STARTTLS support.
2323
(Implies --mx.)
24-
--spf Only check SPF records
25-
--dmarc Only check DMARC records
26-
--json Output is in JSON format (default CSV)
24+
--spf Only check SPF records.
25+
--dmarc Only check DMARC records.
26+
--json Output is in JSON format. (Default is CSV.)
2727
--debug Output should include more verbose logging.
2828
--dns=HOSTNAMES A comma-delimited list of DNS servers to query
2929
against. For example, if you want to use

0 commit comments

Comments
 (0)