xref: /freebsd/contrib/ldns/README (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1
2Contents:
3	REQUIREMENTS
4	INSTALLATION
5		libdns
6		examples
7		drill
8	INFORMATION FOR SPECIFIC OPERATING SYSTEMS
9		Mac OS X
10		Solaris
11	KNOWN ISSUES
12		pyldns
13        Your Support
14
15Project page:
16http://www.nlnetlabs.nl/ldns/
17On that page you can also subscribe to the ldns mailing list.
18
19* Development
20ldns is mainly developed on Linux and FreeBSD. It is regularly tested to
21compile on other systems like Solaris and Mac OS X.
22
23REQUIREMENTS
24- OpenSSL (Optional, but needed for features like DNSSEC)
25  - OpenSSL >= 0.9.7f for DANE support
26  - OpenSSL >= 1.0.0  for ECDSA and GOST support
27- libpcap (Optional, but needed for examples/ldns-dpa)
28- (GNU) libtool (in OSX, that's glibtool, not libtool)
29- GNU make
30
31INSTALLATION
321. Unpack the tarball
332. cd ldns-<VERSION>
343. ./configure --with-examples --with-drill
35   (optionally compile python bindings too with: --with-pyldns)
364. make
375. make install
38
39
40* Building from repository
41
42If you are building from the repository you will need to have (gnu)
43autotools like libtool and autoreconf installed. A list of all the commands
44needed to build everything can be found in README.git. Note that the actual
45commands may be a little bit different on your machine. Most notably, you'll
46need to run libtoolize (or glibtoolize). If you skip this step, you'll get
47an error about missing config.sub.
48
49* Developers
50ldns is developed by the ldns team at NLnet Labs. This team currently
51consists of:
52  o Willem Toorop
53  o Wouter Wijngaards
54
55Former main developers:
56  o Jelte Jansen
57  o Miek Gieben
58  o Matthijs Mekking
59
60* Credits
61We have received patches from the following people, thanks!
62  o Bedrich Kosata
63  o Erik Rozendaal
64  o Håkan Olsson
65  o Jakob Schlyter
66  o Paul Wouters
67  o Simon Vallet
68  o Ondřej Surý
69  o Karel Slany
70  o Havard Eidnes
71  o Leo Baltus
72  o Dag-Erling Smørgrav
73  o Felipe Gasper
74
75
76INFORMATION FOR SPECIFIC OPERATING SYSTEMS
77
78MAC OS X
79
80For MACOSX 10.4 and later, it seems that you have to set the
81MACOSX_DEPLOYMENT_TARGET environment variable to 10.4 before running
82make. Apparently it defaults to 10.1.
83
84This appears to be a known problem in 10.2 to 10.4, see:
85http://developer.apple.com/qa/qa2001/qa1233.html
86for more information.
87
88
89SOLARIS
90
91In Solaris multi-architecture systems (which have both 32-bit and
9264-bit support), it can be a bit taxing to convince the system to
93compile in 64-bit mode. Jakob Schlyter has kindly contributed a build
94script that sets the right build and link options. You can find it in
95contrib/build-solaris.sh
96
97KNOWN ISSUES
98
99A complete list of currently known open issues can be found here:
100https://github.com/NLnetLabs/ldns/issues
101
102* pyldns
103Compiling pyldns produces many ``unused parameter'' warnings.  Those are
104harmless and may safely be ignored.
105Also, when building with SWIG older than 2.0.4, compiling
106pyldns produces many ``missing initializer'' warnings. Those are harmless
107too.
108
109Your Support
110NLnet Labs offers all of its software products as open source, most
111published under a BSD license. You can download them, not only from the
112NLnet Labs website but also through the various OS distributions for
113which NSD, ldns, and Unbound are packaged. We therefore have little idea
114who uses our software in production environments and have no direct ties
115with 'our customers'.
116
117Therefore, we ask you to contact us at users@NLnetLabs.nl and tell us
118whether you use one of our products in your production environment,
119what that environment looks like, and maybe even share some praise.
120We would like to refer to the fact that your organization is using our
121products. We will only do that if you explicitly allow us. In all other
122cases we will keep the information you share with us to ourselves.
123
124In addition to the moral support you can also support us
125financially. NLnet Labs is a recognized not-for-profit charity foundation
126that is chartered to develop open-source software and open-standards
127for the Internet. If you use our software to satisfaction please express
128that by giving us a donation. For small donations PayPal can be used. For
129larger and regular donations please contact us at users@NLnetLabs.nl. Also
130see http://www.nlnetlabs.nl/labs/contributors/.
131
132