From 4b84c25d83482982b9564c43ab6671f7e4de8e63 Mon Sep 17 00:00:00 2001 Message-Id: <4b84c25d83482982b9564c43ab6671f7e4de8e63.1717404376.git.mdw@distorted.org.uk> From: Mark Wooding Date: Sun, 17 Sep 2000 01:01:11 +0000 Subject: [PATCH] More docs improvlements. Organization: Straylight/Edgeware From: ian --- README | 73 ++++++++++++++++++++++++---------------------- README.html | 76 ++++++++++++++++++++++++++---------------------- changelog | 7 +++-- settings.make.in | 4 +-- 4 files changed, 88 insertions(+), 72 deletions(-) diff --git a/README b/README index e159a8c..c18a726 100644 --- a/README +++ b/README @@ -5,9 +5,12 @@ utilities. adns is a resolver library for C (and C++) programs, and a collection - of useful DNS resolver utilities. In contrast with the existing - interfaces, gethostbyname et al and libresolv, it has the following - features: + of useful DNS resolver utilities. + +C library + + In contrast with the standard interfaces, gethostbyname et al and + libresolv, it has the following features: * It is reasonably easy to use for simple programs which just want to translate names to addresses, look up MX records, etc. * It can be used in an asynchronous, non-blocking, manner. Many @@ -93,22 +96,22 @@ Mailinglists Download Available for download from [6]chiark.greenend.org.uk are: - * The [7]current beta version as a gzipped tarfile. - * [8]adns.h API header file with comments (currently there is no - manual, sorry). - * All versions released so far are also available via [9]anonymous - FTP. + * The [7]current release as a gzipped tarfile. + * [8]adns.h API header file with comments, and [9]usage message for + adnshost (currently there is no manual, sorry). + * All versions released so far are also available via [10]anonymous + FTP and [11]HTTP, * 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), or via [10]cvsweb. + first to find your way around), or via [12]cvsweb. - adns is also available from the [11]GNU Project FTP servers and their - [12]mirrors. + adns is also available from the [13]GNU Project FTP servers and their + [14]mirrors. Copyright and licensing - adns is Copyright 1997-2000 Ian Jackson, Copyright 1999 Tony Finch, - and Copyright (C) 1991 Massachusetts Institute of Technology. + adns is Copyright 1997-2000 Ian Jackson, Copyright 1999-2000 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 @@ -118,27 +121,27 @@ 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 - [13]GNU General Public License for more details. + [15]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 [14]Free Software Foundation, 59 Temple Place - Suite 330, Boston, + the [16]Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, or email adns-maint@chiark.greenend.org.uk. _________________________________________________________________ - [15]Ian Jackson / [16]adns-maint@chiark.greenend.org.uk; more [17]free + [17]Ian Jackson / [18]adns-maint@chiark.greenend.org.uk; more [19]free software by me. - [18]GNU home page; [19]chiark home page; [20]site or mirror home page + [20]GNU home page; [21]chiark home page; [22]site or mirror home page This web page is Copyright (C)1996-2000 Ian Jackson. See the - [21]Copyright/acknowledgements. + [23]Copyright/acknowledgements. - Use any browser - [22]Campaign for a non-browser-specific WWW + Use any browser - [24]Campaign for a non-browser-specific WWW References - 1. http://www.chiark.greenend.org.uk/~ian/adns/usage/adnsresfilter_usage.text + 1. http://www.chiark.greenend.org.uk/~ian/adns/adnsresfilter.txt 2. http://www.isc.org/view.cgi?/products/BIND/index.phtml 3. http://www.dents.org/ 4. http://www.chiark.greenend.org.uk/~ian/adns/adns.h.txt @@ -146,17 +149,19 @@ References 6. http://www.chiark.greenend.org.uk/~ian/adns/ 7. http://www.chiark.greenend.org.uk/~ian/adns/adns.tar.gz 8. http://www.chiark.greenend.org.uk/~ian/adns/adns.h.txt - 9. ftp://ftp.chiark.greenend.org.uk/users/ian/adns/ - 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.chiark.greenend.org.uk/~ian/COPYING.txt - 14. http://www.fsf.org/ - 15. http://www.chiark.greenend.org.uk/ - 16. mailto:adns-maint@chiark.greenend.org.uk - 17. http://www.chiark.greenend.org.uk/~ian/software/ - 18. http://www.gnu.org/ - 19. http://www.chiark.greenend.org.uk/ - 20. file://localhost/ - 21. http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html - 22. http://www.anybrowser.org/campaign/ + 9. http://www.chiark.greenend.org.uk/~ian/adns/adnsresfilter.txt + 10. ftp://ftp.chiark.greenend.org.uk/users/ian/adns/ + 11. http://www.chiark.greenend.org.uk/~/ian/adns/ftp/ + 12. http://www.chiark.greenend.org.uk/ucgi/~ijackson/cvsweb/adns/ + 13. http://www.gnu.org/ + 14. http://www.gnu.org/order/ftp.html + 15. http://www.chiark.greenend.org.uk/~ian/COPYING.txt + 16. http://www.fsf.org/ + 17. http://www.chiark.greenend.org.uk/ + 18. mailto:adns-maint@chiark.greenend.org.uk + 19. http://www.chiark.greenend.org.uk/~ian/software/ + 20. http://www.gnu.org/ + 21. http://www.chiark.greenend.org.uk/ + 22. file://localhost/ + 23. http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html + 24. http://www.anybrowser.org/campaign/ diff --git a/README.html b/README.html index 6cf053e..5feab38 100644 --- a/README.html +++ b/README.html @@ -1,13 +1,6 @@ -adns - advanced, alternative, asynchronous resolver - + + +adns - advanced, alternative, asynchronous resolver @@ -16,12 +9,25 @@ 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. In contrast with the existing -interfaces, gethostbyname et al and libresolv, it has the following -features: +of useful DNS resolver utilities. + + +

C library

+ +In contrast with the standard interfaces, gethostbyname et al and +libresolv, it has the following features: -

Technical note

- -adns requires a real nameserver like -BIND -or -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 @@ -122,7 +117,7 @@ list, send it to adns-maint@chiark.greenend.org.uk. 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, &c. +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. @@ -141,13 +136,15 @@ Available for download from chiark.greenend.org.uk are: