We should use lower case for normal variables.
[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 18, 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 .El
50 .Sh LIBC OPTIONS
51 The following variables affect
52 .Xr resolv.conf 5
53 directly:-
54 .Bl -tag -width indent
55 .It Sy resolv_conf
56 Defaults to
57 .Pa /etc/resolv.conf
58 if not set.
59 .It Sy search_domains
60 Prepend search domains to the dynamically generated list.
61 .It Sy name_servers
62 Prepend name servers to the dynamically generated list.
63 You should set this to 127.0.0.1 if you use a local name server other than
64 libc.
65 .El
66 .Sh SUBSCRIBER OPTIONS
67 openresolv ships with subscribers for the name servers
68 .Xr dnsmasq 8
69 and
70 .Xr named 8 .
71 These subscribers take two options each which instruct openresolv where
72 to write the configuration files for the name server to include.
73 .Bl -tag -width indent
74 .It Sy dnsmasq_conf
75 Set this to the same file that the dnsmasq configuaration option
76 .Sy conf-file
77 points to.
78 .It Sy dnsmasq_resolv
79 Set this to the same file that the dnsmasq configuaration option
80 .Sy resolv-file
81 points to.
82 .It Sy named_options
83 Include this file in the named options block.
84 .It Sy named_zones
85 Include this file in the named global scope, after the options block.
86 .El
87 .Sh SEE ALSO
88 .Xr resolv.conf 5 ,
89 .Xr resolvconf 8 ,
90 .Xr named.conf 5
91 .Sh AUTHORS
92 .An Roy Marples Aq roy@marples.name
93 .Sh BUGS
94 Please report them to http://roy.marples.name/projects/openresolv