final documentation cleanups

git-svn-id: file:///home/lennart/svn/public/nss-mdns/trunk@96 0ee8848e-81ea-0310-a63a-f631d1a40d77

1 files changed, 30 insertions, 12 deletions

diff --git a/doc/README.html.in b/doc/README.html.in
index 5dbfd85..5ccf8fa 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -42,10 +42,10 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
 
 <h2><a name="news">News</a></h2>
 
-<div class="news-date">Fri Apr 28 2006: </div> <p class="news-text"><a
+<div class="news-date">Sat Apr 29 2006: </div> <p class="news-text"><a
 href="@PACKAGE_URL@nss-mdns-0.8.tar.gz">Version 0.8</a>
-released. Changes include: Build time option to disable legacy mDNS
-request, i.e. resolve exclusively with Avahi; buil a special
+released. Changes include: Build time option to disable "legacy unicast" mDNS
+requests, i.e. resolve exclusively with Avahi; build a special
 <tt>_minimal</tt> flavour of the shared objects to minimize
 unnecessary name lookup timeouts; fix IPv6 resolving when using
 Avahi; <b>Please note that starting with nss-mdns 0.8 we encourage you to use a different <tt>/etc/nsswitch.conf</tt> configuration line. See below for more information!</b></p>
@@ -122,11 +122,17 @@ Avahi daemon which supports IPv6 properly.)</p>
 
 <h2><a name="documentation">Documentation</a></h2>
 
-<p>After compiling and installing <tt>nss-mdns</tt> you'll find three
+<p>After compiling and installing <tt>nss-mdns</tt> you'll find six
 new NSS modules in <tt>/lib</tt>:</p>
-<ul><li><tt>libnss_mdns.so.2</tt></li>
+<ul>
+<li><tt>libnss_mdns.so.2</tt></li>
 <li><tt>libnss_mdns4.so.2</tt></li>
-<li><tt>libnss_mdns6.so.2</tt></li></ul> <p><tt>libnss_mdns.so.2</tt>
+<li><tt>libnss_mdns6.so.2</tt></li>
+<li><tt>libnss_mdns_minimal.so.2</tt></li>
+<li><tt>libnss_mdns4_minimal.so.2</tt></li>
+<li><tt>libnss_mdns6_minimal.so.2</tt></li>
+</ul>
+<p><tt>libnss_mdns.so.2</tt>
 resolves both IPv6 and IPv4 addresses, <tt>libnss_mdns4.so.2</tt> only
 IPv4 addresses and <tt>libnss_mdns6.so.2</tt> only IPv6 addresses. Due
 to the fact that most mDNS responders only register local IPv4
@@ -137,10 +143,22 @@ situation causes long timeouts when resolving hosts since most modern
 Unix/Linux applications check for IPv6 addresses first, followed by a
 lookup for IPv4.</p>
 
+<p><tt>libnss_mdns{4,6,}_minimal.so</tt> (new in version 0.8) is mostly identical to the
+versions without <tt>_minimal</tt>. However, they differ in one
+way. The minimal versions will always deny to resolve host names that
+don't end in <tt>.local</tt> or addresses that aren't in the range
+<tt>169.254.x.x</tt> (the range used by <a
+href="http://files.zeroconf.org/rfc3927.txt">IPV4LL/APIPA/RFC3927</a>.)
+Combining the <tt>_minimal</tt> and the normal NSS modules allows us
+to make mDNS authoritative for ZeroConf host names and addresses (and
+thus creating no extra burden on DNS servers with always failing
+requests) and use it as fallback for everything else.</p>
+
 <p>To activate one of the NSS modules you have to edit
-<tt>/etc/nsswitch.conf</tt> and add <tt>mdns4</tt>
-(resp. <tt>mdns</tt>, <tt>mdns6</tt>) to the line starting with
-"<tt>hosts:</tt>". On Debian this looks like this:</p>
+<tt>/etc/nsswitch.conf</tt> and add <tt>mdns4</tt> and
+<tt>mdns4_minimal</tt> (resp. <tt>mdns</tt>, <tt>mdns6</tt>) to the
+line starting with "<tt>hosts:</tt>". On Debian this looks like
+this:</p>
 
 <pre># /etc/nsswitch.conf
 
@@ -148,7 +166,7 @@ passwd:         compat
 group:          compat
 shadow:         compat
 
-hosts:          files dns <b>mdns4</b>
+hosts:          files <b>mdns4_minimal [NOTFOUND=return]</b> dns <b>mdns4</b>
 networks:       files
 
 protocols:      db files
@@ -219,7 +237,7 @@ compilation and <tt>make install</tt> (as root) for installation of
 
 <h2><a name="acks">Acknowledgements</a></h2>
 
-<p>SHIROYAMA Takayuki for a patch.</p>
+<p>SHIROYAMA Takayuki, Anand Kumria and Bastien Nocera for patches.</p>
 
 <p>Sean Meiners for search list support.</p>
 
@@ -240,7 +258,7 @@ compilation and <tt>make install</tt> (as root) for installation of
 <p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/nss-mdns/">Freshmeat</a>.</p>
 
 <hr/>
-<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, Nov 2005</address>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, April 2006</address>
 <div class="grey"><i>$Id$</i></div>
 
 </body>