Add resolv_conf_local_only which defaults to true.
[openresolv] / resolvconf.conf.5.in
1 .\" Copyright (c) 2009-2012 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 August 11, 2011
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 .Pp
46 After updating this file, you may wish to run
47 .Nm resolvconf -u
48 to apply the new configuration.
49 .Sh RESOLVCONF OPTIONS
50 .Bl -tag -width indent
51 .It Sy interface_order
52 These interfaces will always be processed first.
53 If unset, defaults to the following:-
54 .D1 lo lo[0-9]*
55 .It Sy dynamic_order
56 These interfaces will be processed next, unless they have a metric.
57 If unset, defaults to the following:-
58 .D1 tap[0-9]* tun[0-9]* vpn vpn[0-9]* ppp[0-9]* ippp[0-9]*
59 .It Sy search_domains
60 Prepend search domains to the dynamically generated list.
61 .It Sy search_domains_append
62 Append search domains to the dynamically generated list.
63 .It Sy name_servers
64 Prepend name servers to the dynamically generated list.
65 You should set this to 127.0.0.1 if you use a local name server other than
66 libc.
67 .It Sy name_servers_append
68 Append name servers to the dynamically generated list.
69 .It Sy private_interfaces
70 These interfaces name servers will only be queried for the domains listed
71 in their resolv.conf.
72 Useful for VPN domains.
73 This is equivalent to the
74 .Nm resolvconf -p
75 option.
76 .It Sy state_dir
77 Override the default state directory of
78 .Pa @VARDIR@ .
79 This should not be changed once
80 .Nm resolvconf
81 is in use unless the old directory is copied to the new one.
82 .El
83 .Sh LIBC OPTIONS
84 The following variables affect
85 .Xr resolv.conf 5
86 directly:-
87 .Bl -tag -width indent
88 .It Sy resolv_conf
89 Defaults to
90 .Pa /etc/resolv.conf
91 if not set.
92 .It Sy resolv_conf_options
93 A list of libc resolver options, as specified in
94 .Xr resolv.conf 5 .
95 .It Sy resolv_conf_passthrough
96 When set to YES the latest resolv.conf is written to
97 .Sy resolv_conf
98 without any alteration.
99 .It Sy resolv_conf_sortlist
100 A libc resolver sortlist, as specified in
101 .Xr resolv.conf 5 .
102 .It Sy resolv_conf_local_only
103 If a local nameserver is configured then the default is just to specify that
104 and ignore all other entries as they will be configured for the local
105 nameserver.
106 Set this to YES to list them instead, if you need working DNS and the local
107 nameserver stops functioning at the expense of duplicated server queries.
108 .El
109 .Sh SUBSCRIBER OPTIONS
110 openresolv ships with subscribers for the name servers
111 .Xr dnsmasq 8 ,
112 .Xr named 8 ,
113 .Xr pdnsd 8
114 and
115 .Xr unbound 8 .
116 Each subscriber can create configuration files which should be included in
117 in the subscribers main configuration file.
118 .Bl -tag -width indent
119 .It Sy dnsmasq_conf
120 This file tells dnsmasq which nameservers to use for specific domains.
121 .It Sy dnsmasq_resolv
122 This file tells dnsmasq which nameservers to use for global lookups.
123 .Pp
124 Example resolvconf.conf for dnsmasq:
125 .D1 nameservers=127.0.0.1
126 .D1 dnsmasq_conf=/etc/dnsmasq-conf.conf
127 .D1 dnsmasq_resolv=/etc/dnsmasq-resolv.conf
128 .Pp
129 Example dnsmasq.conf:
130 .D1 listen-address=127.0.0.1
131 .D1 conf-file=/etc/dnsmasq-conf.conf
132 .D1 resolv-file=/etc/dnsmasq-resolv.conf
133 .It Sy named_options
134 Include this file in the named options block.
135 This file tells named which nameservers to use for global lookups.
136 .It Sy named_zones
137 Include this file in the named global scope, after the options block.
138 This file tells named which nameservers to use for specific domains.
139 .Pp
140 Example resolvconf.conf for named:
141 .D1 nameservers=127.0.0.1
142 .D1 named_options=/etc/named-options.conf
143 .D1 named_zones=/etc/named-zones.conf
144 .Pp
145 Example named.conf:
146 .D1 options {
147 .D1     listen-on { 127.0.0.1; };
148 .D1     include "/etc/named-options.conf";
149 .D1 };
150 .D1 include "/etc/named-zones.conf";
151 .It Sy pdnsd_conf
152 This is the main pdnsd configuration file which we modify to add our
153 forward domains to.
154 If this variable is not set then we rely on the pdnsd configuration file
155 setup to read
156 .Pa pdnsd_resolv
157 as documented below.
158 .It Sy pdnsd_resolv
159 This file tells pdnsd about global nameservers.
160 If this variable is not set then it's written to
161 .Pa pdnsd_conf .
162 .Pp
163 Example resolvconf.conf for pdnsd:
164 .D1 nameservers=127.0.0.1
165 .D1 pdnsd_conf=/etc/pdnsd.conf
166 .D1 # pdnsd_resolv=/etc/pdnsd-resolv.conf
167 .Pp
168 Example pdnsd.conf:
169 .D1 global {
170 .D1     server_ip = 127.0.0.1;
171 .D1     status_ctl = on;
172 .D1 }
173 .D1 server {
174 .D1     # A server definition is required, even if emtpy.
175 .D1     label="empty";
176 .D1     proxy_only=on;
177 .D1     # file="/etc/pdnsd-resolv.conf";
178 .D1 }
179 .It Sy unbound_conf
180 This file tells unbound about specific and global nameservers.
181 .Pp
182 Example resolvconf.conf for unbound:
183 .D1 nameservers=127.0.0.1
184 .D1 unbound_conf=/etc/unbound-resolvconf.conf
185 .Pp
186 Example unbound.conf:
187 .D1 include: /etc/unbound-resolvconf.conf
188 .El
189 .Sh SEE ALSO
190 .Xr resolv.conf 5
191 and
192 .Xr resolvconf 8 .
193 .Sh AUTHORS
194 .An Roy Marples Aq roy@marples.name
195 .Sh BUGS
196 Please report them to http://roy.marples.name/projects/openresolv