]> gitweb.michael.orlitzky.com - haeredes.git/blob - doc/man1/haeredes.1
Add a man page, and add a description to the cabal file.
[haeredes.git] / doc / man1 / haeredes.1
1 .TH haeredes 1
2
3 .SH NAME
4 haeredes \- Confirm delegation of NS and MX records.
5 .SH SYNOPSIS
6
7 \fBhaeredes\fR [\fIOPTIONS\fR] [\fIDELEGATES\fR]
8 .SH INPUT
9 .P
10 A list of domains, separated by whitespace.
11 .SH OUTPUT
12 .P
13 A list of domains which don't have the supplied (expected) delegates
14 listed as their NS/MX records.
15 .SH DESCRIPTION
16 .P
17 Haeredes is primarily useful for ISP network administrators. Customers
18 will occasionally decide to switch hosts without alerting the current
19 host; this can cause two problems.
20 .P
21 With NS records, the previous host (at the very least) keeps hosting a
22 DNS zone that does nothing. If that host uses their authoritative
23 nameserver as a caching lookup server as well, it may return
24 incorrect results to queries about the domain in question.
25 .P
26 For MX records, the situation is slightly worse. Most mail servers
27 will immediately accept mail for which the server thinks it is the
28 ultimate destination. If a mail server is configured as the
29 destination for a domain, but it is not the MX for that domain, then
30 mail submitted to that server may possibly be lost. It is therefore
31 important to remove domains from the old mail host as soon as the MX
32 record is changed.
33 .P
34 Haeredes can alert administrators when NS/MX records are changed.
35 .SH OPTIONS
36
37 .IP \fB\-\-server\fR,\ \fB-s\fR
38 Use the given DNS server rather than the resolvers listed in
39 /etc/resolv.conf.
40 .SH EXAMPLES
41
42 .IP \[bu] 2
43 Make sure example.com has the expected name servers,
44 [ab].iana-servers.net:
45
46 .nf
47 .I $ haeredes a.iana-servers.net b.iana-servers.net <<< \(dqexample.com\(dq
48 .fi
49 .IP \[bu]
50 Check orlitzky.com against the expected name servers, using
51 d.gtld-servers.net:
52
53 .nf
54 .I $ haeredes --server 199.7.91.13 dns1.viabit.com dns2.viabit.com \\\\
55 .I " <<< \(dqorlitzky.com\(dq"
56 .fi
57 .IP \[bu]
58 Check orlitzky.com against only one of the expected two nameservers:
59
60 .nf
61 .I $ haeredes dns1.viabit.com <<< \(dqorlitzky.com\(dq
62 Domain \(dqorlitzky.com.\(dq delegates somewhere else: \
63 \(dqdns2.viabit.com.\(dq
64 .fi
65 .IP \[bu]
66 Check a nonexistent domain (we provide no delegates, since we
67 know .invalid will not be delegated):
68
69 .nf
70 .I $ haeredes <<< \(dqexample.invalid\(dq
71 Domain \(dqexample.invalid.\(dq not delegated.
72 .fi
73 .SH BUGS
74 .P
75 Send bugs to michael@orlitzky.com.