Add an --rfc5322 option which validates against the real RFC syntax.

[email-validator.git] / doc / man1 / email-validator.1

diff --git a/doc/man1/email-validator.1 b/doc/man1/email-validator.1
index 3e56741dd694e2123ef826c7b603e01d4e16c6b5..95991872aca3da9da8fe1e1e6641a4bb81912525 100644 (file)
--- a/doc/man1/email-validator.1
+++ b/doc/man1/email-validator.1
@@ -5,7 +5,7 @@ email-validator \- Perform basic syntax and deliverability checks on email addre
 
 .SH SYNOPSIS
 
-\fBemail-validator\fR [\fB\-h\fR] [\fB-i \fIFILE\fR] [\fB-o \fIFILE\fR] \fI<input>\fR
+\fBemail-validator\fR [\fB\-har\fR] [\fB-i \fIFILE\fR] [\fB-o \fIFILE\fR] \fI<input>\fR
 
 .SH INPUT
 
@@ -33,10 +33,27 @@ A regular expression is used to check for invalid characters and syntax.
 
 .IP \[bu]
 We confirm the existence of a MX record for the domain part of the
-address.
+address. This is not required; in fact many domains accept mail via
+an 'A' record for e.g. example.com which is used in lieu of an MX
+record. This behavior can be controlled via the \fR\-a\fR flag.
+
+.P
+These checks are performed in parallel using the number of available
+threads. To increase the number of threads, you can pass the
+appropriate flag to the GHC runtime.
+
+.P
+This will set the number of threads to 25:
+
+.nf
+.B $ email-validator -i addresses.csv +RTS -N25
 
 .SH OPTIONS
 
+.IP \fB\-\-accept-a\fR,\ \fB\-a\fR
+Accept an 'A' record for the domain instead of requiring an MX record
+(the default).
+
 .IP \fB\-\-input\fR,\ \fB\-i\fR
 Specify the input file containing a list of email addresses, rather
 than using stdin (the default).
@@ -45,6 +62,10 @@ than using stdin (the default).
 Specify the output file to which the good addresses will be written,
 rather than using stdout (the default).
 
+.IP \fB\-\-rfc5322\fR,\ \fB\-r\fR
+Verify addresses against RFC 5322 rather than a naive regular
+expression. This is much more lenient than the default.
+
 .SH BUGS
 
 .P