local_nameservers now defaults to 127.* 0.0.0.0 255.255.255.255 ::1
[openresolv] / resolvconf.conf.5.in
1 .\" Copyright (c) 2009-2014 Roy Marples
2 .\" All rights reserved
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .Dd October 19, 2014
26 .Dt RESOLVCONF.CONF 5 SMM
27 .Os
28 .Sh NAME
29 .Nm resolvconf.conf
30 .Nd resolvconf configuration file
31 .Sh DESCRIPTION
32 .Nm
33 is the configuration file for
34 .Xr resolvconf 8 .
35 The
36 .Nm
37 file is a shell script that is sourced by
38 .Xr resolvconf 8 ,
39 meaning that
40 .Nm
41 must contain valid shell commands.
42 Listed below are the standard
43 .Nm
44 variables that may be set.
45 If the values contain white space for special shell characters,
46 ensure they are quoted and escaped correctly.
47 .Pp
48 After updating this file, you may wish to run
49 .Nm resolvconf -u
50 to apply the new configuration.
51 .Sh RESOLVCONF OPTIONS
52 .Bl -tag -width indent
53 .It Sy interface_order
54 These interfaces will always be processed first.
55 If unset, defaults to the following:-
56 .D1 lo lo[0-9]*
57 .It Sy dynamic_order
58 These interfaces will be processed next, unless they have a metric.
59 If unset, defaults to the following:-
60 .D1 tap[0-9]* tun[0-9]* vpn vpn[0-9]* ppp[0-9]* ippp[0-9]*
61 .It Sy local_nameservers
62 If unset, defaults to the following:-
63 .D1 127.* 0.0.0.0 255.255.255.255 ::1
64 .It Sy search_domains
65 Prepend search domains to the dynamically generated list.
66 .It Sy search_domains_append
67 Append search domains to the dynamically generated list.
68 .It Sy domain_blacklist
69 A list of domains to be removed from consideration.
70 To remove a domain, you can use foo.*
71 To remove a sub domain, you can use *.bar
72 .It Sy name_servers
73 Prepend name servers to the dynamically generated list.
74 You should set this to 127.0.0.1 if you use a local name server other than
75 libc.
76 .It Sy name_servers_append
77 Append name servers to the dynamically generated list.
78 .It Sy name_server_blacklist
79 A list of name servers to be removed from consideration.
80 The default is 0.0.0.0 as some faulty routers send it via DHCP.
81 To remove a block, you can use 192.168.*
82 .It Sy private_interfaces
83 These interfaces name servers will only be queried for the domains listed
84 in their resolv.conf.
85 Useful for VPN domains.
86 This is equivalent to the
87 .Nm resolvconf -p
88 option.
89 .It Sy state_dir
90 Override the default state directory of
91 .Pa @VARDIR@ .
92 This should not be changed once
93 .Nm resolvconf
94 is in use unless the old directory is copied to the new one.
95 .El
96 .Sh LIBC OPTIONS
97 The following variables affect
98 .Xr resolv.conf 5
99 directly:-
100 .Bl -tag -width indent
101 .It Sy resolv_conf
102 Defaults to
103 .Pa /etc/resolv.conf
104 if not set.
105 .It Sy resolv_conf_options
106 A list of libc resolver options, as specified in
107 .Xr resolv.conf 5 .
108 .It Sy resolv_conf_passthrough
109 When set to YES the latest resolv.conf is written to
110 .Sy resolv_conf
111 without any alteration.
112 .It Sy resolv_conf_sortlist
113 A libc resolver sortlist, as specified in
114 .Xr resolv.conf 5 .
115 .It Sy resolv_conf_local_only
116 If a local name server is configured then the default is just to specify that
117 and ignore all other entries as they will be configured for the local
118 name server.
119 Set this to NO to also list non-local nameservers.
120 This will give you working DNS even if the local nameserver stops functioning
121 at the expense of duplicated server queries.
122 .El
123 .Sh SUBSCRIBER OPTIONS
124 openresolv ships with subscribers for the name servers
125 .Xr dnsmasq 8 ,
126 .Xr named 8 ,
127 .Xr pdnsd 8
128 and
129 .Xr unbound 8 .
130 Each subscriber can create configuration files which should be included in
131 in the subscribers main configuration file.
132 .Bl -tag -width indent
133 .It Sy dnsmasq_conf
134 This file tells dnsmasq which name servers to use for specific domains.
135 .It Sy dnsmasq_resolv
136 This file tells dnsmasq which name servers to use for global lookups.
137 .Pp
138 Example resolvconf.conf for dnsmasq:
139 .D1 name_servers=127.0.0.1
140 .D1 dnsmasq_conf=/etc/dnsmasq-conf.conf
141 .D1 dnsmasq_resolv=/etc/dnsmasq-resolv.conf
142 .Pp
143 Example dnsmasq.conf:
144 .D1 listen-address=127.0.0.1
145 .D1 # If dnsmasq is compiled for DBus then we can take
146 .D1 # advantage of not having to restart dnsmasq.
147 .D1 enable-dbus
148 .D1 conf-file=/etc/dnsmasq-conf.conf
149 .D1 resolv-file=/etc/dnsmasq-resolv.conf
150 .It Sy named_options
151 Include this file in the named options block.
152 This file tells named which name servers to use for global lookups.
153 .It Sy named_zones
154 Include this file in the named global scope, after the options block.
155 This file tells named which name servers to use for specific domains.
156 .Pp
157 Example resolvconf.conf for named:
158 .D1 name_servers=127.0.0.1
159 .D1 named_options=/etc/named-options.conf
160 .D1 named_zones=/etc/named-zones.conf
161 .Pp
162 Example named.conf:
163 .D1 options {
164 .D1     listen-on { 127.0.0.1; };
165 .D1     include "/etc/named-options.conf";
166 .D1 };
167 .D1 include "/etc/named-zones.conf";
168 .It Sy pdnsd_conf
169 This is the main pdnsd configuration file which we modify to add our
170 forward domains to.
171 If this variable is not set then we rely on the pdnsd configuration file
172 setup to read
173 .Pa pdnsd_resolv
174 as documented below.
175 .It Sy pdnsd_resolv
176 This file tells pdnsd about global name servers.
177 If this variable is not set then it's written to
178 .Pa pdnsd_conf .
179 .Pp
180 Example resolvconf.conf for pdnsd:
181 .D1 name_servers=127.0.0.1
182 .D1 pdnsd_conf=/etc/pdnsd.conf
183 .D1 # pdnsd_resolv=/etc/pdnsd-resolv.conf
184 .Pp
185 Example pdnsd.conf:
186 .D1 global {
187 .D1     server_ip = 127.0.0.1;
188 .D1     status_ctl = on;
189 .D1 }
190 .D1 server {
191 .D1     # A server definition is required, even if emtpy.
192 .D1     label="empty";
193 .D1     proxy_only=on;
194 .D1     # file="/etc/pdnsd-resolv.conf";
195 .D1 }
196 .It Sy unbound_conf
197 This file tells unbound about specific and global name servers.
198 .It Sy unbound_insecure
199 When set to YES, unbound marks the domains as insecure, thus ignoring DNSSEC.
200 .Pp
201 Example resolvconf.conf for unbound:
202 .D1 name_servers=127.0.0.1
203 .D1 unbound_conf=/etc/unbound-resolvconf.conf
204 .Pp
205 Example unbound.conf:
206 .D1 include: /etc/unbound-resolvconf.conf
207 .El
208 .Sh SUBSCRIBER INTEGRATION
209 Not all distributions store the files the subscribers need in the same
210 locations.
211 For example, named service scripts have been called named, bind and rc.bind
212 and they could be located in a directory called /etc/rc.d, /etc/init.d or
213 similar.
214 Each subscriber attempts to automatically configure itself, but not every
215 distribution has been catered for.
216 Also, users could equally want to use a different version from the one
217 installed by default, such as bind8 and bind9.
218 To accomodate this, the subscribers have these files in configurable
219 variables, documented below.
220 .Pp
221 .Bl -tag -width indent
222 .It Sy dnsmasq_service
223 Location of the dnsmasq service.
224 .It Sy dnsmasq_restart
225 Command to restart the dnsmasq service.
226 .It Sy dnsmasq_pid
227 Location of the dnsmasq pidfile.
228 .It Sy libc_service
229 Location of the libc service.
230 .It Sy libc_restart
231 Command to restart the libc service.
232 .It Sy named_service
233 Location of the named service.
234 .It Sy named_restart
235 Command to restart the named service.
236 .It Sy pdnsd_restart
237 Command to restart the pdnsd service.
238 .It Sy unbound_service
239 Location of the unbound service.
240 .It Sy unbound_restart
241 Command to restart the unbound service.
242 .It Sy unbound_pid
243 Location of the unbound pidfile.
244 .El
245 .Sh SEE ALSO
246 .Xr resolv.conf 5 ,
247 .Xr resolvconf 8
248 and
249 .Xr sh 1 .
250 .Sh AUTHORS
251 .An Roy Marples Aq Mt roy@marples.name
252 .Sh BUGS
253 Each distribution is a special snowflake and likes to name the same thing
254 differently, namely the named service script.
255 .Pp
256 Please report them to
257 .Lk http://roy.marples.name/projects/openresolv