X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=email-validator.cabal;h=acb9fcaea8e6616408e8b0a41367e2fbe8cd93f3;hb=4e58774754855bfae6c4a5cbd95eb30995794e50;hp=c5f7ea27060c3bed94c636717822a5844b8a4894;hpb=b749bc258eef9309049fb9c46f1d7143f795abe2;p=email-validator.git

diff --git a/email-validator.cabal b/email-validator.cabal
index c5f7ea2..acb9fca 100644
--- a/email-validator.cabal
+++ b/email-validator.cabal
@@ -3,25 +3,52 @@ version:        0.0.1
 cabal-version:  >= 1.8
 author:         Michael Orlitzky
 maintainer:	Michael Orlitzky <michael@orlitzky.com>
+category:       Utils
+license:        GPL-3
+license-file:   doc/LICENSE
+build-type:     Simple
+extra-source-files:
+  doc/man1/email-validator.1
 synopsis:
   Perform basic syntax and deliverability checks on email addresses.
-build-type:     Simple
+description:
+  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
+  @
 
 
-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.*,
-    QuickCheck                  == 2.6.*,
     pcre-light                  >= 0.4,
     test-framework              == 0.8.*,
     test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*,
     utf8-string                 == 0.3.*
 
   main-is:
@@ -30,6 +57,11 @@ executable email_validator
   hs-source-dirs:
     src/
 
+  other-modules:
+    CommandLine
+    EmailAddress
+    ExitCodes
+
   ghc-options:
     -Wall
     -fwarn-hi-shadowing
@@ -63,13 +95,12 @@ test-suite testsuite
     cmdargs                     == 0.10.*,
     directory                   == 1.2.*,
     dns                         == 0.3.*,
+    email-validate              == 1.*,
     HUnit                       == 1.2.*,
     parallel-io                 == 0.3.*,
-    QuickCheck                  == 2.6.*,
     pcre-light                  >= 0.4,
     test-framework              == 0.8.*,
     test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*,
     utf8-string                 == 0.3.*
 
   -- It's not entirely clear to me why I have to reproduce all of this.