Document what the subscriber files are used for.
[openresolv] / resolvconf.conf.5.in
index fc4bde5295dedb5e12841cdfc185ea78df927104..d3845d4dd6398d9f255ea25eba365835de7a2ba3 100644 (file)
@@ -1,4 +1,4 @@
-.\" Copyright 2009 Roy Marples
+.\" Copyright (c) 2009 Roy Marples
 .\" All rights reserved
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd March 19, 2009
+.Dd November 12, 2009
 .Dt RESOLVCONF.CONF 5 SMM
 .Os
 .Sh NAME
@@ -52,6 +52,12 @@ in their resolv.conf.
 This is equivalent to the
 .Nm resolvconf -p
 option.
+.It Sy state_dir
+Override the default state directory of
+.Pa @VARDIR@ .
+This should not be changed once
+.Nm resolvconf
+is in use unless the old directory is copied to the new one.
 .El
 .Sh LIBC OPTIONS
 The following variables affect
@@ -62,12 +68,19 @@ directly:-
 Defaults to
 .Pa /etc/resolv.conf
 if not set.
+.It Sy resolv_conf_options
+A list of libc resolver options, as specified in
+.Xr resolv.conf 5 .
 .It Sy search_domains
 Prepend search domains to the dynamically generated list.
 .It Sy name_servers
 Prepend name servers to the dynamically generated list.
 You should set this to 127.0.0.1 if you use a local name server other than
 libc.
+.It Sy resolv_conf_passthrough
+When set to YES the latest resolv.conf is written to
+.Sy resolv_conf
+without any alteration.
 .El
 .Sh SUBSCRIBER OPTIONS
 openresolv ships with subscribers for the name servers
@@ -81,14 +94,18 @@ to write the configuration files for the name server to include.
 Set this to the same file that the dnsmasq configuaration option
 .Sy conf-file
 points to.
+This file tells dnsmasq which nameservers to use for specific domains.
 .It Sy dnsmasq_resolv
 Set this to the same file that the dnsmasq configuaration option
 .Sy resolv-file
 points to.
+This file tells dnsmasq which nameservers to use for global lookups.
 .It Sy named_options
 Include this file in the named options block.
+This file tells named which nameservers to use for global lookups.
 .It Sy named_zones
 Include this file in the named global scope, after the options block.
+This file tells named which nameservers to use for specific domains.
 .El
 .Sh SEE ALSO
 .Xr resolv.conf 5 ,