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