Update the description in the man page.

[email-validator.git] / email-validator.cabal

diff --git a/email-validator.cabal b/email-validator.cabal
index 88700645102ea45d113f40d169d2eefa36c71543..acb9fcaea8e6616408e8b0a41367e2fbe8cd93f3 100644 (file)
--- a/email-validator.cabal
+++ b/email-validator.cabal
@@ -12,7 +12,28 @@ 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
+  @
 
 
 executable email-validator