chiark / gitweb /
.gitignore: add addrtext_s, remove non-built dynamic local tests
[adns.git] / README
diff --git a/README b/README
index 4977a02..00c8140 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
 
                                    GNU adns
-
+                                       
    Advanced, easy to use, asynchronous-capable DNS client library and
    utilities.
-
+   
    adns is a resolver library for C (and C++) programs, and a collection
    of useful DNS resolver utilities.
-
+   
 C library
 
    In contrast with the standard interfaces, gethostbyname et al and
@@ -38,7 +38,7 @@ C library
        TCP in case of long replies or queries, or to other nameservers if
        several are available. It has sensible handling of bad responses
        etc.
-
+       
 DNS utility programs
 
    adns also comes with a number of utility programs for use from the
@@ -54,37 +54,49 @@ DNS utility programs
        general-purpose DNS helper program for scripting languages which
        can invoke and communicate with subprocesses. See the [1]adnshost
        usage message for a summary of its capabilities.
-
+       
+Forthcoming:
+
+   I hope that future versions may also have the following features:
+     * 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.
+     * IPv6 support.
+     * Some kind of awareness of DNSSEC.
+     * Possibly some very limited caching behaviour.
+     * There was, at one point, a draft native Perl interface from Tony
+       Finch.
+       
 Documentation
 
    I'm afraid there is no manual yet. However, competent C programmers
    should be able to use the library based on the [2]commented adns.h
    header file, and the usage messages for the programs should be
    sufficient.
-
+   
 Feedback
 
    I'd be pleased if you would let me know if you're using my library in
    your project, and what you think of it.
-
+   
    If you are subscribed to adns-discuss please send feedback, including
    bug reports, there; otherwise send mail to
    adns-bugreports@chiark.greenend.org.uk. If you'd prefer that your
    message wasn't forwarded to the adns-bugreports list, send it to
    adns-maint@chiark.greenend.org.uk.
-
+   
 Mailinglists
 
    I have set up mailinglists adns-announce and adns-discuss. 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.
-
+   
    There are [3]archives and subscription web pages, or you can subscribe
    by sending mail containing the word `subscribe' to
    adns-announce-REQUEST@chiark.greenend.org.uk or
    adns-discuss-REQUEST@chiark.greenend.org.uk.
-
+   
 Download
 
    Available for download from [4]chiark.greenend.org.uk are:
@@ -92,56 +104,65 @@ Download
      * [6]adns.h API header file with comments, and [7]usage message for
        adnshost (currently there is no manual, sorry).
      * All versions released so far are also available via [8]anonymous
-       FTP and [9]HTTP,
-     * A mirror of my CVS repository is available via rsync from
+       FTP and [9]HTTP.
+       
+   You can also access the project CVS repositories:
+     * A mirror of the source code repository is available via rsync from
        rsync.chiark.greenend.org.uk::ftp/users/ian/cvs-pub/adns (use FTP
        first to find your way around), or via [10]cvsweb.
-
-   adns is also available from the [11]GNU Project FTP servers and their
-   [12]mirrors.
-
+     * This web page is maintained in [11]Savannah, where you can browse
+       the [12]webpage CVS.
+       
+   adns is also available from the [13]GNU Project FTP servers and their
+   [14]mirrors.
+   
 Technical note
 
-   adns requires a real nameserver like [13]BIND or [14]Dents running on
+   adns requires a real nameserver like [15]BIND or [16]Dents 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.
-
+   
 References and related projects
 
-   There is a [15]port to MS Visual Studio 6 C++ by Jarle Aase.
-
+     * [17]Python bindings by Andy Dustman.
+     * [18]Haskell bindings by Peter Simons.
+     * [19]liboop event loop library (by Dan Egnor) has a built-in
+       binding for adns.
+     * [20]port to MS Visual Studio 6 C++ by Jarle Aase.
+       
 Copyright and licensing
 
-   adns is Copyright 1997-2000 Ian Jackson, Copyright 1999-2000 Tony
-   Finch, and Copyright (C) 1991 Massachusetts Institute of Technology.
-
+   adns is Copyright 1997-2000,2003,2006 Ian Jackson, Copyright
+   1999-2000,2003,2006 Tony Finch, and Copyright (C) 1991 Massachusetts
+   Institute of Technology.
+   
    adns 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 your
    option) any later version.
-
+   
    This program and documentation is distributed in the hope that it will
    be useful, but without any warranty; without even the implied warranty
    of merchantability or fitness for a particular purpose. See the
-   [16]GNU General Public License for more details.
-
+   [21]GNU General Public License for more details.
+   
    You should have received a copy of the GNU General Public License
    along with adns, or one should be available above; if not, write to
-   the [17]Free Software Foundation, 59 Temple Place - Suite 330, Boston,
+   the [22]Free Software Foundation, 59 Temple Place - Suite 330, Boston,
    MA 02111-1307, USA, or email adns-maint@chiark.greenend.org.uk.
      _________________________________________________________________
-
-   [18]Ian Jackson / [19]adns-maint@chiark.greenend.org.uk; more [20]free
+   
+   [23]Ian Jackson / [24]adns-maint@chiark.greenend.org.uk; more [25]free
    software by me.
-
-   [21]GNU home page; [22]chiark home page; [23]site or mirror home page
-
-   This web page is Copyright (C)1996-2000 Ian Jackson. See the
-   [24]Copyright/acknowledgements.
-
-   Use any browser - [25]Campaign for a non-browser-specific WWW
+   
+   [26]GNU home page; [27]chiark home page; [28]site or mirror home page
+   
+   This web page is Copyright (C)1996-2005 Ian Jackson. See the
+   [29]Copyright/acknowledgements.
+   
+   Use any browser - [30]Campaign for a non-browser-specific WWW
 
 References
 
@@ -155,18 +176,23 @@ References
    8. ftp://ftp.chiark.greenend.org.uk/users/ian/adns/
    9. http://www.chiark.greenend.org.uk/~ian/adns/ftp/
   10. http://www.chiark.greenend.org.uk/ucgi/~ijackson/cvsweb/adns/
-  11. http://www.gnu.org/
-  12. http://www.gnu.org/order/ftp.html
-  13. http://www.isc.org/view.cgi?/products/BIND/index.phtml
-  14. http://www.dents.org/
-  15. http://adns.jgaa.com/
-  16. http://www.chiark.greenend.org.uk/~ian/COPYING.txt
-  17. http://www.fsf.org/
-  18. http://www.chiark.greenend.org.uk/
-  19. mailto:adns-maint@chiark.greenend.org.uk
-  20. http://www.chiark.greenend.org.uk/~ian/software/
-  21. http://www.gnu.org/
-  22. http://www.chiark.greenend.org.uk/
-  23. file://localhost/
-  24. http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html
-  25. http://www.anybrowser.org/campaign/
+  11. http://savannah.gnu.org/
+  12. http://savannah.gnu.org/cgi-bin/viewcvs/software/adns/?cvsroot=www.gnu.org
+  13. http://www.gnu.org/
+  14. http://www.gnu.org/order/ftp.html
+  15. http://www.isc.org/view.cgi?/products/BIND/index.phtml
+  16. http://www.dents.org/
+  17. http://dustman.net/andy/python/adns-python
+  18. http://cryp.to/hsdns/
+  19. http://liboop.ofb.net/ref
+  20. http://adns.jgaa.com/
+  21. http://www.chiark.greenend.org.uk/~ian/COPYING.txt
+  22. http://www.fsf.org/
+  23. http://www.chiark.greenend.org.uk/
+  24. mailto:adns-maint@chiark.greenend.org.uk
+  25. http://www.chiark.greenend.org.uk/~ian/software/
+  26. http://www.gnu.org/
+  27. http://www.chiark.greenend.org.uk/
+  28. file://localhost/
+  29. http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html
+  30. http://www.anybrowser.org/campaign/