summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2007-01-01 17:20:56 +0000
committerLennart Poettering <lennart@poettering.net>2007-01-01 17:20:56 +0000
commit07ca940dc0ab9caa1b9fe18a864697524e05db58 (patch)
tree9518490a2afdeba5f7f0d45fb6fe715ca6729759
parenta0a0e89e6fb1f27c77d931567abe95a4c70a3184 (diff)
update docs for 0.9
git-svn-id: file:///home/lennart/svn/public/nss-mdns/trunk@107 0ee8848e-81ea-0310-a63a-f631d1a40d77
-rw-r--r--doc/README.html.in57
1 files changed, 43 insertions, 14 deletions
diff --git a/doc/README.html.in b/doc/README.html.in
index 6a9ea44..01adfa2 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -10,7 +10,7 @@
<body>
<h1><a name="top">nss-mdns @PACKAGE_VERSION@</a></h1>
-<p><i>Copyright 2004-2006 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>
+<p><i>Copyright 2004-2007 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>
<ul class="toc">
<li><a href="#license">License</a></li>
@@ -42,13 +42,38 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
<h2><a name="news">News</a></h2>
+<div class="news-date">Mon Jan 1 2007: </div>
+
+<p class="news-text"><a
+href="@PACKAGE_URL@nss-mdns-0.9.tar.gz">Version 0.9</a>
+released. Changes include: Make most shared library symbols private to
+not conflict with any symbols of the program we're loaded into. Fix a
+potential endless loop in the mDNS packet parsing code.</p>
+
+<p class="news-text"><b>Please note that due to security reasons from
+this release on the minimal mDNS stack included in <tt>nss-mdns</tt>
+(dubbed "legacy") is no longer built by default. Thus,
+<tt>nss-mdns</tt> will not work unless <a
+href="http://avahi.org/">Avahi</a> is running! That makes Avahi
+essentially a hard dependency of <tt>nss-mdns</tt>. Pass
+<tt>--enable-legacy</tt> to reenable the mini mDNS stack again. Please
+note as well that this release does not honour
+<tt>/etc/resolv.conf</tt> domain search lists by default anymore. It
+created a lot of problems and was never recommended anyway. You may
+reenable this functionality by passing
+<tt>--enable-search-domains</tt>.</b></p>
+
<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 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>
+Avahi.</p>
+
+<p class="news-text"><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>
<div class="news-date">Sat Nov 19 2005: </div> <p class="news-text"><a
href="@PACKAGE_URL@nss-mdns-0.7.tar.gz">Version 0.7</a>
@@ -60,7 +85,7 @@ situations properly; if multiple addresses are assigned to the same interface ma
href="@PACKAGE_URL@nss-mdns-0.6.tar.gz">Version 0.6</a>
released. Changes include: honour search list in
<tt>/etc/resolv.conf</tt>; try to contact <a
-href="http://www.freedesktop.org/Software/Avahi">Avahi</a> for
+href="http://avahi.org/">Avahi</a> for
resolving.</p>
<div class="news-date">Sat Jun 4 2005: </div> <p class="news-text"><a
@@ -101,24 +126,28 @@ name resolution by common Unix/Linux programs in the ad-hoc mDNS domain <tt>.loc
<p><tt>nss-mdns</tt> provides client functionality only, which
means that you have to run a mDNS responder daemon seperately
from <tt>nss-mdns</tt> if you want to register the local host name via
-mDNS. I recommend <a href="http://www.freedesktop.org/Software/Avahi">Avahi</a>.</p>
+mDNS. I recommend <a href="http://avahi.org/">Avahi</a>.</p>
-<p><tt>nss-mdns</tt> is very lightweight (24 KByte stripped binary
+<p><tt>nss-mdns</tt> is very lightweight (9 KByte stripped binary
<tt>.so</tt> compiled with <tt>-DNDEBUG=1 -Os</tt> on i386, <tt>gcc</tt>
4.0), has no dependencies besides the <tt>glibc</tt> and requires only
minimal configuration.</p>
-<p>Optionally <tt>nss-mdns</tt> can try to contact a running <a
-href="http://www.freedesktop.org/Software/Avahi">avahi-daemon</a> to
-make use of its superior record cacheing.</p>
+<p>By default <tt>nss-mdns</tt> tries to contact a running <a
+href="http://avahi.org/">avahi-daemon</a> for resolving host names and
+addresses and making use of its superior record cacheing. Optionally
+<tt>nss-mdns</tt> can be compiled with a mini mDNS stack that can be
+used to resolve host names without a local Avahi installation. Both
+Avahi support and this mini mDNS stack are optional, however at least one
+of them needs to be enabled. If both are enabled a connection to Avahi is
+tried first, and if that fails the mini mDNS stack is used.</p>
<h2><a name="status">Current Status</a></h2>
<p>It works!</p>
-<p>Although <tt>nss-mdns</tt> supports resolving IPv6 addresses it does
-so via IPv4 multicasts only. (Unless, of course, it finds a running
-Avahi daemon which supports IPv6 properly.)</p>
+<p>If the mini MDNS stack is used, <tt>nss-mdns</tt> supports resolving IPv6 addresses but does
+so via IPv4 multicasts only. If Avahi is used for resolving IPv6 is supported properly.</p>
<h2><a name="documentation">Documentation</a></h2>
@@ -214,14 +243,14 @@ contents is read: </p>
mDNS.</p>
<p>If the configuration file is existent but empty, mDNS name lookups
-are disabled completely.</p>
+are disabled completely. Please note that usually mDNS is not used for anything but <tt>.local</tt>, hence you usually don't want to touch this file.</p>
<h2><a name="requirements">Requirements</a></h2>
<p>Currently, <tt>nss-mdns</tt> is tested on Linux only. A fairly
modern <tt>glibc</tt> installation with development headers (2.0 or
newer) is required. Not suprisingly <tt>nss-mdns</tt> requires a
-kernel compiled with IPv4 multicasting support enabled.</p>
+kernel compiled with IPv4 multicasting support enabled. <a href="http://avahi.org/">Avahi</a> is recommended for its superior cacheing capabilities and for security reasons. Unless you compile <tt>nss-mdns</tt> with <tt>--enable-legacy</tt> Avahi is a hard dependency when <tt>nss-mdns</tt> is used, however not a build-time requirement.</p>
<p><tt>nss-mdns</tt> was developed and tested on Debian GNU/Linux
"testing" from December 2004, it should work on most other Linux
@@ -260,7 +289,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;, April 2006</address>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, January 2007</address>
<div class="grey"><i>$Id$</i></div>
</body>