Document prepend_search and prepend_nameservers.
[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 28, 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 .Pp
52 When a dynmically generated list is appended or prepended to, the whole
53 is made unique where left-most wins.
54 .Sh RESOLVCONF OPTIONS
55 .Bl -tag -width indent
56 .It Sy resolvconf
57 Set to NO to disable
58 .Nm resolvconf
59 from running any subscribers.
60 Defaults to YES.
61 .It Sy interface_order
62 These interfaces will always be processed first.
63 If unset, defaults to the following:-
64 .D1 lo lo[0-9]*
65 .It Sy dynamic_order
66 These interfaces will be processed next, unless they have a metric.
67 If unset, defaults to the following:-
68 .D1 tap[0-9]* tun[0-9]* vpn vpn[0-9]* ppp[0-9]* ippp[0-9]*
69 .It Sy local_nameservers
70 If unset, defaults to the following:-
71 .D1 127.* 0.0.0.0 255.255.255.255 ::1
72 .It Sy search_domains
73 Prepend search domains to the dynamically generated list.
74 .It Sy search_domains_append
75 Append search domains to the dynamically generated list.
76 .It Sy domain_blacklist
77 A list of domains to be removed from consideration.
78 To remove a domain, you can use foo.*
79 To remove a sub domain, you can use *.bar
80 .It Sy name_servers
81 Prepend name servers to the dynamically generated list.
82 You should set this to 127.0.0.1 if you use a local name server other than
83 libc.
84 .It Sy name_servers_append
85 Append name servers to the dynamically generated list.
86 .It Sy name_server_blacklist
87 A list of name servers to be removed from consideration.
88 The default is 0.0.0.0 as some faulty routers send it via DHCP.
89 To remove a block, you can use 192.168.*
90 .It Sy private_interfaces
91 These interfaces name servers will only be queried for the domains listed
92 in their resolv.conf.
93 Useful for VPN domains.
94 This is equivalent to the
95 .Nm resolvconf -p
96 option.
97 .It Sy state_dir
98 Override the default state directory of
99 .Pa @VARDIR@ .
100 This should not be changed once
101 .Nm resolvconf
102 is in use unless the old directory is copied to the new one.
103 .El
104 .Sh LIBC OPTIONS
105 The following variables affect
106 .Xr resolv.conf 5
107 directly:-
108 .Bl -tag -width indent
109 .It Sy resolv_conf
110 Defaults to
111 .Pa /etc/resolv.conf
112 if not set.
113 .It Sy resolv_conf_options
114 A list of libc resolver options, as specified in
115 .Xr resolv.conf 5 .
116 .It Sy resolv_conf_passthrough
117 When set to YES the latest resolv.conf is written to
118 .Sy resolv_conf
119 without any alteration.
120 When set to /dev/null or NULL,
121 .Sy resolv_conf_local_only
122 is defaulted to NO,
123 .Sy local_nameservers
124 is unset unless overriden and only the information set in
125 .Nm
126 is written to
127 .Sy resolv_conf .
128 .It Sy resolv_conf_sortlist
129 A libc resolver sortlist, as specified in
130 .Xr resolv.conf 5 .
131 .It Sy resolv_conf_local_only
132 If a local name server is configured then the default is just to specify that
133 and ignore all other entries as they will be configured for the local
134 name server.
135 Set this to NO to also list non-local nameservers.
136 This will give you working DNS even if the local nameserver stops functioning
137 at the expense of duplicated server queries.
138 .It Sy append_nameservers
139 Append name servers to the dynamically generated list.
140 .It Sy prepend_nameservers
141 Prepend name servers to the dynamically generated list.
142 .It Sy append_search
143 Append search domains to the dynamically generated list.
144 .It Sy prepend_search
145 Prepend search domains to the dynamically generated list.
146 .El
147 .Sh SUBSCRIBER OPTIONS
148 openresolv ships with subscribers for the name servers
149 .Xr dnsmasq 8 ,
150 .Xr named 8 ,
151 .Xr pdnsd 8
152 and
153 .Xr unbound 8 .
154 Each subscriber can create configuration files which should be included in
155 in the subscribers main configuration file.
156 .Pp
157 To disable a subscriber, simply set it's name to NO.
158 For example, to disable the libc subscriber you would set:
159 .D1 libc=NO
160 .Bl -tag -width indent
161 .It Sy dnsmasq_conf
162 This file tells dnsmasq which name servers to use for specific domains.
163 .It Sy dnsmasq_resolv
164 This file tells dnsmasq which name servers to use for global lookups.
165 .Pp
166 Example resolvconf.conf for dnsmasq:
167 .D1 name_servers=127.0.0.1
168 .D1 dnsmasq_conf=/etc/dnsmasq-conf.conf
169 .D1 dnsmasq_resolv=/etc/dnsmasq-resolv.conf
170 .Pp
171 Example dnsmasq.conf:
172 .D1 listen-address=127.0.0.1
173 .D1 # If dnsmasq is compiled for DBus then we can take
174 .D1 # advantage of not having to restart dnsmasq.
175 .D1 enable-dbus
176 .D1 conf-file=/etc/dnsmasq-conf.conf
177 .D1 resolv-file=/etc/dnsmasq-resolv.conf
178 .It Sy named_options
179 Include this file in the named options block.
180 This file tells named which name servers to use for global lookups.
181 .It Sy named_zones
182 Include this file in the named global scope, after the options block.
183 This file tells named which name servers to use for specific domains.
184 .Pp
185 Example resolvconf.conf for named:
186 .D1 name_servers=127.0.0.1
187 .D1 named_options=/etc/named-options.conf
188 .D1 named_zones=/etc/named-zones.conf
189 .Pp
190 Example named.conf:
191 .D1 options {
192 .D1     listen-on { 127.0.0.1; };
193 .D1     include "/etc/named-options.conf";
194 .D1 };
195 .D1 include "/etc/named-zones.conf";
196 .It Sy pdnsd_conf
197 This is the main pdnsd configuration file which we modify to add our
198 forward domains to.
199 If this variable is not set then we rely on the pdnsd configuration file
200 setup to read
201 .Pa pdnsd_resolv
202 as documented below.
203 .It Sy pdnsd_resolv
204 This file tells pdnsd about global name servers.
205 If this variable is not set then it's written to
206 .Pa pdnsd_conf .
207 .Pp
208 Example resolvconf.conf for pdnsd:
209 .D1 name_servers=127.0.0.1
210 .D1 pdnsd_conf=/etc/pdnsd.conf
211 .D1 # pdnsd_resolv=/etc/pdnsd-resolv.conf
212 .Pp
213 Example pdnsd.conf:
214 .D1 global {
215 .D1     server_ip = 127.0.0.1;
216 .D1     status_ctl = on;
217 .D1 }
218 .D1 server {
219 .D1     # A server definition is required, even if emtpy.
220 .D1     label="empty";
221 .D1     proxy_only=on;
222 .D1     # file="/etc/pdnsd-resolv.conf";
223 .D1 }
224 .It Sy unbound_conf
225 This file tells unbound about specific and global name servers.
226 .It Sy unbound_insecure
227 When set to YES, unbound marks the domains as insecure, thus ignoring DNSSEC.
228 .Pp
229 Example resolvconf.conf for unbound:
230 .D1 name_servers=127.0.0.1
231 .D1 unbound_conf=/etc/unbound-resolvconf.conf
232 .Pp
233 Example unbound.conf:
234 .D1 include: /etc/unbound-resolvconf.conf
235 .El
236 .Sh SUBSCRIBER INTEGRATION
237 Not all distributions store the files the subscribers need in the same
238 locations.
239 For example, named service scripts have been called named, bind and rc.bind
240 and they could be located in a directory called /etc/rc.d, /etc/init.d or
241 similar.
242 Each subscriber attempts to automatically configure itself, but not every
243 distribution has been catered for.
244 Also, users could equally want to use a different version from the one
245 installed by default, such as bind8 and bind9.
246 To accomodate this, the subscribers have these files in configurable
247 variables, documented below.
248 .Pp
249 .Bl -tag -width indent
250 .It Sy dnsmasq_service
251 Location of the dnsmasq service.
252 .It Sy dnsmasq_restart
253 Command to restart the dnsmasq service.
254 .It Sy dnsmasq_pid
255 Location of the dnsmasq pidfile.
256 .It Sy libc_service
257 Location of the libc service.
258 .It Sy libc_restart
259 Command to restart the libc service.
260 .It Sy named_service
261 Location of the named service.
262 .It Sy named_restart
263 Command to restart the named service.
264 .It Sy pdnsd_restart
265 Command to restart the pdnsd service.
266 .It Sy unbound_service
267 Location of the unbound service.
268 .It Sy unbound_restart
269 Command to restart the unbound service.
270 .It Sy unbound_pid
271 Location of the unbound pidfile.
272 .El
273 .Sh SEE ALSO
274 .Xr resolv.conf 5 ,
275 .Xr resolvconf 8
276 and
277 .Xr sh 1 .
278 .Sh AUTHORS
279 .An Roy Marples Aq Mt roy@marples.name
280 .Sh BUGS
281 Each distribution is a special snowflake and likes to name the same thing
282 differently, namely the named service script.
283 .Pp
284 Please report them to
285 .Lk http://roy.marples.name/projects/openresolv