src: apply all hlint suggestions.
[haeredes.git] / haeredes.cabal
1 name: haeredes
2 version: 0.5.1
3 cabal-version: >= 1.8
4 author: Michael Orlitzky
5 maintainer: Michael Orlitzky <michael@orlitzky.com>
6 license: AGPL-3
7 license-file: doc/LICENSE
8 homepage: http://michael.orlitzky.com/code/haeredes.xhtml
9 bug-reports: mailto:michael@orlitzky.com
10 category: DNS, Utils
11 build-type: Simple
12 extra-source-files:
13 doc/man1/haeredes.1
14 test/shell/*.test
15 synopsis:
16 Confirm delegation of NS and MX records.
17 description:
18 Haeredes is primarily useful for ISP network administrators.
19 Customers will occasionally decide to switch hosts without alerting
20 the current host; this can cause two problems:
21 .
22 * With NS records, the previous host (at the very least) keeps
23 hosting a DNS zone that does nothing. If that host uses their
24 authoritative nameserver as a caching lookup server as well, it
25 may return incorrect results to queries about the domain in
26 question.
27 .
28 * For MX records, the situation is slightly worse. Most mail servers
29 will immediately accept mail for which the server thinks it is the
30 ultimate destination. If a mail server is configured as the
31 destination for a domain, but it is not the MX for that domain,
32 then mail submitted to that server may possibly be lost. It is
33 therefore important to remove domains from the old mail host as
34 soon as the MX record is changed.
35 .
36 Haeredes can alert administrators when NS/MX records are changed. More
37 detail and usage examples can be found in the man page.
38 .
39 /Examples/:
40 .
41 Make sure example.com has the expected name servers,
42 [ab].iana-servers.net:
43 .
44 @
45 $ echo \"example.com\" | haeredes a.iana-servers.net b.iana-servers.net
46 @
47 .
48 Check orlitzky.com against only one of the expected two nameservers:
49 .
50 @
51 $ echo \"orlitzky.com\" | haeredes dns1.viabit.com
52 Domain \"orlitzky.com.\" delegates somewhere else: \"dns2.viabit.com.\"
53 @
54 .
55 Check a nonexistent domain (we provide no delegates, since we
56 know .doesnt-exist will not be delegated):
57 .
58 @
59 $ echo \"foo.doesnt-exist\" | haeredes
60 Domain \"foo.doesnt-exist.\" not delegated.
61 @
62
63 executable haeredes
64 build-depends:
65 base == 4.*,
66 bytestring >= 0.10,
67 cmdargs >= 0.10,
68 dns >= 1.4,
69 iproute >= 1.2,
70 parallel-io >= 0.3
71
72 main-is:
73 Main.hs
74
75 hs-source-dirs:
76 src/
77
78 other-modules:
79 CommandLine
80 DNS
81 ExitCodes
82 -- WARNING: the Paths_haeredes module is automatically generated by
83 -- Cabal itself. We don't want it included in the release tarballs,
84 -- since we typically want the paths that the user has configured.
85 -- Nevertheless, Cabal will complain if we don't include it here.
86 Paths_haeredes
87 Timeout
88
89 ghc-options:
90 -Weverything
91 -Wno-implicit-prelude
92 -Wno-safe
93 -Wno-unsafe
94 -Wno-all-missed-specialisations
95 -rtsopts
96 -threaded
97 -optc-O3
98 -optc-march=native
99
100
101 test-suite doctests
102 type: exitcode-stdio-1.0
103 hs-source-dirs: test
104 main-is: Doctests.hs
105 build-depends:
106 base == 4.*,
107 -- Additional test dependencies.
108 doctest >= 0.9,
109 filemanip >= 0.3.6
110
111 -- It's not entirely clear to me why I have to reproduce all of this.
112 ghc-options:
113 -Weverything
114 -Wno-implicit-prelude
115 -Wno-safe
116 -Wno-unsafe
117 -Wno-all-missed-specialisations
118 -rtsopts
119 -threaded
120 -optc-O3
121 -optc-march=native
122
123
124 -- These won't work without shelltestrunner installed in your
125 -- $PATH. Maybe there is some way to tell Cabal that.
126 test-suite shelltests
127 type: exitcode-stdio-1.0
128 hs-source-dirs: test
129 main-is: ShellTests.hs
130
131 build-depends:
132 base == 4.*,
133 process >= 1.1
134
135 -- It's not entirely clear to me why I have to reproduce all of this.
136 ghc-options:
137 -Weverything
138 -Wno-implicit-prelude
139 -Wno-safe
140 -Wno-unsafe
141 -Wno-all-missed-specialisations
142 -rtsopts
143 -threaded
144 -optc-O3
145 -optc-march=native
146
147
148 source-repository head
149 type: git
150 location: http://gitweb.michael.orlitzky.com/haeredes.git
151 branch: master