X-Git-Url: https://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fman1%2Femail-validator.1;h=232a5f422da13539aa4e1521d73514624b156f85;hb=26d9ffe7a637c826da3b1b330843173205d79964;hp=5fd7d10c3a610f414ec0821dcc58458e24d4dac5;hpb=031638c08a4ce9d7ea156ead71cb8ef02e23fa81;p=email-validator.git diff --git a/doc/man1/email-validator.1 b/doc/man1/email-validator.1 index 5fd7d10..232a5f4 100644 --- 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\-ha\fR] [\fB-i \fIFILE\fR] [\fB-o \fIFILE\fR] \fI\fR +\fBemail-validator\fR [\fB\-har\fR] [\fB-i \fIFILE\fR] [\fB-o \fIFILE\fR] \fI\fR .SH INPUT @@ -22,24 +22,33 @@ stdout), one per line. .SH DESCRIPTION .P -We check the validity of an email address using three techniques: +Validate an email address using three techniques: .IP \[bu] 2 -We ensure that the length of local and domain parts is within the +Ensuring that the length of local and domain parts is within the RFC-specified limits. .IP \[bu] -A regular expression is used to check for invalid characters and syntax. +A syntax check using a regular expression, or the full RFC 5322 +grammar (see the \fB\-\-rfc5322\fR option). .IP \[bu] -We confirm the existence of a MX record for the domain part of the -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. +Confirmation of the existence of an \fIMX\fR record for the domain +part of the address. This is not required; in fact many domains accept +mail via an \fIA\fR record for e.g. example.com which is used in lieu +of an \fIMX\fR record. This behavior can be controlled via the +\fR\-\-accept\-a\fR flag. .P These checks are performed in parallel using the number of available -threads. +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 @@ -55,6 +64,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