cleaned spec file: added group and license fields
[platform/upstream/dnsmasq.git] / doc.html
1 <HTML>
2 <HEAD>
3 <TITLE> Dnsmasq - a DNS forwarder for NAT firewalls.</TITLE>
4 <link rel="icon"
5       href="http://www.thekelleys.org.uk/dnsmasq/images/favicon.ico">
6 </HEAD>
7 <BODY BGCOLOR="WHITE"> 
8 <table width="100%" border="0" cellpadding="0" cellspacing="0">
9 <tr>
10 <td align="left" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td>
11 <td align="middle" valign="middle"><h1>Dnsmasq</h1></td>
12 <td align="right" valign="middle"><img border="0" src="http://www.thekelleys.org.uk/dnsmasq/images/icon.png" /></td></tr>
13 </table>
14
15 Dnsmasq is a lightweight, easy to configure DNS forwarder and DHCP
16  server. It is designed to provide DNS and, optionally, DHCP, to a 
17  small network. It can serve the names of local machines which are 
18  not in the global DNS. The DHCP server integrates with the DNS 
19  server and allows machines with DHCP-allocated addresses
20  to appear in the DNS with names configured either in each host or
21  in a central configuration file. Dnsmasq supports static and dynamic 
22  DHCP leases and BOOTP/TFTP/PXE for network booting of diskless machines.
23 <P>
24  Dnsmasq is targeted at home networks using NAT and 
25 connected to the internet via a modem, cable-modem or ADSL
26 connection but would be a good choice for any smallish network (up to
27 1000 clients is known to work) where low
28 resource use and ease of configuration are important. 
29 <P>
30 Supported platforms include Linux (with glibc and uclibc), *BSD,
31 Solaris and Mac OS X.
32 Dnsmasq is included in at least the following Linux distributions:
33 Gentoo, Debian, Slackware, Suse, Fedora,
34 Smoothwall, IP-Cop, floppyfw, Firebox, LEAF, Freesco, fli4l,
35 CoyoteLinux, Endian Firewall and
36 Clarkconnect. It is also available as FreeBSD, OpenBSD and NetBSD ports and is used in
37 Linksys wireless routers (dd-wrt, openwrt and the stock firmware) and the m0n0wall project.
38 <P>
39 Dnsmasq provides the following features:
40 <DIR>
41
42 <LI> 
43 The DNS configuration of machines behind the firewall is simple and
44 doesn't depend on the details of the ISP's dns servers
45 <LI>
46 Clients which try to do DNS lookups while  a modem link to the
47 internet is down will time out immediately.
48 </LI>
49 <LI>
50 Dnsmasq will serve names from the /etc/hosts file on the firewall
51 machine: If the names of local machines are there, then they can all
52 be addressed without having to maintain /etc/hosts on each machine.
53 </LI>
54 <LI>
55 The integrated DHCP server supports static and dynamic DHCP leases and
56 multiple networks and IP ranges. It works across BOOTP relays and
57 supports DHCP options including RFC3397 DNS search lists.
58 Machines which are configured by DHCP have their names automatically 
59 included in the DNS and the names can specified by each machine or
60 centrally by associating a name with a MAC address in the dnsmasq
61 config file.
62 </LI>
63 <LI>
64 Dnsmasq caches internet addresses (A records and AAAA records) and address-to-name
65 mappings (PTR records), reducing the load on upstream servers and
66 improving performance (especially on modem connections). 
67 </LI>
68 <LI>
69 Dnsmasq can be configured to automatically pick up the addresses of
70 its upstream nameservers from ppp or dhcp configuration. It will
71 automatically reload this information if it changes. This facility
72 will be of particular interest to maintainers of Linux firewall
73 distributions since it allows dns configuration to be made automatic.
74 </LI>
75 <LI>
76 On IPv6-enabled boxes, dnsmasq can both talk to upstream servers via IPv6 
77 and offer DNS service via IPv6. On dual-stack (IPv4 and IPv6) boxes it talks
78 both protocols and can even act as IPv6-to-IPv4 or IPv4-to-IPv6 forwarder.
79 </LI>
80 <LI>
81 Dnsmasq can be configured to send queries for certain domains to
82 upstream servers handling only those domains. This makes integration
83 with private DNS systems easy.
84 </LI>
85 <LI>
86 Dnsmasq supports MX and SRV records and can be configured to return MX records
87 for any or all local machines.
88 </LI>
89 </DIR>
90
91 <H2>Download.</H2>
92
93 <A HREF="http://www.thekelleys.org.uk/dnsmasq/"> Download</A> dnsmasq here. 
94 The tarball includes this documentation, source, and manpage.
95 There is also a <A HREF="CHANGELOG"> CHANGELOG</A> and a <A HREF="FAQ">FAQ</A>.
96 Dnsmasq is part of the Debian distribution, it can be downloaded from 
97 <A HREF="http://ftp.debian.org/debian/pool/main/d/dnsmasq/"> here</A> or installed using <TT>apt</TT>.
98
99 <H2>Links.</H2>
100 Damien Raude-Morvan has an article in French at <A HREF="http://www.drazzib.com/docs-dnsmasq.html">http://www.drazzib.com/docs-dnsmasq.html</A>
101 There is a good article about dnsmasq at <A
102 HREF="http://www.enterprisenetworkingplanet.com/netos/article.php/3377351">http://www.enterprisenetworkingplanet.com/netos/article.php/3377351</A>
103 and another at <A
104 HREF="http://www.linux.com/articles/149040">http://www.linux.com/articles/149040</A>
105 and Ilya Evseev has an article in Russian about dnsmasq to be found at
106 <A HREF="http://ilya-evseev.narod.ru/articles/dnsmasq">
107 http://ilya-evseev.narod.ru/articles/dnsmasq</A>. Ismael Ull has an
108 article about dnsmasq in Spanish at <A HREF="http://www.mey-online.com.ar/blog/index.php/archives/guia-rapida-de-dnsmasq">http://www.mey-online.com.ar/blog/index.php/archives/guia-rapida-de-dnsmasq</A>
109 <H2>License.</H2>
110 Dnsmasq is distributed under the GPL. See the file COPYING in the distribution 
111 for details.
112
113 <H2>Contact.</H2>
114 There is a dnsmasq mailing list at <A
115 HREF="http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss">
116 http://lists.thekelleys.org.uk/mailman/listinfo/dnsmasq-discuss</A> which should be the
117 first location for queries, bugreports, suggestions etc.
118 Dnsmasq was written by Simon Kelley. You can contact me at <A
119 HREF="mailto:simon@thekelleys.org.uk">simon@thekelleys.org.uk</A>.
120 </BODY>
121