chiark / gitweb /
Remove spurious semicolon.
[adns.git] / README
diff --git a/README b/README
index a7a6805..43d0df2 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 
-                                     adns
+                                   GNU adns
                                        
    Advanced, easy to use, asynchronous-capable DNS client library.
    
 Forthcoming:
 
    I hope that future versions may also have the following features:
-     * The library will be useable by threads in a multithreaded program
-       in a natural way. It will multiplex many threads' queries through
-       a single query socket.
-     * Limited caching behaviour.
+     * 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.
        
-   (Technical note: adns requires a real nameserver like BIND 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.)
+   (Technical note: adns requires a real nameserver like [1]BIND or
+   [2]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.)
+   
+Documentation
+
+   I'm afraid there is no manual yet. However, competent C programmers
+   should be able to use the library based on the commented [3]adns.h
+   header file (from version 0.4).
    
 Feedback
 
-   If you are subscribed to adns-discuss please send bug reports there;
-   otherwise mail them to adns-bugreports@chiark.greenend.org.uk.
+   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.greendend.org.uk.
    
 Mailinglists
 
@@ -61,19 +74,25 @@ Mailinglists
    important bugs, new versions, &c. The bug reports address mentioned
    above is also a mailing list; feel free to subscribe to it.
    
-   There are [1]archives and subscription web pages, or you can subscribe
+   There are [4]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 [2]chiark.greenend.org.uk are:
-     * The [3]current pre-release version as a gzipped tarfile.
-     * All released versions are also available via [4]anonymous FTP.
+   Available for download from [5]chiark.greenend.org.uk are:
+     * The [6]current pre-release version as a gzipped tarfile.
+     * [7]adns.h API header file with comments (currently there is no
+       manual, sorry).
+     * All versions released so far are also available via [8]anonymous
+       FTP.
+     * A mirror of my CVS 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).
        
-   adns is also available from the GNU Project FTP servers and their
-   mirrors.
+   adns is also available from the [9]GNU Project FTP servers and their
+   [10]mirrors.
    
 Copyright and licensing
 
@@ -86,37 +105,44 @@ Copyright and licensing
    
    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 [5]GNU
-   General Public License for more details.
+   of merchantability or fitness for a particular purpose. See the
+   [11]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 [6]Free Software Foundation, 59 Temple Place - Suite 330, Boston,
+   the [12]Free Software Foundation, 59 Temple Place - Suite 330, Boston,
    MA 02111-1307, USA, or email adns-maint@chiark.greenend.org.uk.
      _________________________________________________________________
    
-   [7]Ian Jackson / [8]adns-maint@chiark.greenend.org.uk; more [9]free
+   [13]Ian Jackson / [14]adns-maint@chiark.greenend.org.uk; more [15]free
    software by me.
    
-   [10]GNU home page; [11]site or mirror home page
+   [16]GNU home page; [17]chiark home page; [18]site or mirror home page
    
    This web page is Copyright (C)1996-1999 Ian Jackson. See the
-   [12]Copyright/acknowledgements.
+   [19]Copyright/acknowledgements.
    
-   Use any browser - [13]Campaign for a non-browser-specific WWW
+   Use any browser - [20]Campaign for a non-browser-specific WWW
 
 References
 
-   1. http://www.chiark.greenend.org.uk/mailman/listinfo
-   2. http://www.chiark.greenend.org.uk/
-   3. http://www.chiark.greenend.org.uk/~ian/adns/adns.tar.gz
-   4. ftp://ftp.chiark.greenend.org.uk/users/ian/userv/
-   5. http://www.chiark.greenend.org.uk/~ian/COPYING.txt
-   6. http://www.fsf.org/
-   7. http://www.chiark.greenend.org.uk/
-   8. mailto:adns-maint@chiark.greenend.org.uk
-   9. http://www.chiark.greenend.org.uk/~ian/software/
-  10. http://www.gnu.org/
-  11. http://www.chiark.greenend.org.uk/
-  12. http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html
-  13. http://www.anybrowser.org/campaign/
+   1. http://www.isc.org/view.cgi?/products/BIND/index.phtml
+   2. http://www.dents.org/
+   3. http://www.chiark.greenend.org.uk/~ian/adns/adns.h.0.4.txt
+   4. http://www.chiark.greenend.org.uk/mailman/listinfo
+   5. http://www.chiark.greenend.org.uk/~ian/adns/
+   6. http://www.chiark.greenend.org.uk/~ian/adns/adns.tar.gz
+   7. http://www.chiark.greenend.org.uk/~ian/adns/adns.h.0.5.txt
+   8. ftp://ftp.chiark.greenend.org.uk/users/ian/adns/
+   9. http://www.gnu.org/
+  10. http://www.gnu.org/order/ftp.html
+  11. http://www.chiark.greenend.org.uk/~ian/COPYING.txt
+  12. http://www.fsf.org/
+  13. http://www.chiark.greenend.org.uk/
+  14. mailto:adns-maint@chiark.greenend.org.uk
+  15. http://www.chiark.greenend.org.uk/~ian/software/
+  16. http://www.gnu.org/
+  17. http://www.chiark.greenend.org.uk/
+  18. http://www.chiark.greenend.org.uk/
+  19. http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html
+  20. http://www.anybrowser.org/campaign/