]> gitweb.michael.orlitzky.com - email-validator.git/commitdiff
email-validator.cabal: drop the redundant description field
authorMichael Orlitzky <michael@orlitzky.com>
Thu, 25 Apr 2024 00:36:25 +0000 (20:36 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Thu, 25 Apr 2024 00:36:25 +0000 (20:36 -0400)
RTFM :)

email-validator.cabal

index 3e975f393b92cdbfefb234883f2640d4cf97de25..29e815937f7a1c5b43a48dbfcbb007fb8fc3823c 100644 (file)
@@ -19,36 +19,13 @@ description:
 
     * 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. NULLMX (RFC7505) records are not
-      accepted. This is not required; in fact many domains accept mail
-      via an @A@ record for (say) example.com which is used in lieu of
-      an @MX@ record. This behavior can be controlled via the
-      @--accept-a@ flag, but note that @--accept-a@ is ignored for
-      domains that have NULLMX records.
-
-  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 +RTS -N25 < addresses.csv
-  @
-
-  /Input/
-
-  The @input@ (via stdin) should be a list of email addresses,
-  one per line. Empty lines will be ignored.
-
-  /Output/
+      grammar.
+    * Confirmation of valid @MX@ records (or, optionally, @A@
+      records) for the domain.
 
-  Valid email addresses will be written to stdout, one per line.
+  A complete description, options, and examples can be found in the
+  man page.
 
 
 executable email-validator