X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=email-validator.cabal;h=5efa913fd15bea7b41538b3a44e201269d543f4e;hb=841348097246a32b9a4b9eee1063e80321e03905;hp=7ccf0f0dd14cc056b636861515eb05e1baa06718;hpb=a5e228280dfbdbd8f2b1f271adb362fee1a43de4;p=email-validator.git

diff --git a/email-validator.cabal b/email-validator.cabal
index 7ccf0f0..5efa913 100644
--- a/email-validator.cabal
+++ b/email-validator.cabal
@@ -12,16 +12,48 @@ extra-source-files:
 synopsis:
   Perform basic syntax and deliverability checks on email addresses.
 description:
-  Perform basic syntax and deliverability checks on email addresses.
+  Validate an email address using three techniques:
+  .
+    * Ensuring that the length of local and domain parts is within the
+      RFC-specified limits.
+  .
+    * A syntax check using a regular expression, or the full RFC 5322
+      grammar (see the @--rfc5322@ option).
+  .
+    * Confirmation of the existence of an @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 @--accept-a@ flag.
+  .
+  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.
+  .
+  This will set the number of threads to 25:
+  .
+  @
+  $ email-validator -i addresses.csv +RTS -N25
+  @
+  .
+  /Input/
+  .
+  The @input@ file (default: stdin) should be a list of email addresses,
+  one per line. Empty lines will be ignored.
+  .
+  /Output/
+  .
+  Valid email addresses will be written to the output file (default:
+  stdout), one per line.
 
 
-executable email_validator
+executable email-validator
   build-depends:
     base                        == 4.*,
     bytestring                  == 0.10.*,
     cmdargs                     == 0.10.*,
     directory                   == 1.2.*,
     dns                         == 0.3.*,
+    email-validate              == 1.*,
     HUnit                       == 1.2.*,
     parallel-io                 == 0.3.*,
     pcre-light                  >= 0.4,
@@ -73,6 +105,7 @@ test-suite testsuite
     cmdargs                     == 0.10.*,
     directory                   == 1.2.*,
     dns                         == 0.3.*,
+    email-validate              == 1.*,
     HUnit                       == 1.2.*,
     parallel-io                 == 0.3.*,
     pcre-light                  >= 0.4,