Release 1.5.1
[openresolv] / resolvconf.8.in
1 .\" Copyright 2007-2008 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 Mar 07, 2008
26 .Dt RESOLVCONF 8 SMM
27 .Sh NAME
28 .Nm resolvconf
29 .Nd a framework for managing multiple DNS configurations
30 .Sh SYNOPSIS
31 .Nm
32 .Fl a Ar interface No < Ns Pa file
33 .Nm
34 .Op Fl f
35 .Fl d Ar interface
36 .Nm
37 .Fl il Ar pattern
38 .Nm
39 .Fl u
40 .Sh DESCRIPTION
41 .Nm
42 manages
43 .Xr resolv.conf 5
44 files from multiple sources, such as DHCP and VPN clients.
45 Traditionally, the host runs just one client and that updates
46 .Pa /etc/resolv.conf .
47 More modern systems frequently have wired and wireless interfaces and there is
48 no guarantee both are on the same network. With the advent of VPN and other
49 types of networking daemons, many things now contend for the contents of
50 .Pa /etc/resolv.conf .
51 .Pp
52 .Nm
53 solves this by letting the daemon send their
54 .Xr resolv.conf 5
55 file to
56 .Nm
57 via
58 .Xr stdin 3
59 with the argument
60 .Fl a Ar interface
61 instead of the filesystem.
62 .Nm
63 then updates
64 .Pa /etc/resolv.conf
65 as it thinks best.
66 When a local resolver other than libc is installed, such as
67 .Xr dnsmasq 8
68 or
69 .Xr named 8
70 then
71 .Nm
72 will supply files that the resolver should be configured to include.
73 This allows
74 .Nm
75 to configure the local resolver such that
76 .Pa resolv.conf
77 files specifiying a domain only query the listed nameservers when resolving
78 for that domain. Otherwise the nameservers are treated as global nameservers.
79 This in turn means, that you can trivially configure nameservers for say
80 VPN domains. Example:-
81 .Bd -literal -offset indent
82 # resolv.conf from bge0
83 search foo.com
84 nameserver 1.2.3.4
85
86 # resolv.conf from tap0
87 domain bar.org
88 nameserver 5.6.7.8
89 .Ed
90 .Pp
91 In this instance, nameserver 5.6.7.8 will only handle requests for bar.org
92 and nameserver 1.2.3.4 will handle everything else.
93 .Pp
94 When an interface goes down, it should then call
95 .Nm
96 with
97 .Fl d Ar interface
98 arguments to delete the
99 .Pa resolv.conf
100 file for the
101 .Ar interface .
102 .Pp
103 Here are some more options that
104 .Nm
105 has:-
106 .Bl -tag -width indent
107 .It Fl f
108 Ignore non existant interfaces. Only really useful for deleting interfaces.
109 .It Fl i Ar pattern
110 List the interfaces, optionally matching
111 .Ar pattern ,
112 we have
113 .Pa resolv.conf
114 files for.
115 .It Fl l Ar pattern
116 List the
117 .Pa resolv.conf
118 files we have. If
119 .Ar pattern
120 is specified then we list the files for the interfaces that match it.
121 .It Fl u
122 Force
123 .Nm
124 to update all it's helpers.
125 .El
126 .Pp
127 .Nm
128 also has some options designed to be used by it's helpers:-
129 .Bl -tag -width indent
130 .It Fl s Ar service Ar command ...
131 Try and send the
132 .Ar command
133 to the system
134 .Ar service .
135 Normally this is something like
136 .Ar resolvconf -s named restart .
137 We have this command, so the helpers don't have to know too much about the
138 operating system on the host.
139 .It Fl v
140 Echo variables NEWDOMAIN, NEWSEARCH and NEWNS so that the helper can configure
141 the resolver easily.
142 .El
143 .Sh FILES
144 .Bl -ohang
145 .It Pa @VARBASE@/run/resolvconf
146 Directory that holds the data for
147 .Nm .
148 .It Pa @SYSCONFDIR@/update.d
149 Directory of the helper scripts which are run every time
150 .Nm
151 adds, deletes or updates.
152 .It Pa @SYSCONFDIR@/update-libc.d
153 Directory of helper scripts which are run after the libc helper script is run.
154 .It Pa @SYSCONFDIR@/interface-order
155 Determines the order in which nameserver information records are processed
156 by resolvconf -l.
157 .It Pa @SYSCONFDIR@/resolv.conf.d/base
158 Contains basic resolver information which is included in
159 .Pa /etc/resolv.conf
160 even when no interfaces are configured.
161 .It Pa @SYSCONFDIR@/resolv.conf.d/head
162 File to be prepended to
163 .Pa /etc/resolv.conf .
164 Normally this is just a comment line.
165 .It Pa @SYSCONFDIR@/resolv.conf.d/tail
166 File to be appended to
167 .Pa /etc/resolv.conf .
168 .El
169 .Sh HISTORY
170 This implementation of
171 .Nm
172 is called openresolv and is fully command line compatible with Debians
173 resolvconf, as written by Thomas Hood, on which openresolv is based.
174 openresolv also shares a similar directory structure with the Debian version,
175 but the included helpers are not compatible.
176 .Pp
177 The Debian version only works with bash and other GNU userland tools, whereas
178 openresolv works with a POSIX shell and userland tools.
179 .Sh BUGS
180 .Nm
181 does not validate any of the files given to it.
182 .Pp
183 When running a local resolver other than libc, you will need to configure it
184 to include files that
185 .Nm
186 will generate. You should consult the comment section in the helper script
187 for your resolver found in @SYSCONFDIR@/update.d for instructions
188 on this.
189 .Sh SEE ALSO
190 .Xr dnsmasq 8 ,
191 .Xr named 8 ,
192 .Xr resolv.conf 5 ,
193 .Xr resolver 3 ,
194 .Xr stdin 3
195 .Sh AUTHORS
196 .An "Roy Marples" Aq roy@marples.name
197 .Sh BUGS
198 Please report them to http://bugs.marples.name