]> git.ipfire.org Git - people/ms/dnsmasq.git/blame - man/dnsmasq.8
Linked-list bug in new "use longest prefixes first" code.
[people/ms/dnsmasq.git] / man / dnsmasq.8
CommitLineData
9e4abcb5
SK
1.TH DNSMASQ 8
2.SH NAME
3dnsmasq \- A lightweight DHCP and caching DNS server.
4.SH SYNOPSIS
5.B dnsmasq
6.I [OPTION]...
7.SH "DESCRIPTION"
8.BR dnsmasq
34d0a36a 9is a lightweight DNS, TFTP, PXE, router advertisement and DHCP server. It is intended to provide
5aabfc78 10coupled DNS and DHCP service to a LAN.
9e4abcb5
SK
11.PP
12Dnsmasq accepts DNS queries and either answers them from a small, local,
13cache or forwards them to a real, recursive, DNS server. It loads the
14contents of /etc/hosts so that local hostnames
15which do not appear in the global DNS can be resolved and also answers
34d0a36a 16DNS queries for DHCP configured hosts. It can also act as the authoritative DNS server for one or more domains, allowing local names to appear in the global DNS.
9e4abcb5 17.PP
73a08a24
SK
18The dnsmasq DHCP server supports static address assignments and multiple
19networks. It automatically
3be34541 20sends a sensible default set of DHCP options, and can be configured to
f2621c7f 21send any desired set of DHCP options, including vendor-encapsulated
1b7ecd11 22options. It includes a secure, read-only,
34d0a36a 23TFTP server to allow net/PXE boot of DHCP hosts and also supports BOOTP. The PXE support is full featured, and includes a proxy mode which supplies PXE information to clients whilst DHCP address allocation is done by another server.
9e4abcb5 24.PP
34d0a36a
SK
25The dnsmasq DHCPv6 server provides the same set of features as the DHCPv4 server, and in addition, it includes router advertisements and a neat feature which allows nameing for clients which use DHCPv4 and RA only for IPv6 configuration. There is support for doing address allocation (both DHCPv6 and RA) from subnets which are dynamically delegated via DHCPv6 prefix delegation.
26.PP
27Dnsmasq is coded with small embedded systems in mind. It aims for the smallest possible memory footprint compatible with the supported functions, and allows uneeded functions to be omitted from the compiled binary.
9e4abcb5
SK
28.SH OPTIONS
29Note that in general missing parameters are allowed and switch off
832af0ba 30functions, for instance "--pid-file" disables writing a PID file. On
33820b7e
SK
31BSD, unless the GNU getopt library is linked, the long form of the
32options does not work on the command line; it is still recognised in
33the configuration file.
9e4abcb5 34.TP
7622fc06
SK
35.B --test
36Read and syntax check configuration file(s). Exit with code 0 if all
37is OK, or a non-zero code otherwise. Do not start up dnsmasq.
38.TP
9e4abcb5
SK
39.B \-h, --no-hosts
40Don't read the hostnames in /etc/hosts.
41.TP
42.B \-H, --addn-hosts=<file>
43Additional hosts file. Read the specified file as well as /etc/hosts. If -h is given, read
fd9fa481 44only the specified file. This option may be repeated for more than one
7622fc06 45additional hosts file. If a directory is given, then read all the files contained in that directory.
9e4abcb5 46.TP
832af0ba
SK
47.B \-E, --expand-hosts
48Add the domain to simple names (without a period) in /etc/hosts
1f15b81d
SK
49in the same way as for DHCP-derived names. Note that this does not
50apply to domain names in cnames, PTR records, TXT records etc.
832af0ba 51.TP
9e4abcb5
SK
52.B \-T, --local-ttl=<time>
53When replying with information from /etc/hosts or the DHCP leases
54file dnsmasq by default sets the time-to-live field to zero, meaning
c72daea8 55that the requester should not itself cache the information. This is
9e4abcb5
SK
56the correct thing to do in almost all situations. This option allows a
57time-to-live (in seconds) to be given for these replies. This will
58reduce the load on the server at the expense of clients using stale
59data under some circumstances.
60.TP
824af85b
SK
61.B --neg-ttl=<time>
62Negative replies from upstream servers normally contain time-to-live
63information in SOA records which dnsmasq uses for caching. If the
64replies from upstream servers omit this information, dnsmasq does not
65cache the reply. This option gives a default value for time-to-live
66(in seconds) which dnsmasq uses to cache negative replies even in
67the absence of an SOA record.
68.TP
8ef5ada2
SK
69.B --max-ttl=<time>
70Set a maximum TTL value that will be handed out to clients. The specified
71maximum TTL will be given to clients instead of the true TTL value if it is
72lower. The true TTL value is however kept in the cache to avoid flooding
73the upstream DNS servers.
74.TP
1d860415
SK
75.B --max-cache-ttl=<time>
76Set a maximum TTL value for entries in the cache.
77.TP
3be34541
SK
78.B \-k, --keep-in-foreground
79Do not go into the background at startup but otherwise run as
3d8df260
SK
80normal. This is intended for use when dnsmasq is run under daemontools
81or launchd.
3be34541 82.TP
9e4abcb5
SK
83.B \-d, --no-daemon
84Debug mode: don't fork to the background, don't write a pid file,
85don't change user id, generate a complete cache dump on receipt on
3be34541 86SIGUSR1, log to stderr as well as syslog, don't fork new processes
83b2198e
SK
87to handle TCP queries. Note that this option is for use in debugging
88only, to stop dnsmasq daemonising in production, use
89.B -k.
9e4abcb5
SK
90.TP
91.B \-q, --log-queries
92Log the results of DNS queries handled by dnsmasq. Enable a full cache dump on receipt of SIGUSR1.
93.TP
849a8357
SK
94.B \-8, --log-facility=<facility>
95Set the facility to which dnsmasq will send syslog entries, this
f2621c7f 96defaults to DAEMON, and to LOCAL0 when debug mode is in operation. If
9e038946 97the facility given contains at least one '/' character, it is taken to
f2621c7f 98be a filename, and dnsmasq logs to the given file, instead of
8ef5ada2
SK
99syslog. If the facility is '-' then dnsmasq logs to stderr.
100(Errors whilst reading configuration will still go to syslog,
f2621c7f 101but all output from a successful startup, and all output whilst
5aabfc78
SK
102running, will go exclusively to the file.) When logging to a file,
103dnsmasq will close and reopen the file when it receives SIGUSR2. This
104allows the log file to be rotated without stopping dnsmasq.
f2621c7f
SK
105.TP
106.B --log-async[=<lines>]
107Enable asynchronous logging and optionally set the limit on the
108number of lines
109which will be queued by dnsmasq when writing to the syslog is slow.
110Dnsmasq can log asynchronously: this
111allows it to continue functioning without being blocked by syslog, and
112allows syslog to use dnsmasq for DNS queries without risking deadlock.
113If the queue of log-lines becomes full, dnsmasq will log the
114overflow, and the number of messages lost. The default queue length is
1155, a sane value would be 5-25, and a maximum limit of 100 is imposed.
849a8357 116.TP
9e4abcb5
SK
117.B \-x, --pid-file=<path>
118Specify an alternate path for dnsmasq to record its process-id in. Normally /var/run/dnsmasq.pid.
119.TP
120.B \-u, --user=<username>
121Specify the userid to which dnsmasq will change after startup. Dnsmasq must normally be started as root, but it will drop root
b8187c80 122privileges after startup by changing id to another user. Normally this user is "nobody" but that
9e4abcb5
SK
123can be over-ridden with this switch.
124.TP
125.B \-g, --group=<groupname>
126Specify the group which dnsmasq will run
127as. The defaults to "dip", if available, to facilitate access to
128/etc/ppp/resolv.conf which is not normally world readable.
129.TP
130.B \-v, --version
131Print the version number.
132.TP
133.B \-p, --port=<port>
824af85b
SK
134Listen on <port> instead of the standard DNS port (53). Setting this
135to zero completely disables DNS function, leaving only DHCP and/or TFTP.
9e4abcb5 136.TP
feba5c1d
SK
137.B \-P, --edns-packet-max=<size>
138Specify the largest EDNS.0 UDP packet which is supported by the DNS
316e2730 139forwarder. Defaults to 4096, which is the RFC5625-recommended size.
feba5c1d 140.TP
9e4abcb5 141.B \-Q, --query-port=<query_port>
1a6bca81
SK
142Send outbound DNS queries from, and listen for their replies on, the
143specific UDP port <query_port> instead of using random ports. NOTE
144that using this option will make dnsmasq less secure against DNS
145spoofing attacks but it may be faster and use less resources. Setting this option
146to zero makes dnsmasq use a single port allocated to it by the
147OS: this was the default behaviour in versions prior to 2.43.
148.TP
149.B --min-port=<port>
150Do not use ports less than that given as source for outbound DNS
151queries. Dnsmasq picks random ports as source for outbound queries:
152when this option is given, the ports used will always to larger
153than that specified. Useful for systems behind firewalls.
9e4abcb5
SK
154.TP
155.B \-i, --interface=<interface name>
feba5c1d
SK
156Listen only on the specified interface(s). Dnsmasq automatically adds
157the loopback (local) interface to the list of interfaces to use when
158the
159.B \--interface
160option is used. If no
161.B \--interface
9e4abcb5 162or
feba5c1d
SK
163.B \--listen-address
164options are given dnsmasq listens on all available interfaces except any
165given in
166.B \--except-interface
309331f5 167options. IP alias interfaces (eg "eth1:0") cannot be used with
8a911ccc
SK
168.B --interface
169or
170.B --except-interface
309331f5 171options, use --listen-address instead.
9e4abcb5
SK
172.TP
173.B \-I, --except-interface=<interface name>
feba5c1d
SK
174Do not listen on the specified interface. Note that the order of
175.B \--listen-address
176.B --interface
177and
178.B --except-interface
179options does not matter and that
180.B --except-interface
181options always override the others.
34d0a36a
SK
182.TP
183.B --auth-server=<domain>,<interface>|<ip-address>
184Enable DNS authoritative mode for queries arriving at an interface or address. Note that the the interface or address
185need not be mentioned in
186.B --interface
187or
188.B --listen-address
189configuration, indeed
190.B --auth-server
191will overide these and provide a different DNS service on the specified interface. The <domain> is the "glue record". It should resolve in the global DNS to a A and/or AAAA record which points to the address dnsmasq is listening on.
9e4abcb5 192.TP
3d8df260 193.B \-2, --no-dhcp-interface=<interface name>
832af0ba 194Do not provide DHCP or TFTP on the specified interface, but do provide DNS service.
3d8df260 195.TP
44a2a316 196.B \-a, --listen-address=<ipaddr>
feba5c1d
SK
197Listen on the given IP address(es). Both
198.B \--interface
199and
200.B \--listen-address
201options may be given, in which case the set of both interfaces and
202addresses is used. Note that if no
203.B \--interface
204option is given, but
205.B \--listen-address
206is, dnsmasq will not automatically listen on the loopback
207interface. To achieve this, its IP address, 127.0.0.1, must be
208explicitly given as a
209.B \--listen-address
210option.
9e4abcb5 211.TP
44a2a316
SK
212.B \-z, --bind-interfaces
213On systems which support it, dnsmasq binds the wildcard address,
214even when it is listening on only some interfaces. It then discards
215requests that it shouldn't reply to. This has the advantage of
216working even when interfaces come and go and change address. This
217option forces dnsmasq to really bind only the interfaces it is
218listening on. About the only time when this is useful is when
f6b7dc47 219running another nameserver (or another instance of dnsmasq) on the
309331f5 220same machine. Setting this option also enables multiple instances of
f6b7dc47
SK
221dnsmasq which provide DHCP service to run in the same machine.
222.TP
54dd393f
SK
223.B --bind-dynamic
224Enable a network mode which is a hybrid between
225.B --bind-interfaces
a2ce6fcc 226and the default. Dnsmasq binds the address of individual interfaces,
54dd393f
SK
227allowing multiple dnsmasq instances, but if new interfaces or
228addresses appear, it automatically listens on those (subject to any
229access-control configuration). This makes dynamically created
230interfaces work in the same way as the default. Implementing this
a2ce6fcc 231option requires non-standard networking APIs and it is only available
05ff1ed7 232under Linux. On other platforms it falls-back to --bind-interfaces mode.
54dd393f 233.TP
f6b7dc47
SK
234.B \-y, --localise-queries
235Return answers to DNS queries from /etc/hosts which depend on the interface over which the query was
b8187c80 236received. If a name in /etc/hosts has more than one address associated with
f6b7dc47
SK
237it, and at least one of those addresses is on the same subnet as the
238interface to which the query was sent, then return only the
239address(es) on that subnet. This allows for a server to have multiple
240addresses in /etc/hosts corresponding to each of its interfaces, and
241hosts will get the correct address based on which network they are
242attached to. Currently this facility is limited to IPv4.
44a2a316 243.TP
9e4abcb5
SK
244.B \-b, --bogus-priv
245Bogus private reverse lookups. All reverse lookups for private IP ranges (ie 192.168.x.x, etc)
feba5c1d
SK
246which are not found in /etc/hosts or the DHCP leases file are answered
247with "no such domain" rather than being forwarded upstream.
9e4abcb5 248.TP
73a08a24 249.B \-V, --alias=[<old-ip>]|[<start-ip>-<end-ip>],<new-ip>[,<mask>]
1cff166d
SK
250Modify IPv4 addresses returned from upstream nameservers; old-ip is
251replaced by new-ip. If the optional mask is given then any address
252which matches the masked old-ip will be re-written. So, for instance
253.B --alias=1.2.3.0,6.7.8.0,255.255.255.0
254will map 1.2.3.56 to 6.7.8.56 and 1.2.3.67 to 6.7.8.67. This is what
73a08a24
SK
255Cisco PIX routers call "DNS doctoring". If the old IP is given as
256range, then only addresses in the range, rather than a whole subnet,
257are re-written. So
258.B --alias=192.168.0.10-192.168.0.40,10.0.0.0,255.255.255.0
259maps 192.168.0.10->192.168.0.40 to 10.0.0.10->10.0.0.40
1cff166d 260.TP
9e4abcb5
SK
261.B \-B, --bogus-nxdomain=<ipaddr>
262Transform replies which contain the IP address given into "No such
263domain" replies. This is intended to counteract a devious move made by
b8187c80 264Verisign in September 2003 when they started returning the address of
9e4abcb5
SK
265an advertising web page in response to queries for unregistered names,
266instead of the correct NXDOMAIN response. This option tells dnsmasq to
267fake the correct response when it sees this behaviour. As at Sept 2003
b8187c80 268the IP address being returned by Verisign is 64.94.110.11
9e4abcb5
SK
269.TP
270.B \-f, --filterwin2k
271Later versions of windows make periodic DNS requests which don't get sensible answers from
272the public DNS and can cause problems by triggering dial-on-demand links. This flag turns on an option
273to filter such requests. The requests blocked are for records of types SOA and SRV, and type ANY where the
274requested name has underscores, to catch LDAP requests.
275.TP
276.B \-r, --resolv-file=<file>
277Read the IP addresses of the upstream nameservers from <file>, instead of
278/etc/resolv.conf. For the format of this file see
7de060b0
SK
279.BR resolv.conf (5).
280The only lines relevant to dnsmasq are nameserver ones. Dnsmasq can
9e4abcb5
SK
281be told to poll more than one resolv.conf file, the first file name specified
282overrides the default, subsequent ones add to the list. This is only
283allowed when polling; the file with the currently latest modification
284time is the one used.
285.TP
286.B \-R, --no-resolv
287Don't read /etc/resolv.conf. Get upstream servers only from the command
b49644f3 288line or the dnsmasq configuration file.
9e4abcb5 289.TP
ad094275 290.B \-1, --enable-dbus[=<service-name>]
3d8df260
SK
291Allow dnsmasq configuration to be updated via DBus method calls. The
292configuration which can be changed is upstream DNS servers (and
b8187c80 293corresponding domains) and cache clear. Requires that dnsmasq has
ad094275
SK
294been built with DBus support. If the service name is given, dnsmasq
295provides service at that name, rather than the default which is
296.B uk.org.thekelleys.dnsmasq
3d8df260 297.TP
9e4abcb5
SK
298.B \-o, --strict-order
299By default, dnsmasq will send queries to any of the upstream servers
824af85b 300it knows about and tries to favour servers that are known to
9e4abcb5
SK
301be up. Setting this flag forces dnsmasq to try each query with each
302server strictly in the order they appear in /etc/resolv.conf
303.TP
824af85b
SK
304.B --all-servers
305By default, when dnsmasq has more than one upstream server available,
306it will send queries to just one server. Setting this flag forces
307dnsmasq to send all queries to all available servers. The reply from
c72daea8 308the server which answers first will be returned to the original requester.
824af85b
SK
309.TP
310.B --stop-dns-rebind
311Reject (and log) addresses from upstream nameservers which are in the
312private IP ranges. This blocks an attack where a browser behind a
313firewall is used to probe machines on the local network.
314.TP
8ef5ada2
SK
315.B --rebind-localhost-ok
316Exempt 127.0.0.0/8 from rebinding checks. This address range is
317returned by realtime black hole servers, so blocking it may disable
318these services.
319.TP
320.B --rebind-domain-ok=[<domain>]|[[/<domain>/[<domain>/]
321Do not detect and block dns-rebind on queries to these domains. The
322argument may be either a single domain, or multiple domains surrounded
323by '/', like the --server syntax, eg.
324.B --rebind-domain-ok=/domain1/domain2/domain3/
325.TP
9e4abcb5
SK
326.B \-n, --no-poll
327Don't poll /etc/resolv.conf for changes.
328.TP
1697269c
SK
329.B --clear-on-reload
330Whenever /etc/resolv.conf is re-read, clear the DNS cache.
331This is useful when new nameservers may have different
332data than that held in cache.
333.TP
9e4abcb5 334.B \-D, --domain-needed
7de060b0 335Tells dnsmasq to never forward A or AAAA queries for plain names, without dots
3d8df260 336or domain parts, to upstream nameservers. If the name is not known
9e4abcb5
SK
337from /etc/hosts or DHCP then a "not found" answer is returned.
338.TP
824af85b 339.B \-S, --local, --server=[/[<domain>]/[domain/]][<ipaddr>[#<port>][@<source-ip>|<interface>[#<port>]]
5aabfc78 340Specify IP address of upstream servers directly. Setting this flag does
9e4abcb5
SK
341not suppress reading of /etc/resolv.conf, use -R to do that. If one or
342more
343optional domains are given, that server is used only for those domains
344and they are queried only using the specified server. This is
345intended for private nameservers: if you have a nameserver on your
346network which deals with names of the form
347xxx.internal.thekelleys.org.uk at 192.168.1.1 then giving the flag
b8187c80 348.B -S /internal.thekelleys.org.uk/192.168.1.1
9e4abcb5
SK
349will send all queries for
350internal machines to that nameserver, everything else will go to the
351servers in /etc/resolv.conf. An empty domain specification,
352.B //
353has the special meaning of "unqualified names only" ie names without any
354dots in them. A non-standard port may be specified as
355part of the IP
356address using a # character.
357More than one -S flag is allowed, with
8ef5ada2
SK
358repeated domain or ipaddr parts as required.
359
360More specific domains take precendence over less specific domains, so:
361.B --server=/google.com/1.2.3.4
362.B --server=/www.google.com/2.3.4.5
363will send queries for *.google.com to 1.2.3.4, except *www.google.com,
364which will go to 2.3.4.5
365
366The special server address '#' means, "use the standard servers", so
367.B --server=/google.com/1.2.3.4
368.B --server=/www.google.com/#
369will send queries for *.google.com to 1.2.3.4, except *www.google.com which will
370be forwarded as usual.
9e4abcb5
SK
371
372Also permitted is a -S
373flag which gives a domain but no IP address; this tells dnsmasq that
374a domain is local and it may answer queries from /etc/hosts or DHCP
375but should never forward queries on that domain to any upstream
376servers.
377.B local
378is a synonym for
379.B server
380to make configuration files clearer in this case.
381
7de060b0
SK
382IPv6 addresses may include a %interface scope-id, eg
383fe80::202:a412:4512:7bbf%eth0.
384
824af85b
SK
385The optional string after the @ character tells
386dnsmasq how to set the source of the queries to this
387nameserver. It should be an ip-address, which should belong to the machine on which
9e4abcb5 388dnsmasq is running otherwise this server line will be logged and then
824af85b
SK
389ignored, or an interface name. If an interface name is given, then
390queries to the server will be forced via that interface; if an
391ip-address is given then the source address of the queries will be set
392to that address.
393The query-port flag is ignored for any servers which have a
9e4abcb5 394source address specified but the port may be specified directly as
824af85b
SK
395part of the source address. Forcing queries to an interface is not
396implemented on all platforms supported by dnsmasq.
9e4abcb5
SK
397.TP
398.B \-A, --address=/<domain>/[domain/]<ipaddr>
399Specify an IP address to return for any host in the given domains.
400Queries in the domains are never forwarded and always replied to
401with the specified IP address which may be IPv4 or IPv6. To give
402both IPv4 and IPv6 addresses for a domain, use repeated -A flags.
403Note that /etc/hosts and DHCP leases override this for individual
404names. A common use of this is to redirect the entire doubleclick.net
a222641c
SK
405domain to some friendly local web server to avoid banner ads. The
406domain specification works in the same was as for --server, with the
407additional facility that /#/ matches any domain. Thus
408--address=/#/1.2.3.4 will always return 1.2.3.4 for any query not
409answered from /etc/hosts or DHCP and not sent to an upstream
410nameserver by a more specific --server directive.
9e4abcb5 411.TP
f6b7dc47 412.B \-m, --mx-host=<mx name>[[,<hostname>],<preference>]
de37951c
SK
413Return an MX record named <mx name> pointing to the given hostname (if
414given), or
415the host specified in the --mx-target switch
9e4abcb5 416or, if that switch is not given, the host on which dnsmasq
f6b7dc47
SK
417is running. The default is useful for directing mail from systems on a LAN
418to a central server. The preference value is optional, and defaults to
4191 if not given. More than one MX record may be given for a host.
9e4abcb5
SK
420.TP
421.B \-t, --mx-target=<hostname>
f6b7dc47
SK
422Specify the default target for the MX record returned by dnsmasq. See
423--mx-host. If --mx-target is given, but not --mx-host, then dnsmasq
424returns a MX record containing the MX target for MX queries on the
425hostname of the machine on which dnsmasq is running.
9e4abcb5
SK
426.TP
427.B \-e, --selfmx
428Return an MX record pointing to itself for each local
429machine. Local machines are those in /etc/hosts or with DHCP leases.
430.TP
431.B \-L, --localmx
432Return an MX record pointing to the host given by mx-target (or the
433machine on which dnsmasq is running) for each
434local machine. Local machines are those in /etc/hosts or with DHCP
435leases.
436.TP
f6b7dc47
SK
437.B \-W, --srv-host=<_service>.<_prot>.[<domain>],[<target>[,<port>[,<priority>[,<weight>]]]]
438Return a SRV DNS record. See RFC2782 for details. If not supplied, the
439domain defaults to that given by
440.B --domain.
441The default for the target domain is empty, and the default for port
442is one and the defaults for
443weight and priority are zero. Be careful if transposing data from BIND
444zone files: the port, weight and priority numbers are in a different
445order. More than one SRV record for a given service/domain is allowed,
3d8df260 446all that match are returned.
f6b7dc47 447.TP
e46164e0 448.B --host-record=<name>[,<name>....][<IPv4-address>],[<IPv6-address>]
e759d426
SK
449Add A, AAAA and PTR records to the DNS. This adds one or more names to
450the DNS with associated IPv4 (A) and IPv6 (AAAA) records. A name may
451appear in more than one
452.B host-record
453and therefore be assigned more than one address. Only the first
454address creates a PTR record linking the address to the name. This is
455the same rule as is used reading hosts-files.
456.B host-record
457options are considered to be read before host-files, so a name
458appearing there inhibits PTR-record creation if it appears in
e46164e0 459hosts-file also. Unlike hosts-files, names are not expanded, even when
e759d426
SK
460.B expand-hosts
461is in effect. Short and long names may appear in the same
e46164e0
SK
462.B host-record,
463eg.
464.B --host-record=laptop,laptop.thekelleys.org,192.168.0.1,1234::100
e759d426 465.TP
0a852541
SK
466.B \-Y, --txt-record=<name>[[,<text>],<text>]
467Return a TXT DNS record. The value of TXT record is a set of strings,
28866e95
SK
468so any number may be included, delimited by commas; use quotes to put
469commas into a string. Note that the maximum length of a single string
470is 255 characters, longer strings are split into 255 character chunks.
0a852541 471.TP
832af0ba
SK
472.B --ptr-record=<name>[,<target>]
473Return a PTR DNS record.
474.TP
1a6bca81
SK
475.B --naptr-record=<name>,<order>,<preference>,<flags>,<service>,<regexp>[,<replacement>]
476Return an NAPTR DNS record, as specified in RFC3403.
477.TP
9009d746
SK
478.B --cname=<cname>,<target>
479Return a CNAME record which indicates that <cname> is really
480<target>. There are significant limitations on the target; it must be a
481DNS name which is known to dnsmasq from /etc/hosts (or additional
611ebc5f
SK
482hosts files), from DHCP or from another
483.B --cname.
484If the target does not satisfy this
9009d746
SK
485criteria, the whole cname is ignored. The cname must be unique, but it
486is permissable to have more than one cname pointing to the same target.
487.TP
9f7f3b12
SK
488.B --dns-rr=<name>,<RR-number>,[<hex data>]
489Return an arbitrary DNS Resource Record. The number is the type of the
490record (which is always in the C_IN class). The value of the record is
a2ce6fcc 491given by the hex data, which may be of the form 01:23:45 or 01 23 45 or
9f7f3b12
SK
492012345 or any mixture of these.
493.TP
f2621c7f
SK
494.B --interface-name=<name>,<interface>
495Return a DNS record associating the name with the primary address on
496the given interface. This flag specifies an A record for the given
497name in the same way as an /etc/hosts line, except that the address is
498not constant, but taken from the given interface. If the interface is
9e038946 499down, not configured or non-existent, an empty record is returned. The
f2621c7f
SK
500matching PTR record is also created, mapping the interface address to
501the name. More than one name may be associated with an interface
502address by repeating the flag; in that case the first instance is used
503for the reverse address-to-name mapping.
504.TP
28866e95
SK
505.B --add-mac
506Add the MAC address of the requestor to DNS queries which are
507forwarded upstream. This may be used to DNS filtering by the upstream
508server. The MAC address can only be added if the requestor is on the same
509subnet as the dnsmasq server. Note that the mechanism used to achieve this (an EDNS0 option)
510is not yet standardised, so this should be considered
511experimental. Also note that exposing MAC addresses in this way may
512have security and privacy implications.
513.TP
9e4abcb5
SK
514.B \-c, --cache-size=<cachesize>
515Set the size of dnsmasq's cache. The default is 150 names. Setting the cache size to zero disables caching.
516.TP
517.B \-N, --no-negcache
518Disable negative caching. Negative caching allows dnsmasq to remember
519"no such domain" answers from upstream nameservers and answer
5aabfc78 520identical queries without forwarding them again.
9e4abcb5 521.TP
1697269c
SK
522.B \-0, --dns-forward-max=<queries>
523Set the maximum number of concurrent DNS queries. The default value is
524150, which should be fine for most setups. The only known situation
525where this needs to be increased is when using web-server log file
526resolvers, which can generate large numbers of concurrent queries.
208b65c5 527.TP
28866e95
SK
528.B --proxy-dnssec
529A resolver on a client machine can do DNSSEC validation in two ways: it
530can perform the cryptograhic operations on the reply it receives, or
531it can rely on the upstream recursive nameserver to do the validation
532and set a bit in the reply if it succeeds. Dnsmasq is not a DNSSEC
533validator, so it cannot perform the validation role of the recursive nameserver,
534but it can pass through the validation results from its own upstream
535nameservers. This option enables this behaviour. You should only do
536this if you trust all the configured upstream nameservers
537.I and the network between you and them.
538If you use the first DNSSEC mode, validating resolvers in clients,
539this option is not required. Dnsmasq always returns all the data
540needed for a client to do validation itself.
541.TP
34d0a36a
SK
542.B --auth-zone=<domain>[,<subnet>[,<subnet>.....]]
543Define a DNS zone for which dnsmasq acts as authoritative server. Locally defined DNS records which are in the domain
544will be served, except that A and AAAA records must be in one of the specified subnets, or in a subnet corresponding to a contructed DHCP range. The subnet(s) are also used to define in-addr.arpa and ipv6.arpa domains which are served for reverse-DNS queries.
545.TP
7de060b0
SK
546.B --conntrack
547Read the Linux connection track mark associated with incoming DNS
548queries and set the same mark value on upstream traffic used to answer
549those queries. This allows traffic generated by dnsmasq to be
550associated with the queries which cause it, useful for bandwidth
551accounting and firewalling. Dnsmasq must have conntrack support
552compiled in and the kernel must have conntrack support
553included and configured. This option cannot be combined with
554--query-port.
555.TP
8bc4cece 556.B \-F, --dhcp-range=[tag:<tag>[,tag:<tag>],][set:<tag],]<start-addr>[,<end-addr>][,<mode>][,<netmask>[,<broadcast>]][,<lease time>]
1adadf58 557.TP
34d0a36a 558.B \-F, --dhcp-range=[tag:<tag>[,tag:<tag>],][set:<tag],]<start-IPv6addr>[,<end-IPv6addr>|constuctor:<interface>][,<mode>][,<prefix-len>][,<lease time>]
1adadf58 559
9e4abcb5 560Enable the DHCP server. Addresses will be given out from the range
44a2a316
SK
561<start-addr> to <end-addr> and from statically defined addresses given
562in
563.B dhcp-host
564options. If the lease time is given, then leases
b8187c80 565will be given for that length of time. The lease time is in seconds,
7622fc06
SK
566or minutes (eg 45m) or hours (eg 1h) or "infinite". If not given,
567the default lease time is one hour. The
c8257540
SK
568minimum lease time is two minutes. For IPv6 ranges, the lease time
569maybe "deprecated"; this sets the preferred lifetime sent in a DHCP
570lease or router advertisement to zero, which causes clients to use
571other addresses, if available, for new connections as a prelude to renumbering.
572
573This option may be repeated, with different addresses, to enable DHCP
44a2a316
SK
574service to more than one network. For directly connected networks (ie,
575networks on which the machine running dnsmasq has an interface) the
7de060b0
SK
576netmask is optional: dnsmasq will determine it from the interface
577configuration. For networks which receive DHCP service via a relay
578agent, dnsmasq cannot determine the netmask itself, so it should be
579specified, otherwise dnsmasq will have to guess, based on the class (A, B or
580C) of the network address. The broadcast address is
7622fc06 581always optional. It is always
8ef5ada2
SK
582allowed to have more than one dhcp-range in a single subnet.
583
1adadf58
SK
584For IPv6, the parameters are slightly different: instead of netmask
585and broadcast address, there is an optional prefix length. If not
586given, this defaults to 64. Unlike the IPv4 case, the prefix length is not
587automatically derived from the interface configuration. The mimimum
588size of the prefix length is 64.
589
34d0a36a
SK
590IPv6 (only) supports another type of range. In this, the start address and optional end address contain only the network part (ie ::1) and they are followed by
591.B constructor:<interface>.
592This forms a template which describes how to create ranges, based on the addresses assigned to the interface. For instance
593
594.B --dhcp-range=::1,::4,constructor:eth0
595
596will look for addreses of the form <network>::1 on eth0 and then create a range from <network>::1 to <network>::400. If the interface is assigned more than one network, then the corresponding ranges will be automatically created, and then deprecated and finally removed again as the address is deprecated and then deleted. The interface name may have a final "*" wildcard.
597
8ef5ada2
SK
598The optional
599.B set:<tag>
600sets an alphanumeric label which marks this network so that
0a852541 601dhcp options may be specified on a per-network basis.
8ef5ada2 602When it is prefixed with 'tag:' instead, then its meaning changes from setting
c5ad4e79
SK
603a tag to matching it. Only one tag may be set, but more than one tag
604may be matched.
605
e8ca69ea 606The optional <mode> keyword may be
33820b7e
SK
607.B static
608which tells dnsmasq to enable DHCP for the network specified, but not
7622fc06 609to dynamically allocate IP addresses: only hosts which have static
33820b7e
SK
610addresses given via
611.B dhcp-host
52002051
SK
612or from /etc/ethers will be served. A static-only subnet with address
613all zeros may be used as a "catch-all" address to enable replies to all
614Information-request packets on a subnet which is provided with
615stateless DHCPv6, ie
616.B --dhcp=range=::,static
c5ad4e79 617
e46164e0 618For IPv4, the <mode> may be
7622fc06
SK
619.B proxy
620in which case dnsmasq will provide proxy-DHCP on the specified
621subnet. (See
622.B pxe-prompt
623and
624.B pxe-service
e8ca69ea
SK
625for details.)
626
627For IPv6, the mode may be some combination of
628.B ra-only, slaac, ra-names, ra-stateless.
8ef5ada2 629
c5ad4e79 630.B ra-only
e8ca69ea
SK
631tells dnsmasq to offer Router Advertisement only on this subnet,
632and not DHCP.
633
634.B slaac
635tells dnsmasq to offer Router Advertisement on this subnet and to set
636the A bit in the router advertisement, so that the client will use
637SLAAC addresses. When used with a DHCP range or static DHCP address
638this results in the client having both a DHCP-assigned and a SLAAC
639address.
640
641.B ra-stateless
642sends router advertisements with the O and A bits set, and provides a
643stateless DHCP service. The client will use a SLAAC address, and use
644DHCP for other configuration information.
645
7023e382 646.B ra-names
e8ca69ea 647enables a mode
7023e382 648which gives DNS names to dual-stack hosts which do SLAAC for
884a6dfe 649IPv6. Dnsmasq uses the host's IPv4 lease to derive the name, network
7023e382 650segment and MAC address and assumes that the host will also have an
e46164e0 651IPv6 address calculated using the SLAAC algorithm, on the same network
884a6dfe
SK
652segment. The address is pinged, and if a reply is received, an AAAA
653record is added to the DNS for this IPv6
7023e382 654address. Note that this is only happens for directly-connected
884a6dfe
SK
655networks, (not one doing DHCP via a relay) and it will not work
656if a host is using privacy extensions.
e8ca69ea
SK
657.B ra-names
658can be combined with
659.B ra-stateless
660and
661.B slaac.
c5ad4e79 662
9e4abcb5 663.TP
8ef5ada2 664.B \-G, --dhcp-host=[<hwaddr>][,id:<client_id>|*][,set:<tag>][,<ipaddr>][,<hostname>][,<lease_time>][,ignore]
9e4abcb5
SK
665Specify per host parameters for the DHCP server. This allows a machine
666with a particular hardware address to be always allocated the same
667hostname, IP address and lease time. A hostname specified like this
668overrides any supplied by the DHCP client on the machine. It is also
c72daea8 669allowable to omit the hardware address and include the hostname, in
9e4abcb5
SK
670which case the IP address and lease times will apply to any machine
671claiming that name. For example
672.B --dhcp-host=00:20:e0:3b:13:af,wap,infinite
673tells dnsmasq to give
cdeda28f 674the machine with hardware address 00:20:e0:3b:13:af the name wap, and
9e4abcb5
SK
675an infinite DHCP lease.
676.B --dhcp-host=lap,192.168.0.199
677tells
678dnsmasq to always allocate the machine lap the IP address
8ef5ada2
SK
679192.168.0.199.
680
681Addresses allocated like this are not constrained to be
682in the range given by the --dhcp-range option, but they must be in
683the same subnet as some valid dhcp-range. For
684subnets which don't need a pool of dynamically allocated addresses,
685use the "static" keyword in the dhcp-range declaration.
686
687It is allowed to use client identifiers rather than
9e4abcb5
SK
688hardware addresses to identify hosts by prefixing with 'id:'. Thus:
689.B --dhcp-host=id:01:02:03:04,.....
690refers to the host with client identifier 01:02:03:04. It is also
691allowed to specify the client ID as text, like this:
a84fa1d0 692.B --dhcp-host=id:clientidastext,.....
9009d746 693
1adadf58
SK
694A single
695.B dhcp-host
696may contain an IPv4 address or an IPv6 address, or both. IPv6 addresses must be bracketed by square brackets thus:
697.B --dhcp-host=laptop,[1234::56]
a156cae9 698Note that in IPv6 DHCP, the hardware address is not normally available, so a client must be identified by client-id (called client DUID in IPv6-land) or hostname.
1adadf58 699
a84fa1d0
SK
700The special option id:* means "ignore any client-id
701and use MAC addresses only." This is useful when a client presents a client-id sometimes
702but not others.
9009d746 703
1ab84e2f
SK
704If a name appears in /etc/hosts, the associated address can be
705allocated to a DHCP lease, but only if a
706.B --dhcp-host
8ef5ada2
SK
707option specifying the name also exists. Only one hostname can be
708given in a
709.B dhcp-host
710option, but aliases are possible by using CNAMEs. (See
711.B --cname
712).
713
714The special keyword "ignore"
33820b7e
SK
715tells dnsmasq to never offer a DHCP lease to a machine. The machine
716can be specified by hardware address, client ID or hostname, for
717instance
718.B --dhcp-host=00:20:e0:3b:13:af,ignore
719This is
720useful when there is another DHCP server on the network which should
9009d746
SK
721be used by some machines.
722
8ef5ada2 723The set:<tag> contruct sets the tag
9009d746 724whenever this dhcp-host directive is in use. This can be used to
8ef5ada2
SK
725selectively send DHCP options just for this host. More than one tag
726can be set in a dhcp-host directive (but not in other places where
727"set:<tag>" is allowed). When a host matches any
5aabfc78 728dhcp-host directive (or one implied by /etc/ethers) then the special
8ef5ada2 729tag "known" is set. This allows dnsmasq to be configured to
5aabfc78 730ignore requests from unknown machines using
8ef5ada2 731.B --dhcp-ignore=tag:!known
0a852541
SK
732Ethernet addresses (but not client-ids) may have
733wildcard bytes, so for example
734.B --dhcp-host=00:20:e0:3b:13:*,ignore
cdeda28f 735will cause dnsmasq to ignore a range of hardware addresses. Note that
0a852541 736the "*" will need to be escaped or quoted on a command line, but not
9009d746
SK
737in the configuration file.
738
739Hardware addresses normally match any
cdeda28f
SK
740network (ARP) type, but it is possible to restrict them to a single
741ARP type by preceding them with the ARP-type (in HEX) and "-". so
742.B --dhcp-host=06-00:20:e0:3b:13:af,1.2.3.4
743will only match a
744Token-Ring hardware address, since the ARP-address type for token ring
9009d746
SK
745is 6.
746
1adadf58 747As a special case, in DHCPv4, it is possible to include more than one
73a08a24
SK
748hardware address. eg:
749.B --dhcp-host=11:22:33:44:55:66,12:34:56:78:90:12,192.168.0.2
750This allows an IP address to be associated with
9009d746
SK
751multiple hardware addresses, and gives dnsmasq permission to abandon a
752DHCP lease to one of the hardware addresses when another one asks for
753a lease. Beware that this is a dangerous thing to do, it will only
754work reliably if only one of the hardware addresses is active at any
73a08a24
SK
755time and there is no way for dnsmasq to enforce this. It is, for instance,
756useful to allocate a stable IP address to a laptop which
9009d746 757has both wired and wireless interfaces.
5aabfc78 758.TP
28866e95
SK
759.B --dhcp-hostsfile=<path>
760Read DHCP host information from the specified file. If a directory
761is given, then read all the files contained in that directory. The file contains
5aabfc78
SK
762information about one host per line. The format of a line is the same
763as text to the right of '=' in --dhcp-host. The advantage of storing DHCP host information
764in this file is that it can be changed without re-starting dnsmasq:
765the file will be re-read when dnsmasq receives SIGHUP.
824af85b 766.TP
28866e95
SK
767.B --dhcp-optsfile=<path>
768Read DHCP option information from the specified file. If a directory
769is given, then read all the files contained in that directory. The advantage of
824af85b 770using this option is the same as for --dhcp-hostsfile: the
1f15b81d
SK
771dhcp-optsfile will be re-read when dnsmasq receives SIGHUP. Note that
772it is possible to encode the information in a
773.B --dhcp-boot
774flag as DHCP options, using the options names bootfile-name,
775server-ip-address and tftp-server. This allows these to be included
776in a dhcp-optsfile.
44a2a316
SK
777.TP
778.B \-Z, --read-ethers
779Read /etc/ethers for information about hosts for the DHCP server. The
780format of /etc/ethers is a hardware address, followed by either a
781hostname or dotted-quad IP address. When read by dnsmasq these lines
782have exactly the same effect as
783.B --dhcp-host
5aabfc78 784options containing the same information. /etc/ethers is re-read when
1adadf58 785dnsmasq receives SIGHUP. IPv6 addresses are NOT read from /etc/ethers.
9e4abcb5 786.TP
1adadf58 787.B \-O, --dhcp-option=[tag:<tag>,[tag:<tag>,]][encap:<opt>,][vi-encap:<enterprise>,][vendor:[<vendor-class>],][<opt>|option:<opt-name>|option6:<opt>|option6:<opt-name>],[<value>[,<value>]]
b8187c80 788Specify different or extra options to DHCP clients. By default,
9e4abcb5
SK
789dnsmasq sends some standard options to DHCP clients, the netmask and
790broadcast address are set to the same as the host running dnsmasq, and
791the DNS server and default route are set to the address of the machine
1adadf58 792running dnsmasq. (Equivalent rules apply for IPv6.) If the domain name option has been set, that is sent.
f2621c7f
SK
793This configuration allows these defaults to be overridden,
794or other options specified. The option, to be sent may be given as a
795decimal number or as "option:<option-name>" The option numbers are
796specified in RFC2132 and subsequent RFCs. The set of option-names
797known by dnsmasq can be discovered by running "dnsmasq --help dhcp".
798For example, to set the default route option to
9e4abcb5 799192.168.4.4, do
f2621c7f
SK
800.B --dhcp-option=3,192.168.4.4
801or
802.B --dhcp-option = option:router, 192.168.4.4
9e4abcb5 803and to set the time-server address to 192.168.0.4, do
f2621c7f
SK
804.B --dhcp-option = 42,192.168.0.4
805or
806.B --dhcp-option = option:ntp-server, 192.168.0.4
0010b474 807The special address 0.0.0.0 (or [::] for DHCPv6) is taken to mean "the address of the
f6b7dc47
SK
808machine running dnsmasq". Data types allowed are comma separated
809dotted-quad IP addresses, a decimal number, colon-separated hex digits
8ef5ada2
SK
810and a text string. If the optional tags are given then
811this option is only sent when all the tags are matched.
91dccd09 812
cdeda28f 813Special processing is done on a text argument for option 119, to
832af0ba
SK
814conform with RFC 3397. Text or dotted-quad IP addresses as arguments
815to option 120 are handled as per RFC 3361. Dotted-quad IP addresses
816which are followed by a slash and then a netmask size are encoded as
817described in RFC 3442.
cdeda28f 818
1adadf58
SK
819IPv6 options are specified using the
820.B option6:
821keyword, followed by the option number or option name. The IPv6 option
822name space is disjoint from the IPv4 option name space. IPv6 addresses
823in options must be bracketed with square brackets, eg.
824.B --dhcp-option=option6:ntp-server,[1234::56]
825
826
9e4abcb5 827Be careful: no checking is done that the correct type of data for the
26128d27 828option number is sent, it is quite possible to
9e4abcb5 829persuade dnsmasq to generate illegal DHCP packets with injudicious use
91dccd09
SK
830of this flag. When the value is a decimal number, dnsmasq must determine how
831large the data item is. It does this by examining the option number and/or the
b8187c80 832value, but can be overridden by appending a single letter flag as follows:
91dccd09 833b = one byte, s = two bytes, i = four bytes. This is mainly useful with
3d8df260
SK
834encapsulated vendor class options (see below) where dnsmasq cannot
835determine data size from the option number. Option data which
836consists solely of periods and digits will be interpreted by dnsmasq
837as an IP address, and inserted into an option as such. To force a
838literal string, use quotes. For instance when using option 66 to send
839a literal IP address as TFTP server name, it is necessary to do
840.B --dhcp-option=66,"1.2.3.4"
91dccd09 841
1adadf58 842Encapsulated Vendor-class options may also be specified (IPv4 only) using
91dccd09 843--dhcp-option: for instance
1b7ecd11
SK
844.B --dhcp-option=vendor:PXEClient,1,0.0.0.0
845sends the encapsulated vendor
846class-specific option "mftp-address=0.0.0.0" to any client whose
847vendor-class matches "PXEClient". The vendor-class matching is
6b01084f
SK
848substring based (see --dhcp-vendorclass for details). If a
849vendor-class option (number 60) is sent by dnsmasq, then that is used
850for selecting encapsulated options in preference to any sent by the
851client. It is
1b7ecd11
SK
852possible to omit the vendorclass completely;
853.B --dhcp-option=vendor:,1,0.0.0.0
1adadf58 854in which case the encapsulated option is always sent.
73a08a24 855
1adadf58 856Options may be encapsulated (IPv4 only) within other options: for instance
73a08a24
SK
857.B --dhcp-option=encap:175, 190, "iscsi-client0"
858will send option 175, within which is the option 190. If multiple
859options are given which are encapsulated with the same option number
860then they will be correctly combined into one encapsulated option.
861encap: and vendor: are may not both be set in the same dhcp-option.
862
316e2730
SK
863The final variant on encapsulated options is "Vendor-Identifying
864Vendor Options" as specified by RFC3925. These are denoted like this:
865.B --dhcp-option=vi-encap:2, 10, "text"
866The number in the vi-encap: section is the IANA enterprise number
1adadf58
SK
867used to identify this option. This form of encapsulation is supported
868in IPv6.
869
1b7ecd11 870The address 0.0.0.0 is not treated specially in
73a08a24 871encapsulated options.
9e4abcb5 872.TP
8ef5ada2 873.B --dhcp-option-force=[tag:<tag>,[tag:<tag>,]][encap:<opt>,][vi-encap:<enterprise>,][vendor:[<vendor-class>],]<opt>,[<value>[,<value>]]
6b01084f 874This works in exactly the same way as
f2621c7f
SK
875.B --dhcp-option
876except that the option will always be sent, even if the client does
6b01084f
SK
877not ask for it in the parameter request list. This is sometimes
878needed, for example when sending options to PXELinux.
879.TP
824af85b 880.B --dhcp-no-override
1adadf58 881(IPv4 only) Disable re-use of the DHCP servername and filename fields as extra
824af85b
SK
882option space. If it can, dnsmasq moves the boot server and filename
883information (from dhcp-boot) out of their dedicated fields into
884DHCP options. This make extra space available in the DHCP packet for
885options but can, rarely, confuse old or broken clients. This flag
886forces "simple and safe" behaviour to avoid problems in such a case.
887.TP
1adadf58 888.B \-U, --dhcp-vendorclass=set:<tag>,[enterprise:<IANA-enterprise number>,]<vendor-class>
8ef5ada2 889Map from a vendor-class string to a tag. Most DHCP clients provide a
a222641c 890"vendor class" which represents, in some sense, the type of host. This option
f2621c7f 891maps vendor classes to tags, so that DHCP options may be selectively delivered
a84fa1d0 892to different classes of hosts. For example
8ef5ada2 893.B dhcp-vendorclass=set:printers,Hewlett-Packard JetDirect
a84fa1d0 894will allow options to be set only for HP printers like so:
8ef5ada2 895.B --dhcp-option=tag:printers,3,192.168.4.4
a222641c
SK
896The vendor-class string is
897substring matched against the vendor-class supplied by the client, to
1adadf58
SK
898allow fuzzy matching. The set: prefix is optional but allowed for
899consistency.
900
901Note that in IPv6 only, vendorclasses are namespaced with an
902IANA-allocated enterprise number. This is given with enterprise:
903keyword and specifies that only vendorclasses matching the specified
904number should be searched.
a222641c 905.TP
8ef5ada2
SK
906.B \-j, --dhcp-userclass=set:<tag>,<user-class>
907Map from a user-class string to a tag (with substring
a222641c
SK
908matching, like vendor classes). Most DHCP clients provide a
909"user class" which is configurable. This option
f2621c7f 910maps user classes to tags, so that DHCP options may be selectively delivered
a222641c
SK
911to different classes of hosts. It is possible, for instance to use
912this to set a different printer server for hosts in the class
913"accounts" than for hosts in the class "engineering".
a84fa1d0 914.TP
8ef5ada2 915.B \-4, --dhcp-mac=set:<tag>,<MAC address>
1adadf58 916(IPv4 only) Map from a MAC address to a tag. The MAC address may include
cdeda28f 917wildcards. For example
8ef5ada2 918.B --dhcp-mac=set:3com,01:34:23:*:*:*
cdeda28f
SK
919will set the tag "3com" for any host whose MAC address matches the pattern.
920.TP
8ef5ada2
SK
921.B --dhcp-circuitid=set:<tag>,<circuit-id>, --dhcp-remoteid=set:<tag>,<remote-id>
922Map from RFC3046 relay agent options to tags. This data may
f2621c7f
SK
923be provided by DHCP relay agents. The circuit-id or remote-id is
924normally given as colon-separated hex, but is also allowed to be a
925simple string. If an exact match is achieved between the circuit or
1adadf58
SK
926agent ID and one provided by a relay agent, the tag is set.
927
928.B dhcp-remoteid
929(but not dhcp-circuitid) is supported in IPv6.
8ef5ada2
SK
930.TP
931.B --dhcp-subscrid=set:<tag>,<subscriber-id>
1adadf58 932(IPv4 and IPv6) Map from RFC3993 subscriber-id relay agent options to tags.
8ef5ada2
SK
933.TP
934.B --dhcp-proxy[=<ip addr>]......
0793380b 935(IPv4 only) A normal DHCP relay agent is only used to forward the initial parts of
8ef5ada2
SK
936a DHCP interaction to the DHCP server. Once a client is configured, it
937communicates directly with the server. This is undesirable if the
938relay agent is addding extra information to the DHCP packets, such as
939that used by
940.B dhcp-circuitid
941and
942.B dhcp-remoteid.
943A full relay implementation can use the RFC 5107 serverid-override
944option to force the DHCP server to use the relay as a full proxy, with all
945packets passing through it. This flag provides an alternative method
946of doing the same thing, for relays which don't support RFC
9475107. Given alone, it manipulates the server-id for all interactions
948via relays. If a list of IP addresses is given, only interactions via
949relays at those addresses are affected.
950.TP
951.B --dhcp-match=set:<tag>,<option number>|option:<option name>|vi-encap:<enterprise>[,<value>]
952Without a value, set the tag if the client sends a DHCP
73a08a24
SK
953option of the given number or name. When a value is given, set the tag only if
954the option is sent and matches the value. The value may be of the form
955"01:ff:*:02" in which case the value must match (apart from widcards)
956but the option sent may have unmatched data past the end of the
957value. The value may also be of the same form as in
958.B dhcp-option
959in which case the option sent is treated as an array, and one element
960must match, so
961
8ef5ada2 962--dhcp-match=set:efi-ia32,option:client-arch,6
73a08a24
SK
963
964will set the tag "efi-ia32" if the the number 6 appears in the list of
965architectures sent by the client in option 93. (See RFC 4578 for
316e2730
SK
966details.) If the value is a string, substring matching is used.
967
968The special form with vi-encap:<enterpise number> matches against
969vendor-identifying vendor classes for the specified enterprise. Please
8ef5ada2
SK
970see RFC 3925 for more details of these rare and interesting beasts.
971.TP
972.B --tag-if=set:<tag>[,set:<tag>[,tag:<tag>[,tag:<tag>]]]
973Perform boolean operations on tags. Any tag appearing as set:<tag> is set if
974all the tags which appear as tag:<tag> are set, (or unset when tag:!<tag> is used)
975If no tag:<tag> appears set:<tag> tags are set unconditionally.
976Any number of set: and tag: forms may appear, in any order.
977Tag-if lines ares executed in order, so if the tag in tag:<tag> is a
978tag set by another
979.B tag-if,
980the line which sets the tag must precede the one which tests it.
981.TP
982.B \-J, --dhcp-ignore=tag:<tag>[,tag:<tag>]
983When all the given tags appear in the tag set ignore the host and do
26128d27
SK
984not allocate it a DHCP lease.
985.TP
8ef5ada2
SK
986.B --dhcp-ignore-names[=tag:<tag>[,tag:<tag>]]
987When all the given tags appear in the tag set, ignore any hostname
9e038946 988provided by the host. Note that, unlike dhcp-ignore, it is permissible
8ef5ada2 989to supply no tags, in which case DHCP-client supplied hostnames
832af0ba
SK
990are always ignored, and DHCP hosts are added to the DNS using only
991dhcp-host configuration in dnsmasq and the contents of /etc/hosts and
992/etc/ethers.
993.TP
8ef5ada2 994.B --dhcp-generate-names=tag:<tag>[,tag:<tag>]
1adadf58 995(IPv4 only) Generate a name for DHCP clients which do not otherwise have one,
8ef5ada2
SK
996using the MAC address expressed in hex, seperated by dashes. Note that
997if a host provides a name, it will be used by preference to this,
998unless
999.B --dhcp-ignore-names
1000is set.
1001.TP
1002.B --dhcp-broadcast[=tag:<tag>[,tag:<tag>]]
1adadf58 1003(IPv4 only) When all the given tags appear in the tag set, always use broadcast to
8ef5ada2
SK
1004communicate with the host when it is unconfigured. It is permissible
1005to supply no tags, in which case this is unconditional. Most DHCP clients which
824af85b
SK
1006need broadcast replies set a flag in their requests so that this
1007happens automatically, some old BOOTP clients do not.
1008.TP
7de060b0 1009.B \-M, --dhcp-boot=[tag:<tag>,]<filename>,[<servername>[,<server address>|<tftp_servername>]]
1adadf58 1010(IPv4 only) Set BOOTP options to be returned by the DHCP server. Server name and
832af0ba
SK
1011address are optional: if not provided, the name is left empty, and the
1012address set to the address of the machine running dnsmasq. If dnsmasq
1013is providing a TFTP service (see
1014.B --enable-tftp
1015) then only the filename is required here to enable network booting.
8ef5ada2
SK
1016If the optional tag(s) are given,
1017they must match for this configuration to be sent.
7de060b0
SK
1018Instead of an IP address, the TFTP server address can be given as a domain
1019name which is looked up in /etc/hosts. This name can be associated in
1020/etc/hosts with multiple IP addresses, which are used round-robin.
1021This facility can be used to load balance the tftp load among a set of servers.
1022.TP
1023.B --dhcp-sequential-ip
1024Dnsmasq is designed to choose IP addresses for DHCP clients using a
1025hash of the client's MAC address. This normally allows a client's
1026address to remain stable long-term, even if the client sometimes allows its DHCP
1027lease to expire. In this default mode IP addresses are distributed
1028pseudo-randomly over the entire available address range. There are
1029sometimes circumstances (typically server deployment) where it is more
1030convenient to have IP
1031addresses allocated sequentially, starting from the lowest available
1032address, and setting this flag enables this mode. Note that in the
1033sequential mode, clients which allow a lease to expire are much more
1034likely to move IP address; for this reason it should not be generally used.
7622fc06 1035.TP
751d6f4a 1036.B --pxe-service=[tag:<tag>,]<CSA>,<menu text>[,<basename>|<bootservicetype>][,<server address>|<server_name>]
7622fc06
SK
1037Most uses of PXE boot-ROMS simply allow the PXE
1038system to obtain an IP address and then download the file specified by
1039.B dhcp-boot
1040and execute it. However the PXE system is capable of more complex
1041functions when supported by a suitable DHCP server.
1042
1043This specifies a boot option which may appear in a PXE boot menu. <CSA> is
1044client system type, only services of the correct type will appear in a
1045menu. The known types are x86PC, PC98, IA64_EFI, Alpha, Arc_x86,
1046Intel_Lean_Client, IA32_EFI, BC_EFI, Xscale_EFI and X86-64_EFI; an
1047integer may be used for other types. The
1048parameter after the menu text may be a file name, in which case dnsmasq acts as a
1049boot server and directs the PXE client to download the file by TFTP,
1050either from itself (
1051.B enable-tftp
751d6f4a
SK
1052must be set for this to work) or another TFTP server if the final server
1053address/name is given.
7622fc06
SK
1054Note that the "layer"
1055suffix (normally ".0") is supplied by PXE, and should not be added to
1056the basename. If an integer boot service type, rather than a basename
1057is given, then the PXE client will search for a
1058suitable boot service for that type on the network. This search may be done
751d6f4a 1059by broadcast, or direct to a server if its IP address/name is provided.
316e2730
SK
1060If no boot service type or filename is provided (or a boot service type of 0 is specified)
1061then the menu entry will abort the net boot procedure and
751d6f4a
SK
1062continue booting from local media. The server address can be given as a domain
1063name which is looked up in /etc/hosts. This name can be associated in
1064/etc/hosts with multiple IP addresses, which are used round-robin.
7622fc06 1065.TP
8ef5ada2 1066.B --pxe-prompt=[tag:<tag>,]<prompt>[,<timeout>]
7622fc06
SK
1067Setting this provides a prompt to be displayed after PXE boot. If the
1068timeout is given then after the
1069timeout has elapsed with no keyboard input, the first available menu
1070option will be automatically executed. If the timeout is zero then the first available menu
1071item will be executed immediately. If
1072.B pxe-prompt
1073is ommitted the system will wait for user input if there are multiple
1074items in the menu, but boot immediately if
1075there is only one. See
1076.B pxe-service
1077for details of menu items.
1078
1079Dnsmasq supports PXE "proxy-DHCP", in this case another DHCP server on
1080the network is responsible for allocating IP addresses, and dnsmasq
1081simply provides the information given in
1082.B pxe-prompt
1083and
1084.B pxe-service
1085to allow netbooting. This mode is enabled using the
1086.B proxy
1087keyword in
1088.B dhcp-range.
9e4abcb5 1089.TP
44a2a316
SK
1090.B \-X, --dhcp-lease-max=<number>
1091Limits dnsmasq to the specified maximum number of DHCP leases. The
8ef5ada2 1092default is 1000. This limit is to prevent DoS attacks from hosts which
44a2a316
SK
1093create thousands of leases and use lots of memory in the dnsmasq
1094process.
1095.TP
fd9fa481 1096.B \-K, --dhcp-authoritative
1adadf58 1097(IPv4 only) Should be set when dnsmasq is definitely the only DHCP server on a network.
fd9fa481
SK
1098It changes the behaviour from strict RFC compliance so that DHCP requests on
1099unknown leases from unknown hosts are not ignored. This allows new hosts
cdeda28f
SK
1100to get a lease without a tedious timeout under all circumstances. It also
1101allows dnsmasq to rebuild its lease database without each client needing to
9e038946
SK
1102reacquire a lease, if the database is lost.
1103.TP
1104.B --dhcp-alternate-port[=<server port>[,<client port>]]
1adadf58 1105(IPv4 only) Change the ports used for DHCP from the default. If this option is
9e038946
SK
1106given alone, without arguments, it changes the ports used for DHCP
1107from 67 and 68 to 1067 and 1068. If a single argument is given, that
1108port number is used for the server and the port number plus one used
1109for the client. Finally, two port numbers allows arbitrary
1110specification of both server and client ports for DHCP.
fd9fa481 1111.TP
9009d746 1112.B \-3, --bootp-dynamic[=<network-id>[,<network-id>]]
1adadf58 1113(IPv4 only) Enable dynamic allocation of IP addresses to BOOTP clients. Use this
3d8df260
SK
1114with care, since each address allocated to a BOOTP client is leased
1115forever, and therefore becomes permanently unavailable for re-use by
9009d746
SK
1116other hosts. if this is given without tags, then it unconditionally
1117enables dynamic allocation. With tags, only when the tags are all
1118set. It may be repeated with different tag sets.
3d8df260 1119.TP
5e9e0efb 1120.B \-5, --no-ping
1adadf58 1121(IPv4 only) By default, the DHCP server will attempt to ensure that an address in
5e9e0efb
SK
1122not in use before allocating it to a host. It does this by sending an
1123ICMP echo request (aka "ping") to the address in question. If it gets
1124a reply, then the address must already be in use, and another is
1125tried. This flag disables this check. Use with caution.
1126.TP
f2621c7f
SK
1127.B --log-dhcp
1128Extra logging for DHCP: log all the options sent to DHCP clients and
8ef5ada2 1129the tags used to determine them.
f2621c7f 1130.TP
9e4abcb5 1131.B \-l, --dhcp-leasefile=<path>
73a08a24 1132Use the specified file to store DHCP lease information.
208b65c5 1133.TP
8b372704
SK
1134.B --dhcp-duid=<enterprise-id>,<uid>
1135(IPv6 only) Specify the server persistent UID which the DHCPv6 server
1136will use. This option is not normally required as dnsmasq creates a
1137DUID automatically when it is first needed. When given, this option
1138provides dnsmasq the data required to create a DUID-EN type DUID. Note
1139that once set, the DUID is stored in the lease database, so to change between DUID-EN and
1140automatically created DUIDs or vice-versa, the lease database must be
1141re-intialised. The enterprise-id is assigned by IANA, and the uid is a
1142string of hex octets unique to a particular device.
1143.TP
7cebd20f 1144.B \-6 --dhcp-script=<path>
a9530964
SK
1145Whenever a new DHCP lease is created, or an old one destroyed, or a
1146TFTP file transfer completes, the
8ef5ada2
SK
1147executable specified by this option is run. <path>
1148must be an absolute pathname, no PATH search occurs.
1149The arguments to the process
7cebd20f 1150are "add", "old" or "del", the MAC
1adadf58 1151address of the host (or DUID for IPv6) , the IP address, and the hostname,
7cebd20f
SK
1152if known. "add" means a lease has been created, "del" means it has
1153been destroyed, "old" is a notification of an existing lease when
208b65c5
SK
1154dnsmasq starts or a change to MAC address or hostname of an existing
1155lease (also, lease length or expiry and client-id, if leasefile-ro is set).
9009d746
SK
1156If the MAC address is from a network type other than ethernet,
1157it will have the network type prepended, eg "06-01:23:45:67:89:ab" for
1158token ring. The process is run as root (assuming that dnsmasq was originally run as
1697269c 1159root) even if dnsmasq is configured to change UID to an unprivileged user.
8ef5ada2
SK
1160
1161The environment is inherited from the invoker of dnsmasq, with some or
1adadf58 1162all of the following variables added
8ef5ada2 1163
1adadf58 1164For both IPv4 and IPv6:
8ef5ada2
SK
1165
1166DNSMASQ_DOMAIN if the fully-qualified domain name of the host is
28866e95
SK
1167known, this is set to the domain part. (Note that the hostname passed
1168to the script as an argument is never fully-qualified.)
8ef5ada2 1169
1adadf58
SK
1170If the client provides a hostname, DNSMASQ_SUPPLIED_HOSTNAME
1171
1172If the client provides user-classes, DNSMASQ_USER_CLASS0..DNSMASQ_USER_CLASSn
8ef5ada2
SK
1173
1174If dnsmasq was compiled with HAVE_BROKEN_RTC, then
208b65c5 1175the length of the lease (in seconds) is stored in
1697269c 1176DNSMASQ_LEASE_LENGTH, otherwise the time of lease expiry is stored in
5aabfc78
SK
1177DNSMASQ_LEASE_EXPIRES. The number of seconds until lease expiry is
1178always stored in DNSMASQ_TIME_REMAINING.
8ef5ada2 1179
5aabfc78 1180If a lease used to have a hostname, which is
1697269c
SK
1181removed, an "old" event is generated with the new state of the lease,
1182ie no name, and the former name is provided in the environment
8ef5ada2
SK
1183variable DNSMASQ_OLD_HOSTNAME.
1184
1185DNSMASQ_INTERFACE stores the name of
9e038946 1186the interface on which the request arrived; this is not set for "old"
8ef5ada2
SK
1187actions when dnsmasq restarts.
1188
1189DNSMASQ_RELAY_ADDRESS is set if the client
316e2730 1190used a DHCP relay to contact dnsmasq and the IP address of the relay
8ef5ada2
SK
1191is known.
1192
1193DNSMASQ_TAGS contains all the tags set during the
316e2730 1194DHCP transaction, separated by spaces.
8ef5ada2 1195
e46164e0
SK
1196DNSMASQ_LOG_DHCP is set if
1197.B --log-dhcp
1198is in effect.
a9530964 1199
1adadf58
SK
1200For IPv4 only:
1201
1202DNSMASQ_CLIENT_ID if the host provided a client-id.
1203
1204If the client provides vendor-class, DNSMASQ_VENDOR_CLASS.
1205
1206For IPv6 only:
1207
1208If the client provides vendor-class, DNSMASQ_VENDOR_CLASS_ID,
1209containing the IANA enterprise id for the class, and
1210DNSMASQ_VENDOR_CLASS0..DNSMASQ_VENDOR_CLASSn for the data.
1211
57f460de 1212DNSMASQ_SERVER_DUID containing the DUID of the server: this is the same for
1adadf58
SK
1213every call to the script.
1214
1215DNSMASQ_IAID containing the IAID for the lease. If the lease is a
1216temporary allocation, this is prefixed to 'T'.
1217
1218
1219
1220Note that the supplied hostname, vendorclass and userclass data is
1221only supplied for
1222"add" actions or "old" actions when a host resumes an existing lease,
1223since these data are not held in dnsmasq's lease
1224database.
1225
a9530964
SK
1226
1227
9e038946 1228All file descriptors are
7cebd20f
SK
1229closed except stdin, stdout and stderr which are open to /dev/null
1230(except in debug mode).
8ef5ada2
SK
1231
1232The script is not invoked concurrently: at most one instance
1233of the script is ever running (dnsmasq waits for an instance of script to exit
1234before running the next). Changes to the lease database are which
1235require the script to be invoked are queued awaiting exit of a running instance.
1236If this queueing allows multiple state changes occur to a single
1237lease before the script can be run then
1238earlier states are discarded and the current state of that lease is
1239reflected when the script finally runs.
1240
1241At dnsmasq startup, the script will be invoked for
7cebd20f 1242all existing leases as they are read from the lease file. Expired
8ef5ada2 1243leases will be called with "del" and others with "old". When dnsmasq
5aabfc78 1244receives a HUP signal, the script will be invoked for existing leases
9e038946 1245with an "old " event.
a9530964
SK
1246
1247
1248There are two further actions which may appear as the first argument
1249to the script, "init" and "tftp". More may be added in the future, so
1250scripts should be written to ignore unknown actions. "init" is
e46164e0 1251described below in
a9530964
SK
1252.B --leasefile-ro
1253The "tftp" action is invoked when a TFTP file transfer completes: the
1254arguments are the file size in bytes, the address to which the file
1255was sent, and the complete pathname of the file.
1256
9e038946 1257.TP
57f460de
SK
1258.B --dhcp-luascript=<path>
1259Specify a script written in Lua, to be run when leases are created,
1260destroyed or changed. To use this option, dnsmasq must be compiled
1261with the correct support. The Lua interpreter is intialised once, when
1262dnsmasq starts, so that global variables persist between lease
1263events. The Lua code must define a
1264.B lease
1265function, and may provide
1266.B init
1267and
1268.B shutdown
1269functions, which are called, without arguments when dnsmasq starts up
a9530964
SK
1270and terminates. It may also provide a
1271.B tftp
1272function.
57f460de
SK
1273
1274The
1275.B lease
a9530964 1276function receives the information detailed in
57f460de
SK
1277.B --dhcp-script.
1278It gets two arguments, firstly the action, which is a string
1279containing, "add", "old" or "del", and secondly a table of tag value
1280pairs. The tags mostly correspond to the environment variables
1281detailed above, for instance the tag "domain" holds the same data as
1282the environment variable DNSMASQ_DOMAIN. There are a few extra tags
1283which hold the data supplied as arguments to
1284.B --dhcp-script.
1285These are
1286.B mac_address, ip_address
1287and
1288.B hostname
1289for IPv4, and
1290.B client_duid, ip_address
1291and
1292.B hostname
a9530964
SK
1293for IPv6.
1294
1295The
1296.B tftp
1297function is called in the same way as the lease function, and the
1298table holds the tags
1299.B destination_address,
1300.B file_name
1301and
1302.B file_size.
57f460de 1303.TP
9e038946 1304.B --dhcp-scriptuser
57f460de 1305Specify the user as which to run the lease-change script or Lua script. This defaults to root, but can be changed to another user using this flag.
208b65c5
SK
1306.TP
1307.B \-9, --leasefile-ro
1308Completely suppress use of the lease database file. The file will not
1309be created, read, or written. Change the way the lease-change
1310script (if one is provided) is called, so that the lease database may
1311be maintained in external storage by the script. In addition to the
f2621c7f 1312invocations given in
208b65c5
SK
1313.B --dhcp-script
1314the lease-change script is called once, at dnsmasq startup, with the
1315single argument "init". When called like this the script should write
1316the saved state of the lease database, in dnsmasq leasefile format, to
1317stdout and exit with zero exit code. Setting this
1318option also forces the leasechange script to be called on changes
1319to the client-id and lease length and expiry time.
9e4abcb5 1320.TP
832af0ba
SK
1321.B --bridge-interface=<interface>,<alias>[,<alias>]
1322Treat DHCP request packets arriving at any of the <alias> interfaces
7622fc06
SK
1323as if they had arrived at <interface>. This option is necessary when
1324using "old style" bridging on BSD platforms, since
832af0ba
SK
1325packets arrive at tap interfaces which don't have an IP address.
1326.TP
28866e95 1327.B \-s, --domain=<domain>[,<address range>[,local]]
9009d746
SK
1328Specifies DNS domains for the DHCP server. Domains may be be given
1329unconditionally (without the IP range) or for limited IP ranges. This has two effects;
9e4abcb5
SK
1330firstly it causes the DHCP server to return the domain to any hosts
1331which request it, and secondly it sets the domain which it is legal
1b7ecd11
SK
1332for DHCP-configured hosts to claim. The intention is to constrain
1333hostnames so that an untrusted host on the LAN cannot advertise
1334its name via dhcp as e.g. "microsoft.com" and capture traffic not
1335meant for it. If no domain suffix is specified, then any DHCP
1336hostname with a domain part (ie with a period) will be disallowed
1337and logged. If suffix is specified, then hostnames with a domain
1338part are allowed, provided the domain part matches the suffix. In
1339addition, when a suffix is set then hostnames without a domain
1340part have the suffix added as an optional domain part. Eg on my network I can set
3d8df260 1341.B --domain=thekelleys.org.uk
9e4abcb5
SK
1342and have a machine whose DHCP hostname is "laptop". The IP address for that machine is available from
1343.B dnsmasq
de37951c
SK
1344both as "laptop" and "laptop.thekelleys.org.uk". If the domain is
1345given as "#" then the domain is read from the first "search" directive
28866e95
SK
1346in /etc/resolv.conf (or equivalent).
1347
1348The address range can be of the form
9009d746
SK
1349<ip address>,<ip address> or <ip address>/<netmask> or just a single
1350<ip address>. See
1351.B --dhcp-fqdn
1352which can change the behaviour of dnsmasq with domains.
28866e95
SK
1353
1354If the address range is given as ip-address/network-size, then a
1355additional flag "local" may be supplied which has the effect of adding
1356--local declarations for forward and reverse DNS queries. Eg.
1357.B --domain=thekelleys.org.uk,192.168.0.0/24,local
1358is identical to
1359.B --domain=thekelleys.org.uk,192.168.0.0/24
1360--local=/thekelleys.org.uk/ --local=/0.168.192.in-addr.arpa/
1361The network size must be 8, 16 or 24 for this to be legal.
9009d746
SK
1362.TP
1363.B --dhcp-fqdn
1364In the default mode, dnsmasq inserts the unqualified names of
1365DHCP clients into the DNS. For this reason, the names must be unique,
1366even if two clients which have the same name are in different
1367domains. If a second DHCP client appears which has the same name as an
1368existing client, the name is transfered to the new client. If
1369.B --dhcp-fqdn
1370is set, this behaviour changes: the unqualified name is no longer
1371put in the DNS, only the qualified name. Two DHCP clients with the
1372same name may both keep the name, provided that the domain part is
1373different (ie the fully qualified names differ.) To ensure that all
1374names have a domain part, there must be at least
1375.B --domain
1376without an address specified when
1377.B --dhcp-fqdn
1378is set.
9e4abcb5 1379.TP
c72daea8
SK
1380.B --dhcp-client-update
1381Normally, when giving a DHCP lease, dnsmasq sets flags in the FQDN
1382option to tell the client not to attempt a DDNS update with its name
1383and IP address. This is because the name-IP pair is automatically
1384added into dnsmasq's DNS view. This flag suppresses that behaviour,
1385this is useful, for instance, to allow Windows clients to update
1386Active Directory servers. See RFC 4702 for details.
1387.TP
c5ad4e79
SK
1388.B --enable-ra
1389Enable dnsmasq's IPv6 Router Advertisement feature. DHCPv6 doesn't
1390handle complete network configuration in the same way as DHCPv4. Router
1391discovery and (possibly) prefix discovery for autonomous address
1392creation are handled by a different protocol. When DHCP is in use,
1393only a subset of this is needed, and dnsmasq can handle it, using
1394existing DHCP configuration to provide most data. When RA is enabled,
1395dnsmasq will advertise a prefix for each dhcp-range, with default
1396router and recursive DNS server as the relevant link-local address on
e8ca69ea
SK
1397the machine running dnsmasq. By default, he "managed address" bits are set, and
1398the "use SLAAC" bit is reset. This can be changed for individual
1399subnets with the mode keywords described in
1400.B --dhcp-range.
18f0fb05
SK
1401RFC6106 DNS parameters are included in the advertisements. By default,
1402the relevant link-local address of the machine running dnsmasq is sent
1403as recursive DNS server. If provided, the DHCPv6 options dns-server and
1404domain-search are used for RDNSS and DNSSL.
c5ad4e79 1405.TP
8bc4cece 1406.B --enable-tftp
832af0ba 1407Enable the TFTP server function. This is deliberately limited to that
9e038946 1408needed to net-boot a client. Only reading is allowed; the tsize and
8ef5ada2 1409blksize extensions are supported (tsize is only supported in octet
8bc4cece 1410mode).
832af0ba 1411.TP
8ef5ada2 1412.B --tftp-root=<directory>[,<interface>]
832af0ba
SK
1413Look for files to transfer using TFTP relative to the given
1414directory. When this is set, TFTP paths which include ".." are
1415rejected, to stop clients getting outside the specified root.
f2621c7f 1416Absolute paths (starting with /) are allowed, but they must be within
8ef5ada2
SK
1417the tftp-root. If the optional interface argument is given, the
1418directory is only used for TFTP requests via that interface.
832af0ba 1419.TP
5aabfc78
SK
1420.B --tftp-unique-root
1421Add the IP address of the TFTP client as a path component on the end
1422of the TFTP-root (in standard dotted-quad format). Only valid if a
1423tftp-root is set and the directory exists. For instance, if tftp-root is "/tftp" and client
14241.2.3.4 requests file "myfile" then the effective path will be
1425"/tftp/1.2.3.4/myfile" if /tftp/1.2.3.4 exists or /tftp/myfile otherwise.
1426.TP
832af0ba 1427.B --tftp-secure
5aabfc78 1428Enable TFTP secure mode: without this, any file which is readable by
832af0ba
SK
1429the dnsmasq process under normal unix access-control rules is
1430available via TFTP. When the --tftp-secure flag is given, only files
1431owned by the user running the dnsmasq process are accessible. If
1432dnsmasq is being run as root, different rules apply: --tftp-secure
1b7ecd11 1433has no effect, but only files which have the world-readable bit set
832af0ba
SK
1434are accessible. It is not recommended to run dnsmasq as root with TFTP
1435enabled, and certainly not without specifying --tftp-root. Doing so
1436can expose any world-readable file on the server to any host on the net.
1437.TP
61ce600b
SK
1438.B --tftp-lowercase
1439Convert filenames in TFTP requests to all lowercase. This is useful
1440for requests from Windows machines, which have case-insensitive
1441filesystems and tend to play fast-and-loose with case in filenames.
1442Note that dnsmasq's tftp server always converts "\\" to "/" in filenames.
1443.TP
832af0ba
SK
1444.B --tftp-max=<connections>
1445Set the maximum number of concurrent TFTP connections allowed. This
1446defaults to 50. When serving a large number of TFTP connections,
1447per-process file descriptor limits may be encountered. Dnsmasq needs
1448one file descriptor for each concurrent TFTP connection and one
1449file descriptor per unique file (plus a few others). So serving the
1450same file simultaneously to n clients will use require about n + 10 file
1451descriptors, serving different files simultaneously to n clients will
824af85b
SK
1452require about (2*n) + 10 descriptors. If
1453.B --tftp-port-range
1454is given, that can affect the number of concurrent connections.
6b01084f
SK
1455.TP
1456.B --tftp-no-blocksize
1457Stop the TFTP server from negotiating the "blocksize" option with a
1458client. Some buggy clients request this option but then behave badly
1459when it is granted.
824af85b
SK
1460.TP
1461.B --tftp-port-range=<start>,<end>
1462A TFTP server listens on a well-known port (69) for connection initiation,
1463but it also uses a dynamically-allocated port for each
1464connection. Normally these are allocated by the OS, but this option
1465specifies a range of ports for use by TFTP transfers. This can be
1466useful when TFTP has to traverse a firewall. The start of the range
1467cannot be lower than 1025 unless dnsmasq is running as root. The number
1468of concurrent TFTP connections is limited by the size of the port range.
832af0ba 1469.TP
b8187c80
SK
1470.B \-C, --conf-file=<file>
1471Specify a different configuration file. The conf-file option is also allowed in
28866e95
SK
1472configuration files, to include multiple configuration files. A
1473filename of "-" causes dnsmasq to read configuration from stdin.
849a8357 1474.TP
1f15b81d 1475.B \-7, --conf-dir=<directory>[,<file-extension>......]
849a8357 1476Read all the files in the given directory as configuration
1f15b81d
SK
1477files. If extension(s) are given, any files which end in those
1478extensions are skipped. Any files whose names end in ~ or start with . or start and end
1479with # are always skipped. This flag may be given on the command
849a8357 1480line or in a configuration file.
9e4abcb5 1481.SH CONFIG FILE
3be34541
SK
1482At startup, dnsmasq reads
1483.I /etc/dnsmasq.conf,
1484if it exists. (On
1485FreeBSD, the file is
1486.I /usr/local/etc/dnsmasq.conf
b8187c80
SK
1487) (but see the
1488.B \-C
849a8357
SK
1489and
1490.B \-7
1491options.) The format of this
9e4abcb5
SK
1492file consists of one option per line, exactly as the long options detailed
1493in the OPTIONS section but without the leading "--". Lines starting with # are comments and ignored. For
b49644f3 1494options which may only be specified once, the configuration file overrides
b8187c80 1495the command line. Quoting is allowed in a config file:
3d8df260 1496between " quotes the special meanings of ,:. and # are removed and the
824af85b
SK
1497following escapes are allowed: \\\\ \\" \\t \\e \\b \\r and \\n. The later
1498corresponding to tab, escape, backspace, return and newline.
9e4abcb5
SK
1499.SH NOTES
1500When it receives a SIGHUP,
1501.B dnsmasq
3be34541 1502clears its cache and then re-loads
5aabfc78
SK
1503.I /etc/hosts
1504and
1505.I /etc/ethers
824af85b 1506and any file given by --dhcp-hostsfile, --dhcp-optsfile or --addn-hosts.
5aabfc78
SK
1507The dhcp lease change script is called for all
1508existing DHCP leases. If
9e4abcb5
SK
1509.B
1510--no-poll
3be34541
SK
1511is set SIGHUP also re-reads
1512.I /etc/resolv.conf.
1513SIGHUP
b49644f3 1514does NOT re-read the configuration file.
9e4abcb5
SK
1515.PP
1516When it receives a SIGUSR1,
1517.B dnsmasq
824af85b 1518writes statistics to the system log. It writes the cache size,
9e4abcb5
SK
1519the number of names which have had to removed from the cache before
1520they expired in order to make room for new names and the total number
824af85b
SK
1521of names that have been inserted into the cache. For each upstream
1522server it gives the number of queries sent, and the number which
1523resulted in an error. In
9e4abcb5 1524.B --no-daemon
5aabfc78
SK
1525mode or when full logging is enabled (-q), a complete dump of the
1526contents of the cache is made.
1527.PP
1528When it receives SIGUSR2 and it is logging direct to a file (see
1529.B --log-facility
1530)
1531.B dnsmasq
1532will close and reopen the log file. Note that during this operation,
1533dnsmasq will not be running as root. When it first creates the logfile
1534dnsmasq changes the ownership of the file to the non-root user it will run
1535as. Logrotate should be configured to create a new log file with
9e038946 1536the ownership which matches the existing one before sending SIGUSR2.
5aabfc78
SK
1537If TCP DNS queries are in progress, the old logfile will remain open in
1538child processes which are handling TCP queries and may continue to be
1539written. There is a limit of 150 seconds, after which all existing TCP
1540processes will have expired: for this reason, it is not wise to
1541configure logfile compression for logfiles which have just been
1542rotated. Using logrotate, the required options are
1543.B create
1544and
1545.B delaycompress.
1546
1547
9e4abcb5 1548.PP
9e4abcb5
SK
1549Dnsmasq is a DNS query forwarder: it it not capable of recursively
1550answering arbitrary queries starting from the root servers but
1551forwards such queries to a fully recursive upstream DNS server which is
1552typically provided by an ISP. By default, dnsmasq reads
3be34541
SK
1553.I /etc/resolv.conf
1554to discover the IP
9e4abcb5
SK
1555addresses of the upstream nameservers it should use, since the
1556information is typically stored there. Unless
1557.B --no-poll
1558is used,
1559.B dnsmasq
3be34541
SK
1560checks the modification time of
1561.I /etc/resolv.conf
1562(or equivalent if
9e4abcb5
SK
1563.B \--resolv-file
1564is used) and re-reads it if it changes. This allows the DNS servers to
1565be set dynamically by PPP or DHCP since both protocols provide the
1566information.
3be34541
SK
1567Absence of
1568.I /etc/resolv.conf
1569is not an error
9e4abcb5 1570since it may not have been created before a PPP connection exists. Dnsmasq
3be34541
SK
1571simply keeps checking in case
1572.I /etc/resolv.conf
1573is created at any
9e4abcb5
SK
1574time. Dnsmasq can be told to parse more than one resolv.conf
1575file. This is useful on a laptop, where both PPP and DHCP may be used:
3be34541
SK
1576dnsmasq can be set to poll both
1577.I /etc/ppp/resolv.conf
1578and
1579.I /etc/dhcpc/resolv.conf
1580and will use the contents of whichever changed
9e4abcb5
SK
1581last, giving automatic switching between DNS servers.
1582.PP
1583Upstream servers may also be specified on the command line or in
b49644f3 1584the configuration file. These server specifications optionally take a
9e4abcb5
SK
1585domain name which tells dnsmasq to use that server only to find names
1586in that particular domain.
1587.PP
1588In order to configure dnsmasq to act as cache for the host on which it is running, put "nameserver 127.0.0.1" in
1589.I /etc/resolv.conf
1590to force local processes to send queries to
1591dnsmasq. Then either specify the upstream servers directly to dnsmasq
1592using
1593.B \--server
1594options or put their addresses real in another file, say
1595.I /etc/resolv.dnsmasq
1596and run dnsmasq with the
1597.B \-r /etc/resolv.dnsmasq
1598option. This second technique allows for dynamic update of the server
1599addresses by PPP or DHCP.
f6b7dc47
SK
1600.PP
1601Addresses in /etc/hosts will "shadow" different addresses for the same
1602names in the upstream DNS, so "mycompany.com 1.2.3.4" in /etc/hosts will ensure that
1603queries for "mycompany.com" always return 1.2.3.4 even if queries in
1604the upstream DNS would otherwise return a different address. There is
1605one exception to this: if the upstream DNS contains a CNAME which
1606points to a shadowed name, then looking up the CNAME through dnsmasq
1607will result in the unshadowed address associated with the target of
1608the CNAME. To work around this, add the CNAME to /etc/hosts so that
1609the CNAME is shadowed too.
1610
3be34541 1611.PP
8ef5ada2
SK
1612The tag system works as follows: For each DHCP request, dnsmasq
1613collects a set of valid tags from active configuration lines which
1614include set:<tag>, including one from the
26128d27
SK
1615.B dhcp-range
1616used to allocate the address, one from any matching
1617.B dhcp-host
9009d746 1618(and "known" if a dhcp-host matches)
8ef5ada2
SK
1619The tag "bootp" is set for BOOTP requests, and a tag whose name is the
1620name of the interface on which the request arrived is also set.
1621
1622Any configuration lines which includes one or more tag:<tag> contructs
1623will only be valid if all that tags are matched in the set derived
1624above. Typically this is dhcp-option.
26128d27 1625.B dhcp-option
8ef5ada2 1626which has tags will be used in preference to an untagged
26128d27
SK
1627.B dhcp-option,
1628provided that _all_ the tags match somewhere in the
8ef5ada2
SK
1629set collected as described above. The prefix '!' on a tag means 'not'
1630so --dhcp=option=tag:!purple,3,1.2.3.4 sends the option when the
1631tag purple is not in the set of valid tags. (If using this in a
1632command line rather than a configuration file, be sure to escape !,
1633which is a shell metacharacter)
7de060b0
SK
1634
1635When selecting dhcp-options, a tag from dhcp-range is second class
1636relative to other tags, to make it easy to override options for
1637individual hosts, so
1638.B dhcp-range=set:interface1,......
1639.B dhcp-host=set:myhost,.....
1640.B dhcp-option=tag:interface1,option:nis-domain,"domain1"
1641.B dhcp-option=tag:myhost,option:nis-domain,"domain2"
1642will set the NIS-domain to domain1 for hosts in the range, but
1643override that to domain2 for a particular host.
1644
26128d27 1645.PP
8ef5ada2 1646Note that for
f6b7dc47 1647.B dhcp-range
8ef5ada2
SK
1648both tag:<tag> and set:<tag> are allowed, to both select the range in
1649use based on (eg) dhcp-host, and to affect the options sent, based on
1650the range selected.
1651
1652This system evolved from an earlier, more limited one and for backward
1653compatibility "net:" may be used instead of "tag:" and "set:" may be
1654omitted. (Except in
1655.B dhcp-host,
1656where "net:" may be used instead of "set:".) For the same reason, '#'
1657may be used instead of '!' to indicate NOT.
f6b7dc47 1658.PP
3be34541
SK
1659The DHCP server in dnsmasq will function as a BOOTP server also,
1660provided that the MAC address and IP address for clients are given,
1661either using
1662.B dhcp-host
1663configurations or in
1664.I /etc/ethers
1665, and a
1666.B dhcp-range
1667configuration option is present to activate the DHCP server
b8187c80
SK
1668on a particular network. (Setting --bootp-dynamic removes the need for
1669static address mappings.) The filename
8ef5ada2
SK
1670parameter in a BOOTP request is used as a tag,
1671as is the tag "bootp", allowing some control over the options returned to
3be34541
SK
1672different classes of hosts.
1673
5aabfc78
SK
1674.SH EXIT CODES
1675.PP
16760 - Dnsmasq successfully forked into the background, or terminated
1677normally if backgrounding is not enabled.
1678.PP
16791 - A problem with configuration was detected.
1680.PP
16812 - A problem with network access occurred (address in use, attempt
1682to use privileged ports without permission).
1683.PP
9e038946 16843 - A problem occurred with a filesystem operation (missing
5aabfc78
SK
1685file/directory, permissions).
1686.PP
16874 - Memory allocation failure.
1688.PP
16895 - Other miscellaneous problem.
1690.PP
169111 or greater - a non zero return code was received from the
1692lease-script process "init" call. The exit code from dnsmasq is the
1693script's exit code with 10 added.
1694
1b7ecd11
SK
1695.SH LIMITS
1696The default values for resource limits in dnsmasq are generally
1697conservative, and appropriate for embedded router type devices with
1698slow processors and limited memory. On more capable hardware, it is
1699possible to increase the limits, and handle many more clients. The
1700following applies to dnsmasq-2.37: earlier versions did not scale as well.
1701
1702.PP
1703Dnsmasq is capable of handling DNS and DHCP for at least a thousand
8ef5ada2 1704clients. The DHCP lease times should not be very short (less than one hour). The
1b7ecd11
SK
1705value of
1706.B --dns-forward-max
1707can be increased: start with it equal to
1708the number of clients and increase if DNS seems slow. Note that DNS
1709performance depends too on the performance of the upstream
1710nameservers. The size of the DNS cache may be increased: the hard
1711limit is 10000 names and the default (150) is very low. Sending
1712SIGUSR1 to dnsmasq makes it log information which is useful for tuning
1713the cache size. See the
1714.B NOTES
1715section for details.
1716
1717.PP
1718The built-in TFTP server is capable of many simultaneous file
1719transfers: the absolute limit is related to the number of file-handles
1720allowed to a process and the ability of the select() system call to
1721cope with large numbers of file handles. If the limit is set too high
1722using
1723.B --tftp-max
1724it will be scaled down and the actual limit logged at
1725start-up. Note that more transfers are possible when the same file is
1726being sent than when each transfer sends a different file.
1727
1728.PP
1729It is possible to use dnsmasq to block Web advertising by using a list
1730of known banner-ad servers, all resolving to 127.0.0.1 or 0.0.0.0, in
1731.B /etc/hosts
1732or an additional hosts file. The list can be very long,
1733dnsmasq has been tested successfully with one million names. That size
1734file needs a 1GHz processor and about 60Mb of RAM.
1735
1f15b81d
SK
1736.SH INTERNATIONALISATION
1737Dnsmasq can be compiled to support internationalisation. To do this,
1738the make targets "all-i18n" and "install-i18n" should be used instead of
1739the standard targets "all" and "install". When internationalisation
1740is compiled in, dnsmasq will produce log messages in the local
1741language and support internationalised domain names (IDN). Domain
1742names in /etc/hosts, /etc/ethers and /etc/dnsmasq.conf which contain
1743non-ASCII characters will be translated to the DNS-internal punycode
1744representation. Note that
1745dnsmasq determines both the language for messages and the assumed
1746charset for configuration
1747files from the LANG environment variable. This should be set to the system
1748default value by the script which is responsible for starting
1749dnsmasq. When editing the configuration files, be careful to do so
1750using only the system-default locale and not user-specific one, since
1751dnsmasq has no direct way of determining the charset in use, and must
1752assume that it is the system default.
1753
9e4abcb5 1754.SH FILES
b49644f3
SK
1755.IR /etc/dnsmasq.conf
1756
1757.IR /usr/local/etc/dnsmasq.conf
9e4abcb5
SK
1758
1759.IR /etc/resolv.conf
28866e95
SK
1760.IR /var/run/dnsmasq/resolv.conf
1761.IR /etc/ppp/resolv.conf
1762.IR /etc/dhcpc/resolv.conf
9e4abcb5
SK
1763
1764.IR /etc/hosts
1765
3be34541
SK
1766.IR /etc/ethers
1767
b49644f3
SK
1768.IR /var/lib/misc/dnsmasq.leases
1769
1770.IR /var/db/dnsmasq.leases
9e4abcb5
SK
1771
1772.IR /var/run/dnsmasq.pid
1773.SH SEE ALSO
9e4abcb5
SK
1774.BR hosts (5),
1775.BR resolver (5)
1776.SH AUTHOR
1777This manual page was written by Simon Kelley <simon@thekelleys.org.uk>.
1778
1779