diff options
author | Lennart Poettering <lennart@poettering.net> | 2005-01-07 20:34:53 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2005-01-07 20:34:53 +0000 |
commit | 6e7b4e60d5cbbc34b99b6a4cb3e22d061e1843a7 (patch) | |
tree | ac8fc89d5be15ab8cbf7f88874c48132a0ae4035 /doc | |
parent | 4c4420d73c00d8f50fdc54c8e68977d9e2d59742 (diff) |
* add documentation
* add SVN ids
* add doxygen stuff
* gcc 2.95 compat
* add LICENSE
* complete autoconf/autotools setup
* cleanup example
* fix asyncns_wait()
* cope with prctl() failing
git-svn-id: file:///home/lennart/svn/public/libasyncns/trunk@10 cc0fb855-19ed-0310-866e-8c1d96e4abae
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 36 | ||||
-rw-r--r-- | doc/README.html.in | 128 | ||||
-rw-r--r-- | doc/style.css | 34 |
3 files changed, 198 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..d11d5f2 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,36 @@ +# $Id$ + +# This file is part of libasyncns. +# +# libasyncns is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# libasyncns 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 GNU +# General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with libasyncns; if not, write to the Free Software Foundation, +# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + +noinst_DATA = README.html README +EXTRA_DIST = $(noinst_DATA) style.css README.html.in + +MAINTAINERCLEANFILES = README.html +CLEANFILES = + +if USE_LYNX +README: README.html + lynx --dump $^ | sed 's,file://localhost/.*/doc/README.html,README,' > $@ + +CLEANFILES += README +endif + +tidy: README.html + tidy -qe < README.html ; true + +.PHONY: tidy + diff --git a/doc/README.html.in b/doc/README.html.in new file mode 100644 index 0000000..7514ec5 --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,128 @@ +<?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- --> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + +<head> +<title>libasyncns @PACKAGE_VERSION@</title> +<link rel="stylesheet" type="text/css" href="style.css" /> +</head> + +<body> +<h1><a name="top">libasyncns @PACKAGE_VERSION@</a></h1> + +<p><i>Copyright 2004 Lennart Poettering <@PACKAGE_BUGREPORT@></i></p> + +<ul class="toc"> + <li><a href="#license">License</a></li> + <li><a href="#news">News</a></li> + <li><a href="#overview">Overview</a></li> + <li><a href="#status">Status</a></li> + <li><a href="#documentation">Documentation</a></li> + <li><a href="#requirements">Requirements</a></li> + <li><a href="#installation">Installation</a></li> + <li><a href="#acks">Acknowledgements</a></li> + <li><a href="#download">Download</a></li> +</ul> + +<h2><a name="license">License</a></h2> + +<p>This program is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 2 of the +License, or (at your option) any later version.</p> + +<p>This program 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 GNU +Lesser General Public License for more details.</p> + +<p>You should have received a copy of the GNU Lesser General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p> + +<h2><a name="news">News</a></h2> + +<div class="news-date">Fri 7 Jan 2005: </div> <p class="news-text"><a +href="@PACKAGE_URL@libasyncns-0.1.tar.gz">Version 0.1</a> released</p> + +<h2><a name="overview">Overview</a></h2> + +<p><tt>libasyncns</tt> is a C library for Linux/Unix for executing name +service queries asynchronously. It is an asynchronous wrapper around +<tt>getaddrinfo(3)</tt> and <tt>getnameinfo(3)</tt> from the +<tt>libc</tt>.</p> + +<p>In contrast to GNU's asynchronous name resolving API +<tt>getaddrinfo_a()</tt>, <tt>libasyncns</tt> does not make use of +UNIX signals for reporting completion of name queries. Instead, the +API exports a standard UNIX file descriptor which may be integerated +cleanly into custom main loops.</p> + +<p>In contrast to asynchronous DNS resolving libraries like <tt><a +href="http://libdenise.sourceforge.net/">libdenise</a></tt>, <tt><a +href="http://www.skarnet.org/software/skadns/">skadns</a></tt>, <tt><a +href="http://www.chiark.greenend.org.uk/~ian/adns/">adns</a></tt>, +<tt>libasyncns</tt> is just an asynchronous wrapper around the libc's +synchronous <tt>getaddrinfo()</tt> API, which has the advantage of +allowing name resolution using techniques like <a +href="http://0pointer.de/lennart/projects/nss-mdns/">Multicast +DNS</a>, LDAP or NIS using standard <tt>libc</tt> NSS (Name Service +Switch) modules. <tt>libasyncns</tt> is compatible with IPv6 if the +underlying <tt>libc</tt> is too.</p> + +<p><tt>libasyncns</tt> is very tiny, consisting just of one header and one source file. It has no dependencies besides a <tt>libc</tt>.</p> + +<h2><a name="status">Status</a></h2> + +<p>Version @PACKAGE_VERSION@ is quite stable and feature complete.</p> + +<h2><a name="documentation">Documentation</a></h2> + +<p>You may browse the <a href="http://www.doxygen.org/">Doxygen</a> +generated <a +href="http://0pointer.de/lennart/projects/libasyncns/doxygen/">programing +documentation</a> the API. (Run <tt>make doxygen</tt> to generate this +documentation from the source tree)</p> + +<h2><a name="requirements">Requirements</a></h2> + +<p>Currently, <tt>libasyncns</tt> is tested on Linux only.</p> + +<p><tt>libasyncns</tt> was developed and tested on Debian GNU/Linux +"testing" from January 2005, it should work on most other Linux +distributions (and maybe Unix versions) since it uses GNU autoconf and +GNU libtool for source code configuration and shared library +management.</p> + +<p><tt>libasyncns</tt> has no dependencies besides a <tt>libc</tt> that supports <tt>getaddrinfo()</tt>.</p> + +<h2><a name="installation">Installation</a></h2> + +<p>As this package is made with the GNU autotools you should run +<tt>./configure</tt> inside the distribution directory for configuring +the source tree. After that you should run <tt>make</tt> for +compilation and <tt>make install</tt> (as root) for installation of +<tt>libasyncns</tt>.</p> + +<h2><a name="acks">Acknowledgements</a></h2> + +<p>None so far</p> + +<h2><a name="download">Download</a></h2> + +<p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p> + +<p>The current release is <a href="@PACKAGE_URL@libasyncns-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p> + +<p>Get <tt>libasyncns</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://seth.intheinter.net/libasyncns">repository</a> (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=libasyncns">viewcvs</a>): </p> + +<pre>svn checkout svn://seth.intheinter.net/libasyncns/trunk libasyncns</pre> + +<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/libasyncns/">Freshmeat</a>.</p> + +<hr/> +<address class="grey">Lennart Poettering <@PACKAGE_BUGREPORT@>, January 2005</address> +<div class="grey"><i>$Id$</i></div> + +</body> +</html> diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..e6b3e21 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,34 @@ +/* $Id$ */ + +/*** + * This file is part of libasyncns. + * + * libasyncns is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * libasyncns 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 GNU + * General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with libasyncns; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + ***/ + +body { color: black; background-color: white; margin: 0.5cm; } +a:link, a:visited { color: #900000; } +p { margin-left: 0.5cm; margin-right: 0.5cm; } +div.news-date { margin-left: 0.5cm; font-size: 80%; color: #4f0000; } +p.news-text { margin-left: 1cm; } +h1 { color: #00009F; } +h2 { color: #00009F; } +h3 { color: #00004F; margin-left: 0.5cm; } +ul { margin-left: .5cm; } +ol { margin-left: .5cm; } +pre { margin-left: .5cm; background-color: #f0f0f0; padding: 0.4cm;} +.grey { color: #afafaf; } +table { margin-left: 1cm; border:1px solid lightgrey; padding: 0.2cm; } +td { padding-left:10px; padding-right:10px; } |