]> gitweb.michael.orlitzky.com - email-validator.git/blob - email-validator.cabal
Add input/output sections to the cabal description.
[email-validator.git] / email-validator.cabal
1 name: email-validator
2 version: 0.0.1
3 cabal-version: >= 1.8
4 author: Michael Orlitzky
5 maintainer: Michael Orlitzky <michael@orlitzky.com>
6 category: Utils
7 license: GPL-3
8 license-file: doc/LICENSE
9 build-type: Simple
10 extra-source-files:
11 doc/man1/email-validator.1
12 synopsis:
13 Perform basic syntax and deliverability checks on email addresses.
14 description:
15 Validate an email address using three techniques:
16 .
17 * Ensuring that the length of local and domain parts is within the
18 RFC-specified limits.
19 .
20 * A syntax check using a regular expression, or the full RFC 5322
21 grammar (see the @--rfc5322@ option).
22 .
23 * Confirmation of the existence of an @MX@ record for the domain part of
24 the address. This is not required; in fact many domains accept mail
25 via an @A@ record for e.g. example.com which is used in lieu of an @MX@
26 record. This behavior can be controlled via the @--accept-a@ flag.
27 .
28 These checks are performed in parallel using the number of available
29 threads. To increase the number of threads, you can pass the
30 appropriate flag to the GHC runtime.
31 .
32 This will set the number of threads to 25:
33 .
34 @
35 $ email-validator -i addresses.csv +RTS -N25
36 @
37 .
38 /Input/
39 .
40 The @input@ file (default: stdin) should be a list of email addresses,
41 one per line. Empty lines will be ignored.
42 .
43 /Output/
44 .
45 Valid email addresses will be written to the output file (default:
46 stdout), one per line.
47
48
49 executable email-validator
50 build-depends:
51 base == 4.*,
52 bytestring == 0.10.*,
53 cmdargs == 0.10.*,
54 directory == 1.2.*,
55 dns == 0.3.*,
56 email-validate == 1.*,
57 HUnit == 1.2.*,
58 parallel-io == 0.3.*,
59 pcre-light >= 0.4,
60 test-framework == 0.8.*,
61 test-framework-hunit == 0.3.*,
62 utf8-string == 0.3.*
63
64 main-is:
65 Main.hs
66
67 hs-source-dirs:
68 src/
69
70 other-modules:
71 CommandLine
72 EmailAddress
73 ExitCodes
74
75 ghc-options:
76 -Wall
77 -fwarn-hi-shadowing
78 -fwarn-missing-signatures
79 -fwarn-name-shadowing
80 -fwarn-orphans
81 -fwarn-type-defaults
82 -fwarn-tabs
83 -fwarn-incomplete-record-updates
84 -fwarn-monomorphism-restriction
85 -fwarn-unused-do-bind
86 -rtsopts
87 -threaded
88 -optc-O3
89 -optc-march=native
90 -O2
91
92 ghc-prof-options:
93 -prof
94 -auto-all
95 -caf-all
96
97
98 test-suite testsuite
99 type: exitcode-stdio-1.0
100 hs-source-dirs: src test
101 main-is: TestSuite.hs
102 build-depends:
103 base == 4.*,
104 bytestring == 0.10.*,
105 cmdargs == 0.10.*,
106 directory == 1.2.*,
107 dns == 0.3.*,
108 email-validate == 1.*,
109 HUnit == 1.2.*,
110 parallel-io == 0.3.*,
111 pcre-light >= 0.4,
112 test-framework == 0.8.*,
113 test-framework-hunit == 0.3.*,
114 utf8-string == 0.3.*
115
116 -- It's not entirely clear to me why I have to reproduce all of this.
117 ghc-options:
118 -Wall
119 -fwarn-hi-shadowing
120 -fwarn-missing-signatures
121 -fwarn-name-shadowing
122 -fwarn-orphans
123 -fwarn-type-defaults
124 -fwarn-tabs
125 -fwarn-incomplete-record-updates
126 -fwarn-monomorphism-restriction
127 -fwarn-unused-do-bind
128 -rtsopts
129 -threaded
130 -optc-O3
131 -optc-march=native
132 -O2
133
134 source-repository head
135 type: git
136 location: http://michael.orlitzky.com/git/email-validator.git
137 branch: master