chiark / gitweb /
Fix bugs.
[chiark-utils.git] / scripts / named-conf.8
index 4b41c02255bf24109d3d5685c80766ff58d21913..89833a1392e9a56e32d5f85529409e0c13c6e028 100644 (file)
@@ -50,30 +50,24 @@ Use
 .I config\-file
 instead of
 .BR /etc/bind/chiark-conf-gen.zones .
+Also changes the default directory.
 .TP
-.BR \-q | \-\-quiet
-Do not print any information about zone(s) which do not have warnings.
-.TP
-.BR \-l | \-\-local
-Only checks for mistakes which are the responsibility of the local
-administrator.  This means that for secondary and stealth zones we
-only check that we're slaving from the right place.  For primary zones
-all checks are still done, unless the
-.B \-l
-option is repeated.  It is a mistake to specify
-.B \-l
-with foreign zones (zones supplied explictly on the command line but
-not relevant to the local server), so this counts as a warning.
-.TP
-.BR \-v | \-\-verbose
-Print additional information about each zone.
+.BR \-D
+Enables debugging.  Useful for debugging chiark\-named\-conf, but
+probably not useful for debugging your DNS configuration.  Repeat to
+increase the debugging level.  (Maximum is
+.BR -DD .)
 .TP
-.BR \-g | \-\-glueless-ok
-Do not warn about glueless referrals.  Not recommended.  Note that
-glueless referrals usually causes extra delays looking up names, and
-can cause lookups to fail even if in theory they could succeed.  There
-is no generally agreed convention or standard for avoiding circular
-glueless situations such as
+.BR \-g | \-\-glueless
+Warn only once about a glueless referral for each zone and server,
+rather than once for each parent which gave out a referral without
+glue.
+
+When repeated, do not warn about glueless referrals at all.  Not
+recommended.  Note that glueless referrals usually cause extra delays
+looking up names, and can make lookups fail even if in theory they
+could succeed.  There is no generally agreed convention or standard
+for avoiding circular glueless situations such as
 .br
 .B example.com NS ns0.example.net.uk
 .br
@@ -87,9 +81,20 @@ where gluelessness would completely prevent lookups inside
 example.net.uk and example.com.  The best way to be sure to avoid this
 is to avoid gluelessness.
 .TP
-.BR \-D
-Enables debugging.  Useful for debugging chiark\-named\-conf, but
-probably not useful for debugging your DNS configuration.
+.BR \-l | \-\-local
+Only checks for mistakes which are the responsibility of the local
+administrator.  This means that for secondary and stealth zones we
+only check that we're slaving from the right place.  For primary zones
+all checks are still done.  It is a mistake to specify
+.B \-l
+with foreign zones (zones supplied explictly on the command line but
+not relevant to the local server); doing so produces a warning.
+.TP
+.BR \-q | \-\-quiet
+Do not print any information about zone(s) which do not have warnings.
+.TP
+.BR \-v | \-\-verbose
+Print additional information about each zone.
 .SH USAGE
 The file
 .B /etc/bind/chiark-conf-gen.zones
@@ -231,6 +236,26 @@ zones, the address should be that of the SOA origin.  For
 .B stealth
 zones, the address should be that of the SOA origin or one of the
 published nameservers.
+.SH SECURITY
+chiark\-named\-conf is supposed to be resistant to malicious data in
+the DNS.  It is not resistant to malicious data in its own options,
+configuration file or environment.  It is not supposed to read its
+stdin, but is not guaranteed to be safe if stdin is dangerous.
+.LP
+Killing chiark-named-conf suddenly should be safe, even with
+.BR -y " or " -f
+(though of course it may not complete its task if killed), provided
+that only one invocation is made at once.
+.LP
+Slow remote nameservers will cause chiark-named-conf to take
+excessively long.
+.SH EXIT STATUS
+.TP
+.B 0
+All went well and there were no warnings.
+.TP
+any other
+There were warnings or errors.
 .SH FILES
 .TP
 .B /etc/bind/chiark-conf-gen.zones
@@ -246,6 +271,18 @@ Default output file.
 .TP
 .B /var/cache/bind/chiark-slave
 Default location for slave zones.
+.SH ENVIRONMENT
+.LP
+Setting variables used by
+.BR dig (1)
+and
+.BR adnshost (1)
+will affect the operation of chiark\-named\-conf.  
+Avoid messing with these if possible.
+.LP
+.B PATH
+Used to find subprograms such as
+.BR dig " and " adnshost .
 .SH BUGS
 The determination of the parent zone for each zone to be checked, and
 its nameservers, is done simply using the system default nameserver.