Ignore unbound
[openresolv] / resolvconf.conf.5.in
1 .\" Copyright (c) 2009 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 November 15, 2009
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 private_interfaces
60 These interfaces name servers will only be queried for the domains listed
61 in their resolv.conf.
62 This is equivalent to the
63 .Nm resolvconf -p
64 option.
65 .It Sy state_dir
66 Override the default state directory of
67 .Pa @VARDIR@ .
68 This should not be changed once
69 .Nm resolvconf
70 is in use unless the old directory is copied to the new one.
71 .El
72 .Sh LIBC OPTIONS
73 The following variables affect
74 .Xr resolv.conf 5
75 directly:-
76 .Bl -tag -width indent
77 .It Sy resolv_conf
78 Defaults to
79 .Pa /etc/resolv.conf
80 if not set.
81 .It Sy resolv_conf_options
82 A list of libc resolver options, as specified in
83 .Xr resolv.conf 5 .
84 .It Sy search_domains
85 Prepend search domains to the dynamically generated list.
86 .It Sy name_servers
87 Prepend name servers to the dynamically generated list.
88 You should set this to 127.0.0.1 if you use a local name server other than
89 libc.
90 .It Sy resolv_conf_passthrough
91 When set to YES the latest resolv.conf is written to
92 .Sy resolv_conf
93 without any alteration.
94 .El
95 .Sh SUBSCRIBER OPTIONS
96 openresolv ships with subscribers for the name servers
97 .Xr dnsmasq 8 ,
98 .Xr named 8
99 and
100 .Xr unbound 8 .
101 These subscribers have options which instruct openresolv where
102 to write the configuration files for the name server to include.
103 .Bl -tag -width indent
104 .It Sy dnsmasq_conf
105 Set this to the same file that the dnsmasq configuaration option
106 .Sy conf-file
107 points to.
108 This file tells dnsmasq which nameservers to use for specific domains.
109 .It Sy dnsmasq_resolv
110 Set this to the same file that the dnsmasq configuaration option
111 .Sy resolv-file
112 points to.
113 This file tells dnsmasq which nameservers to use for global lookups.
114 .It Sy named_options
115 Include this file in the named options block.
116 This file tells named which nameservers to use for global lookups.
117 .It Sy named_zones
118 Include this file in the named global scope, after the options block.
119 This file tells named which nameservers to use for specific domains.
120 .It Sy unbound_conf
121 Include this file anywhere in the unbound configuration.
122 This file tells unbound about specific and global nameservers.
123 .El
124 .Sh SEE ALSO
125 .Xr resolv.conf 5
126 and
127 .Xr resolvconf 8 .
128 .Sh AUTHORS
129 .An Roy Marples Aq roy@marples.name
130 .Sh BUGS
131 Please report them to http://roy.marples.name/projects/openresolv