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