Documentation and webpage updates

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

1 files changed, 53 insertions, 80 deletions

diff --git a/README.html b/README.html
index 86b4265..1eeee0b 100644
--- a/README.html
+++ b/README.html
@@ -37,10 +37,12 @@ to translate names to addresses, look up MX records, etc.
 queries can be handled simultaneously.
 
 <li>Responses are decoded automatically into a natural representation
-for a C program - there is no need to deal with DNS packet formats.
+for a C program - there is no need to deal with DNS packet and RRDATA
+formats.
 
 <li>Sanity checking (eg, name syntax checking, reverse/forward
-correspondence, CNAME pointing to CNAME) is performed automatically.
+correspondence, CNAME pointing to CNAME) is performed automatically
+by default.
 
 <li>Time-to-live, CNAME and other similar information is returned in
 an easy-to-use form, without getting in the way.
@@ -52,8 +54,8 @@ can have several instances of the resolver.
 <li>Errors are reported to the application in a way that distinguishes
 the various causes of failure properly.
 
-<li>Understands conventional resolv.conf, but this can overridden by
-environment variables.
+<li>adns understands conventional resolv.conf, but this can overridden
+by environment variables.
 
 <li>Flexibility.  For example, the application can tell adns to:
 ignore environment variables (for setuid programs), disable hostname
@@ -91,26 +93,6 @@ usage message</A> for a summary of its capabilities.
 
 </ul>
 
-<h2>Forthcoming:</h2>
-
-I hope that future versions may also have the following features:
-
-<ul>
-
-<li>The library should be useable by threads in a multithreaded
-program in a natural way.  It should multiplex many threads' queries
-through a single query socket.
-
-<li>IPv6 support.
-
-<li>Some kind of awareness of DNSSEC.
-
-<li>Possibly some very limited caching behaviour.
-
-<li>There was, at one point, a draft native Perl interface from Tony Finch.
-
-</ul>
-
 <h2>Documentation</h2>
 
 I'm afraid there is no manual yet.  However, competent C programmers
@@ -126,19 +108,26 @@ your project, and what you think of it.
 
 <p>
 
-If you are subscribed to <code>adns-discuss</code> please send
-feedback, including bug reports, there; otherwise send mail to
-<code>adns-bugreports@chiark.greenend.org.uk</code>.  If you'd prefer
-that your message wasn't forwarded to the <code>adns-bugreports</code>
-list, send it to <code>adns-maint@chiark.greenend.org.uk</code>.
+Bug reports should be reported to the
+<a href="http://debbugs.gnu.org/">GNU Debbugs</a>.  Send an email
+to <code>submit@debbugs.gnu.org</code> and at the top of your email,
+in a paragraph of its own, write the single line
+<pre>
+Package: adns
+</pre>
+Your bug report will be published via to the adns-discuss list.
+
+<p>
+
+Feedback and discussion takes place on the <code>adns-discuss</code>
+list.  You can mail me privately
+at <code>ijackson@chiark.greenend.org.uk</code>.
 
 <h2>Mailinglists</h2>
 
 I have set up mailinglists <code>adns-announce</code> and
 <code>adns-discuss</code>.  The announcements list is moderated and
 will contain only announcements of important bugs, new versions, etc.
-The bug reports address mentioned above is also a mailing list; feel
-free to subscribe to it.
 
 <p>
 
@@ -149,74 +138,67 @@ containing the word `subscribe' to
 <code>adns-announce-REQUEST@chiark.greenend.org.uk</code> or
 <code>adns-discuss-REQUEST@chiark.greenend.org.uk</code>.
 
-<h2>Download</h2>
+<h2>Documentation</h2>
 
-Available for download from
-<A href="http://www.chiark.greenend.org.uk/~ian/adns/">chiark.greenend.org.uk</A>
-are:
 <ul>
-<li>The <A href="http://www.chiark.greenend.org.uk/~ian/adns/adns.tar.gz">current
-    release</A> as a gzipped tarfile.
-<li><A href="http://www.chiark.greenend.org.uk/~ian/adns/adns.h.txt">adns.h</A>
-    API header file with comments, and
-    <A href="http://www.chiark.greenend.org.uk/~ian/adns/adnshost.txt">usage
-    message for adnshost</A> (currently there is no manual, sorry).
-<li>All versions released so far are also available via
-    <A href="ftp://ftp.chiark.greenend.org.uk/users/ian/adns/">anonymous
-    FTP</A> and <A href="http://www.chiark.greenend.org.uk/~ian/adns/ftp/">HTTP</A>.
+<li><A href="http://www.chiark.greenend.org.uk/~ian/adns/adns.h.txt">adns.h
+    API header file with documentation comments</A>
+<li><A href="http://www.chiark.greenend.org.uk/~ian/adns/adnshost.txt">usage
+    message for adnshost</A>
 </ul>
 
-You can also access the project CVS repositories:
+<h2>Download and source code</h2>
+
 <ul>
-<li>A mirror of the source code repository is available via rsync from
-    <code>rsync.chiark.greenend.org.uk::ftp/users/ian/cvs-pub/adns</code>
-    (use FTP first to find your way around), or via
-    <A href="http://www.chiark.greenend.org.uk/ucgi/~ijackson/cvsweb/adns/">cvsweb</A>.
-<li>This web page is maintained in
-    <A href="http://savannah.gnu.org/">Savannah</A>,
-    where you can browse the
-    <A href="http://savannah.gnu.org/cgi-bin/viewcvs/software/adns/?cvsroot=www.gnu.org">webpage CVS</A>.
+<li>The <A href="http://www.chiark.greenend.org.uk/~ian/adns/adns.tar.gz">current
+    release</A> as a gzipped tarfile.
+<li><A href="http://www.chiark.greenend.org.uk/~ian/adns/ftp/">Previous
+    versions</A>.
+<li><A href="http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git/adns.git/">master
+    git (version control) repository browser</a>.
 </ul>
 
 adns is also available from the
 <A href="http://www.gnu.org/">GNU Project</A> FTP servers and their
 <A href="http://www.gnu.org/order/ftp.html">mirrors</A>.
 
-<h2>Technical note</h2>
+<h2>Installation note</h2>
 
 adns requires a real nameserver like
 <A href="http://www.isc.org/view.cgi?/products/BIND/index.phtml">BIND</A>
-or
-<A href="http://www.dents.org/">Dents</A> running on
+running on
 the same system or a nearby one, which must be willing to provide
-`recursive service'.  I.e., adns is a `stub resolver'.  All properly
-configured UN*X and GNU systems will already have such nameserver(s);
-they are usually listed in /etc/resolv.conf.
+`recursive service'.  I.e., adns is a `stub resolver'.
+
+<p>
+adns requires that your real nameserver is on the same machine, or
+connected via a secure network, so that an attacker cannot fake the
+replies to adns's queries.
 
 <h2>References and related projects</h2>
 
 <ul>
 <li><a href="http://code.google.com/p/adns-python">Python bindings</a>
    by Andy Dustman.
-<li><a href="http://cryp.to/hsdns/">Haskell bindings</a>
-   by Peter Simons.
-<li><a href="http://liboop.ofb.net/ref">liboop event loop library</a>
-   (by Dan Egnor) has a built-in binding for adns.
+<!-- <li><a href="http://cryp.to/hsdns/">Haskell bindings</a>
+   by Peter Simons. -->
+<li><a href="http://www.lysator.liu.se/liboop/">liboop event loop library</a>
+   has a built-in binding for adns.
 <li><a href="http://adns.jgaa.com/">port to MS Visual Studio 6 C++</a>
    by Jarle Aase.
 </ul>
 
 <h2>Copyright and licensing</h2>
 
-<kbd>adns</kbd> is Copyright 1997-2000,2003,2006 Ian Jackson,
-Copyright 1999-2000,2003,2006 Tony Finch, and Copyright (C) 1991
-Massachusetts Institute of Technology.
+<kbd>adns</kbd> is Copyright 1997-2000,2003,2006,2014 Ian Jackson,
+Copyright 2014 Mark Wooding, Copyright 1999-2000,2003,2006 Tony Finch,
+and Copyright (C) 1991 Massachusetts Institute of Technology.
 
 <p>
 
 <kbd>adns</kbd> is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or (at
+the Free Software Foundation; either version 3 of the License, or (at
 your option) any later version.
 
 <p>
@@ -232,18 +214,13 @@ General Public License</A> for more details.
 
 You should have received a copy of the GNU General Public License
 along with <kbd>adns</kbd>, or one should be available above; if not,
-write to the
-<A href="http://www.fsf.org/">Free Software Foundation</A>,
-59 Temple Place - Suite 330, Boston, MA 02111-1307, USA,
-or email <code>adns-maint@chiark.greenend.org.uk</code>.
+write to the <A href="http://www.fsf.org/">Free Software Foundation</A>
+or email <code>ijackson@chiark.greenend.org.uk</code>.
 
 <p>
 
 <hr>
-<A href="http://www.chiark.greenend.org.uk/">Ian Jackson</A> / 
-<A href="mailto:adns-maint@chiark.greenend.org.uk"><tt>adns-maint@chiark.greenend.org.uk</tt></A>;
-more <A href="http://www.chiark.greenend.org.uk/~ian/software/">free
-software</A> by me.
+Ian Jackson / <tt>ijackson@chiark.greenend.org.uk</tt>.
 <p>
 
 <A href="http://www.gnu.org/">GNU home page</A>;
@@ -251,12 +228,8 @@ software</A> by me.
 <A href="/">site or mirror home page</A>
 <p>
 
-This web page is Copyright (C)1996-2005 Ian Jackson.  See the
+This web page is Copyright (C)1996-2005,2014 Ian Jackson.  See the
 <A href="http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html">Copyright/acknowledgements</A>.
-<p>
-
-Use any browser -
-<A href="http://www.anybrowser.org/campaign/">Campaign for a non-browser-specific WWW</A>
 
 </body>
 </html>