We should not abuse Ta.
[openresolv] / resolvconf.conf.5.in
1 .\" Copyright (c) 2009-2010 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 July 4, 2010
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 updaing 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 name_servers
62 Prepend name servers to the dynamically generated list.
63 You should set this to 127.0.0.1 if you use a local name server other than
64 libc.
65 .It Sy private_interfaces
66 These interfaces name servers will only be queried for the domains listed
67 in their resolv.conf.
68 Useful for VPN domains.
69 This is equivalent to the
70 .Nm resolvconf -p
71 option.
72 .It Sy state_dir
73 Override the default state directory of
74 .Pa @VARDIR@ .
75 This should not be changed once
76 .Nm resolvconf
77 is in use unless the old directory is copied to the new one.
78 .El
79 .Sh LIBC OPTIONS
80 The following variables affect
81 .Xr resolv.conf 5
82 directly:-
83 .Bl -tag -width indent
84 .It Sy resolv_conf
85 Defaults to
86 .Pa /etc/resolv.conf
87 if not set.
88 .It Sy resolv_conf_options
89 A list of libc resolver options, as specified in
90 .Xr resolv.conf 5 .
91 .It Sy resolv_conf_passthrough
92 When set to YES the latest resolv.conf is written to
93 .Sy resolv_conf
94 without any alteration.
95 .El
96 .Sh SUBSCRIBER OPTIONS
97 openresolv ships with subscribers for the name servers
98 .Xr dnsmasq 8 ,
99 .Xr named 8
100 and
101 .Xr unbound 8 .
102 Each subscriber can create configuration files which should be included in
103 in the subscribers main configuration file.
104 .Bl -tag -width indent
105 .It Sy dnsmasq_conf
106 This file tells dnsmasq which nameservers to use for specific domains.
107 .It Sy dnsmasq_resolv
108 This file tells dnsmasq which nameservers to use for global lookups.
109 .Pp
110 Example resolvconf.conf for dnsmasq:
111 .D1 nameservers=127.0.0.1
112 .D1 dnsmasq_conf=/etc/dnsmasq-conf.conf
113 .D1 dnsmasq_resolv=/etc/dnsmasq-resolv.conf
114 .Pp
115 Example dnsmasq.conf:
116 .D1 listen-address=127.0.0.1
117 .D1 conf-file=/etc/dnsmasq-conf.conf
118 .D1 resolv-file=/etc/dnsmasq-resolv.conf
119 .It Sy named_options
120 Include this file in the named options block.
121 This file tells named which nameservers to use for global lookups.
122 .It Sy named_zones
123 Include this file in the named global scope, after the options block.
124 This file tells named which nameservers to use for specific domains.
125 .Pp
126 Example resolvconf.conf for named:
127 .D1 nameservers=127.0.0.1
128 .D1 named_options=/etc/named-options.conf
129 .D1 named_zones=/etc/named-zones.conf
130 .Pp
131 Example named.conf:
132 .D1 options {
133 .D1     listen-on { 127.0.0.1; };
134 .D1     include "/etc/named-options.conf";
135 .D1 };
136 .D1 include "/etc/named-zones.conf";
137 .It Sy unbound_conf
138 This file tells unbound about specific and global nameservers.
139 .Pp
140 Example resolvconf.conf for unbound:
141 .D1 nameservers=127.0.0.1
142 .D1 unbound_conf=/etc/unbound-resolvconf.conf
143 .Pp
144 Example unbound.conf:
145 .D1 include: /etc/unbound-resolvconf.conf
146 .El
147 .Sh SEE ALSO
148 .Xr resolv.conf 5
149 and
150 .Xr resolvconf 8 .
151 .Sh AUTHORS
152 .An Roy Marples Aq roy@marples.name
153 .Sh BUGS
154 Please report them to http://roy.marples.name/projects/openresolv