Move the generated by comment to the head file so the user can edit it.
[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 05, 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 configure
73 .Pa /etc/resolv.conf
74 to use that and supply files that the resolver should be configured to include.
75 This allows
76 .Nm
77 to configure the local resolver such that
78 .Pa resolv.conf
79 files specifiying a domain only query the listed nameservers when resolving
80 for that domain. Otherwise the nameservers are treated as global nameservers.
81 This in turn means, that you can trivially configure nameservers for say
82 VPN domains. Example:-
83 .Bd -literal -offset indent
84 # resolv.conf from bge0
85 search foo.com
86 nameserver 1.2.3.4
87
88 # resolv.conf from tap0
89 domain bar.org
90 nameserver 5.6.7.8
91 .Ed
92 .Pp
93 In this instance, nameserver 5.6.7.8 will only handle requests for bar.org
94 and nameserver 1.2.3.4 will handle everything else.
95 .Pp
96 When an interface goes down, it should then call
97 .Nm
98 with
99 .Fl d Ar interface
100 arguments to delete the
101 .Pa resolv.conf
102 file for the
103 .Ar interface .
104 .Pp
105 Here are some more options that
106 .Nm
107 has:-
108 .Bl -tag -width indent
109 .It Fl f
110 Ignore non existant interfaces. Only really useful for deleting interfaces.
111 .It Fl i Ar pattern
112 List the interfaces, optionally matching
113 .Ar pattern ,
114 we have
115 .Pa resolv.conf
116 files for.
117 .It Fl l Ar pattern
118 List the
119 .Pa resolv.conf
120 files we have. If
121 .Ar pattern
122 is specified then we list the files for the interfaces that match it.
123 .It Fl u
124 Force
125 .Nm
126 to update all it's helpers.
127 .El
128 .Pp
129 .Nm
130 also has some options designed to be used by it's helpers:-
131 .Bl -tag -width indent
132 .It Fl s Ar service Ar command ...
133 Try and send the
134 .Ar command
135 to the system
136 .Ar service .
137 Normally this is something like
138 .Ar resolvconf -s named restart .
139 We have this command, so the helpers don't have to know too much about the
140 operating system on the host.
141 .It Fl v
142 Echo variables NEWDOMAIN, NEWSEARCH and NEWNS so that the helper can configure
143 the resolver easily.
144 .El
145 .Sh FILES
146 .Bl -ohang
147 .It Pa @VARBASE@/run/resolvconf
148 Directory that holds the data for
149 .Nm .
150 You could symlink
151 .Pa /etc/resolv.conf
152 to
153 .Pa @VARBASE@/run/resolvconf/resolv.conf
154 to support a read only
155 .Pa /etc .
156 .It Pa @SYSCONFDIR@/update.d
157 Directory of the helper scripts which are run every time
158 .Nm
159 adds, deletes or updates.
160 .It Pa @SYSCONFDIR@/update-libc.d
161 Directory of helper scripts which are run after the libc helper script is run.
162 .It Pa @SYSCONFDIR@/interface-order
163 Determines the order in which nameserver information records are processed
164 by resolvconf -l.
165 .It Pa @SYSCONFDIR@/resolv.conf.d/base
166 Contains basic resolver information which is included in
167 .Pa /etc/resolv.conf
168 even when no interfaces are configured.
169 .It Pa @SYSCONFDIR@/resolv.conf.d/head
170 File to be prepended to
171 .Pa /etc/resolv.conf .
172 Normally this is just a comment line.
173 .It Pa @SYSCONFDIR@/resolv.conf.d/tail
174 File to be appended to
175 .Pa /etc/resolv.conf .
176 .El
177 .Sh HISTORY
178 This implementation of
179 .Nm
180 is called openresolv and is fully command line compatible with Debians
181 resolvconf, as written by Thomas Hood, on which openresolv is based.
182 openresolv also shares a similar directory structure with the Debian version,
183 but the included helpers are not compatible.
184 .Pp
185 The Debian version only works with bash and other GNU userland tools, whereas
186 openresolv works with a POSIX shell and userland tools.
187 .Sh BUGS
188 .Nm
189 does not validate any of the files given to it.
190 .Pp
191 When running a local resolver other than libc, you will need to configure it
192 to include files that
193 .Nm
194 will generate. You should consult the comment section in the helper script
195 for your resolver found in @SYSCONFDIR@/update.d for instructions
196 on this.
197 .Sh SEE ALSO
198 .Xr dnsmasq 8 ,
199 .Xr named 8 ,
200 .Xr resolv.conf 5 ,
201 .Xr resolver 3 ,
202 .Xr stdin 3
203 .Sh AUTHORS
204 .An "Roy Marples" Aq roy@marples.name
205 .Sh BUGS
206 Please report them to http://bugs.marples.name