Add a subcriber for the PowerDNS Recursor
[openresolv] / resolvconf.conf.5.in
1 .\" Copyright 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 April 21, 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 .Pp
36 After updaing this file, you may wish to run
37 .Nm resolvconf -u
38 to apply the new configuration.
39 .Sh RESOLVCONF OPTIONS
40 .Bl -tag -width indent
41 .It Sy interface_order
42 These interfaces will always be processed first.
43 If unset, defaults to the following:-
44 .D1 lo lo[0-9]*
45 .It Sy dynamic_order
46 These interfaces will be processed next, unless they have a metric.
47 If unset, defaults to the following:-
48 .D1 tap[0-9]* tun[0-9]* vpn vpn[0-9]* ppp[0-9]* ippp[0-9]*
49 .It Sy private_interfaces
50 These interfaces name servers will only be queried for the domains listed
51 in their resolv.conf.
52 This is equivalent to the
53 .Nm resolvconf -p
54 option.
55 .El
56 .Sh LIBC OPTIONS
57 The following variables affect
58 .Xr resolv.conf 5
59 directly:-
60 .Bl -tag -width indent
61 .It Sy resolv_conf
62 Defaults to
63 .Pa /etc/resolv.conf
64 if not set.
65 .It Sy search_domains
66 Prepend search domains to the dynamically generated list.
67 .It Sy name_servers
68 Prepend name servers to the dynamically generated list.
69 You should set this to 127.0.0.1 if you use a local name server other than
70 libc.
71 .It Sy resolv_conf_passthrough
72 When set to YES the latest resolv.conf is written to
73 .Sy resolv_conf
74 without any alteration.
75 .El
76 .Sh SUBSCRIBER OPTIONS
77 openresolv ships with subscribers for the name servers
78 .Xr dnsmasq 8 ,
79 .Xr pdns_recursor 8
80 and
81 .Xr named 8 .
82 These subscribers take two options each which instruct openresolv where
83 to write the configuration files for the name server to include.
84 .Bl -tag -width indent
85 .It Sy dnsmasq_conf
86 Set this to the same file that the dnsmasq configuaration option
87 .Sy conf-file
88 points to.
89 .It Sy dnsmasq_resolv
90 Set this to the same file that the dnsmasq configuaration option
91 .Sy resolv-file
92 points to.
93 .It Sy pdns_zones
94 Set this to the same file that the pdns_recursor configuration option
95 .Sy forward-zones-file
96 points to.
97 .It Sy named_options
98 Include this file in the named options block.
99 .It Sy named_zones
100 Include this file in the named global scope, after the options block.
101 .El
102 .Sh SEE ALSO
103 .Xr resolv.conf 5 ,
104 .Xr resolvconf 8 ,
105 .Xr named.conf 5
106 .Sh AUTHORS
107 .An Roy Marples Aq roy@marples.name
108 .Sh BUGS
109 Please report them to http://roy.marples.name/projects/openresolv