Added BLACKHOLE macro

[nsc-5.git] / README

diff --git a/README b/README
index 09d178118f307a9e74322ea0fda1d0cceb74d563..776108e27e072117b7cbadd9f2c82edf486800f7 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,15 @@
 
 

-            Domain Name Server Configuration Utilities -- NSC 2.99b
+            Domain Name Server Configuration Utilities -- NSC 3.1

 
 

-                   (c) 1997--2003 Martin Mares <mj@ucw.cz>
+                   (c) 1997--2008 Martin Mares <mj@ucw.cz>

 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 ------------------------------------------------------------------------------------
 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 ------------------------------------------------------------------------------------

-WARNING: This is a prerelease of the NSC 3.0. See NEWS for the list of changes.
-Most importantly, the configuration files are NOT compatible with the old releases.
-Also, it hasn't undergone much extensive testing yet, so there might be bugs around.
+WARNING: NSC has undergone significant changes between versions 2.3 and 2.99b.
+See NEWS for the summary of changes. Most importantly, the configuration files are
+NOT compatible with the old releases.

 ------------------------------------------------------------------------------------
 
 
 ------------------------------------------------------------------------------------
 
 


@@ -109,6 +109,9 @@ PRIMARY(zone, [extra-files...])
                concatenated to produce a single configuration). See the next
                section for a look inside these files.
 
                concatenated to produce a single configuration). See the next
                section for a look inside these files.
 

+               When the zone name contains a slash (as happens in classless
+               reverse zones), it is replaced by "@" in the cf file name.
+

 SECONDARY(zone, primary)
                Define a zone we run a secondary name server for.
                "primary" is an IP address of the primary name server.
 SECONDARY(zone, primary)
                Define a zone we run a secondary name server for.
                "primary" is an IP address of the primary name server.


@@ -136,9 +139,29 @@ REVERSE(network, primary-files...)
                You can also use the REV macro explicitly, which can be handy
                for example in SECONDARY declarations.
 
                You can also use the REV macro explicitly, which can be handy
                for example in SECONDARY declarations.
 

-CONFIG(...)    - insert user data to named.conf
+FORWARDED(zone, ip...)
+               Define a forwarding zone. All queries are forwarded to the
+               specified name servers.
+
+BLACKHOLE(zone)
+               Define an empty zone according to RFC 6303. This is usually done
+               for zones for which clients are known to erroneously ask queries
+               (e.g., reverse resolving of link-local addresses). The contents
+               served for these zones is taken from cf/blackhole.
+
+ZONE_OPTIONS(`options;
+       more options;
+')
+               Define options to be inserted to all subsequent zone declarations
+               until the next ZONE_OPTIONS command. Please keep in mind that the
+               semicolon character act as M4 comment, so you need to put the
+               closing quote at a separate line. See our example cf/domains.
+
+CONFIG(...)
+               Insert user data to named.conf, again beware of semicolons.

 
 

-MAKEFILE(...)  - insert user data to Makefile
+MAKEFILE(...)
+               Insert user data to Makefile.

 
 
 3. The Domain Files
 
 
 3. The Domain Files


@@ -220,6 +243,18 @@ ALIAS(alias...)
                Generates a series of CNAME records pointing from the aliases
                to the current host/domain.
 
                Generates a series of CNAME records pointing from the aliases
                to the current host/domain.
 

+TXT(text)
+               Specify a TXT record for the current host or domain.
+
+RP(mail, txt)
+               Specify a RP (responsible person) record for the current host or domain.
+               The first argument is a mail address in DNS notation (with `@' replaced
+               by `.' as in the SOA record), the second one is a name of a TXT record
+               with contact information.
+
+SRV(service, protocol, priority, weight, port, target)
+               Specify a SRV (service) record for the current host or domain.
+

 CNAME(src, dest)
                Generate a CNAME record -- "src" points to "dest".
 
 CNAME(src, dest)
                Generate a CNAME record -- "src" points to "dest".
 


@@ -437,5 +472,3 @@ chkdel              A simple Perl script for checking of domain delegations --
                it checks all PRIMARY and SECONDARY records in cf/domains
                against NS records. Requires the Net::DNS module and also
                some tweaking of parameters at the top of the script.
                it checks all PRIMARY and SECONDARY records in cf/domains
                against NS records. Requires the Net::DNS module and also
                some tweaking of parameters at the top of the script.

-
- LocalWords:  MINTTL NSNAME hostname MAINTNAME