Allow state_dir to override the compiled VARDIR variable.
[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 12, 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 .It Sy state_dir
56 Override the default state directory of
57 .Pa @VARDIR@ .
58 This should not be changed once
59 .Nm resolvconf
60 is in use unless the old directory is copied to the new one.
61 .El
62 .Sh LIBC OPTIONS
63 The following variables affect
64 .Xr resolv.conf 5
65 directly:-
66 .Bl -tag -width indent
67 .It Sy resolv_conf
68 Defaults to
69 .Pa /etc/resolv.conf
70 if not set.
71 .It Sy resolv_conf_options
72 A list of libc resolver options, as specified in
73 .Xr resolv.conf 5 .
74 .It Sy search_domains
75 Prepend search domains to the dynamically generated list.
76 .It Sy name_servers
77 Prepend name servers to the dynamically generated list.
78 You should set this to 127.0.0.1 if you use a local name server other than
79 libc.
80 .It Sy resolv_conf_passthrough
81 When set to YES the latest resolv.conf is written to
82 .Sy resolv_conf
83 without any alteration.
84 .El
85 .Sh SUBSCRIBER OPTIONS
86 openresolv ships with subscribers for the name servers
87 .Xr dnsmasq 8
88 and
89 .Xr named 8 .
90 These subscribers take two options each which instruct openresolv where
91 to write the configuration files for the name server to include.
92 .Bl -tag -width indent
93 .It Sy dnsmasq_conf
94 Set this to the same file that the dnsmasq configuaration option
95 .Sy conf-file
96 points to.
97 .It Sy dnsmasq_resolv
98 Set this to the same file that the dnsmasq configuaration option
99 .Sy resolv-file
100 points to.
101 .It Sy named_options
102 Include this file in the named options block.
103 .It Sy named_zones
104 Include this file in the named global scope, after the options block.
105 .El
106 .Sh SEE ALSO
107 .Xr resolv.conf 5 ,
108 .Xr resolvconf 8 ,
109 .Xr named.conf 5
110 .Sh AUTHORS
111 .An Roy Marples Aq roy@marples.name
112 .Sh BUGS
113 Please report them to http://roy.marples.name/projects/openresolv