Add new config file and man page.
[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 March 16, 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 If unset, the interfaces will be processed in metric order, then
43 tun, tap, vpn, ppp and ippp interfaces. The loopback interface is always
44 processed first regardless.
45 .El
46 .Sh LIBC OPTIONS
47 The following variables affect
48 .Xr resolv.conf 5
49 directly:-
50 .Bl -tag -width indent
51 .It Sy resolv_conf
52 Defaults to
53 .Pa /etc/resolv.conf
54 if not set.
55 .It Sy search_domains
56 Prepend search domains to the dynamically generated list.
57 .It Sy name_servers
58 Prepend name servers to the dynamically generated list.
59 You should set this to 127.0.0.1 if you use a local name server other than
60 libc.
61 .El
62 .Sh SUBSCRIBER OPTIONS
63 openresolv ships with subscribers for the name servers
64 .Xr dnsmasq 8
65 and
66 .Xr named 8 .
67 These subscribers take two options each which instruct openresolv where
68 to write the configuration files for the name server to include.
69 .Bl -tag -width indent
70 .It Sy dnsmasq_conf
71 Set this to the same file that the dnsmasq configuaration option
72 .Sy conf-file
73 points to.
74 .It Sy dnsmasq_resolv
75 Set this to the same file that the dnsmasq configuaration option
76 .Sy resolv-file
77 points to.
78 .It Sy named_options
79 Include this file in the named options block.
80 .It Sy named_zones
81 Include this file in the named global scope, after the options block.
82 .El
83 .Sh SEE ALSO
84 .Xr resolv.conf 5 ,
85 .Xr resolvconf 8 ,
86 .Xr named.conf 5
87 .Sh AUTHORS
88 .An Roy Marples Aq roy@marples.name
89 .Sh BUGS
90 Please report them to http://roy.marples.name/projects/openresolv