<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="resource-type" content="document">
<link rel="stylesheet" href="../style.css" type="text/css" media="all">
<title>
RESOLVCONF.CONF(5)</title>
</head>
<body>
<div class="mandoc">
<table summary="Document Header" class="head" width="100%">
<col width="30%">
<col width="30%">
<col width="30%">
<tbody>
<tr>
<td class="head-ltitle">
RESOLVCONF.CONF(5)</td>
<td class="head-vol" align="center">
System Manager's Manual</td>
<td class="head-rtitle" align="right">
RESOLVCONF.CONF(5)</td>
</tr>
</tbody>
</table>
<div class="section">
<h1 id="x4e414d45">NAME</h1> <b class="name">resolvconf.conf</b> — <span class="desc">resolvconf configuration file</span></div>
<div class="section">
<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">resolvconf.conf</b> is the configuration file for <a class="link-man" href="../html8/resolvconf.html">resolvconf(8)</a>. The <b class="name">resolvconf.conf</b> file is a shell script that is sourced by <a class="link-man" href="../html8/resolvconf.html">resolvconf(8)</a>, meaning that <b class="name">resolvconf.conf</b> must contain valid shell commands. Listed below are the standard <b class="name">resolvconf.conf</b> variables that may be set.<p>
After updating this file, you may wish to run <b class="name">resolvconf -u</b> to apply the new configuration.</div>
<div class="section">
<h1 id="x5245534f4c56434f4e46204f5054494f4e53">RESOLVCONF OPTIONS</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag">
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">interface_order</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
These interfaces will always be processed first. If unset, defaults to the following:-<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
lo lo[0-9]*</div>
</blockquote>
</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">dynamic_order</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
These interfaces will be processed next, unless they have a metric. If unset, defaults to the following:-<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
tap[0-9]* tun[0-9]* vpn vpn[0-9]* ppp[0-9]* ippp[0-9]*</div>
</blockquote>
</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">search_domains</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Prepend search domains to the dynamically generated list.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">search_domains_append</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Append search domains to the dynamically generated list.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">name_servers</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Prepend name servers to the dynamically generated list. You should set this to 127.0.0.1 if you use a local name server other than libc.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">name_servers_append</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Append name servers to the dynamically generated list.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">private_interfaces</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
These interfaces name servers will only be queried for the domains listed in their resolv.conf. Useful for VPN domains. This is equivalent to the <b class="name">resolvconf -p</b> option.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">state_dir</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Override the default state directory of <i class="file">/var/run/resolvconf</i>. This should not be changed once <b class="name">resolvconf</b> is in use unless the old directory is copied to the new one.</dd>
</dl>
</div>
<div class="section">
<h1 id="x4c494243204f5054494f4e53">LIBC OPTIONS</h1> The following variables affect <a class="link-man" href="../html5/resolv.conf.html">resolv.conf(5)</a> directly:-<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag">
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">resolv_conf</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Defaults to <i class="file">/etc/resolv.conf</i> if not set.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">resolv_conf_options</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
A list of libc resolver options, as specified in <a class="link-man" href="../html5/resolv.conf.html">resolv.conf(5)</a>.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">resolv_conf_passthrough</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
When set to YES the latest resolv.conf is written to <span class="symb">resolv_conf</span> without any alteration.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">resolv_conf_sortlist</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
A libc resolver sortlist, as specified in <a class="link-man" href="../html5/resolv.conf.html">resolv.conf(5)</a>.</dd>
</dl>
</div>
<div class="section">
<h1 id="x53554253435249424552204f5054494f4e53">SUBSCRIBER OPTIONS</h1> openresolv ships with subscribers for the name servers <a class="link-man" href="../html8/dnsmasq.html">dnsmasq(8)</a>, <a class="link-man" href="../html8/named.html">named(8)</a>, <a class="link-man" href="../html8/pdnsd.html">pdnsd(8)</a> and <a class="link-man" href="../html8/unbound.html">unbound(8)</a>. Each subscriber can create configuration files which should be included in in the subscribers main configuration file.<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag">
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">dnsmasq_conf</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
This file tells dnsmasq which nameservers to use for specific domains.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">dnsmasq_resolv</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
This file tells dnsmasq which nameservers to use for global lookups.<p>
Example resolvconf.conf for dnsmasq:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
nameservers=127.0.0.1</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
dnsmasq_conf=/etc/dnsmasq-conf.conf</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
dnsmasq_resolv=/etc/dnsmasq-resolv.conf</div>
</blockquote>
<p>
Example dnsmasq.conf:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
listen-address=127.0.0.1</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
conf-file=/etc/dnsmasq-conf.conf</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
resolv-file=/etc/dnsmasq-resolv.conf</div>
</blockquote>
</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">named_options</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Include this file in the named options block. This file tells named which nameservers to use for global lookups.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">named_zones</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
Include this file in the named global scope, after the options block. This file tells named which nameservers to use for specific domains.<p>
Example resolvconf.conf for named:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
nameservers=127.0.0.1</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
named_options=/etc/named-options.conf</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
named_zones=/etc/named-zones.conf</div>
</blockquote>
<p>
Example named.conf:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
options {</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
listen-on { 127.0.0.1; };</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
include /etc/named-options.conf;</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
};</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
include /etc/named-zones.conf;</div>
</blockquote>
</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">pdnsd_conf</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
This is the main pdnsd configuration file which we modify to add our forward domains to. If this variable is not set then we rely on the pdnsd configuration file setup to read <i class="file">pdnsd_resolv</i> as documented below.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">pdnsd_resolv</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
This file tells pdnsd about global nameservers. If this variable is not set then it's written to <i class="file">pdnsd_conf</i>.<p>
Example resolvconf.conf for pdnsd:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
nameservers=127.0.0.1</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
pdnsd_conf=/etc/pdnsd.conf</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
# pdnsd_resolv=/etc/pdnsd-resolv.conf</div>
</blockquote>
<p>
Example pdnsd.conf:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
global {</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
server_ip = 127.0.0.1;</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
status_ctl = on;</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
}</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
server {</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
# A server definition is required, even if emtpy.</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
label="empty";</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
proxy_only=on;</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
# file="/etc/pdnsd-resolv.conf";</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
}</div>
</blockquote>
</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<span class="symb">unbound_conf</span></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
This file tells unbound about specific and global nameservers.<p>
Example resolvconf.conf for unbound:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
nameservers=127.0.0.1</div>
</blockquote>
<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
unbound_conf=/etc/unbound-resolvconf.conf</div>
</blockquote>
<p>
Example unbound.conf:<blockquote style="margin-top: 0.00em;margin-bottom: 0.00em;">
<div class="display">
include: /etc/unbound-resolvconf.conf</div>
</blockquote>
</dd>
</dl>
</div>
<div class="section">
<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man" href="../html5/resolv.conf.html">resolv.conf(5)</a> and <a class="link-man" href="../html8/resolvconf.html">resolvconf(8)</a>.</div>
<div class="section">
<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Roy Marples</span> <roy@marples.name></div>
<div class="section">
<h1 id="x42554753">BUGS</h1> Please report them to http://roy.marples.name/projects/openresolv</div>
<table summary="Document Footer" class="foot" width="100%">
<col width="50%">
<col width="50%">
<tbody>
<tr>
<td class="foot-date">
August 11, 2011</td>
<td class="foot-os" align="right">
NetBSD 6.0</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>