From 6e7b4e60d5cbbc34b99b6a4cb3e22d061e1843a7 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 7 Jan 2005 20:34:53 +0000 Subject: * 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 --- doc/Makefile.am | 36 +++++++++++++++ doc/README.html.in | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/style.css | 34 ++++++++++++++ 3 files changed, 198 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/README.html.in create mode 100644 doc/style.css (limited to 'doc') 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 @@ + + + + + +libasyncns @PACKAGE_VERSION@ + + + + +

libasyncns @PACKAGE_VERSION@

+ +

Copyright 2004 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

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.

+ +

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.

+ +

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.

+ +

News

+ +
Fri 7 Jan 2005:

Version 0.1 released

+ +

Overview

+ +

libasyncns is a C library for Linux/Unix for executing name +service queries asynchronously. It is an asynchronous wrapper around +getaddrinfo(3) and getnameinfo(3) from the +libc.

+ +

In contrast to GNU's asynchronous name resolving API +getaddrinfo_a(), libasyncns 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.

+ +

In contrast to asynchronous DNS resolving libraries like libdenise, skadns, adns, +libasyncns is just an asynchronous wrapper around the libc's +synchronous getaddrinfo() API, which has the advantage of +allowing name resolution using techniques like Multicast +DNS, LDAP or NIS using standard libc NSS (Name Service +Switch) modules. libasyncns is compatible with IPv6 if the +underlying libc is too.

+ +

libasyncns is very tiny, consisting just of one header and one source file. It has no dependencies besides a libc.

+ +

Status

+ +

Version @PACKAGE_VERSION@ is quite stable and feature complete.

+ +

Documentation

+ +

You may browse the Doxygen +generated programing +documentation the API. (Run make doxygen to generate this +documentation from the source tree)

+ +

Requirements

+ +

Currently, libasyncns is tested on Linux only.

+ +

libasyncns 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.

+ +

libasyncns has no dependencies besides a libc that supports getaddrinfo().

+ +

Installation

+ +

As this package is made with the GNU autotools you should run +./configure inside the distribution directory for configuring +the source tree. After that you should run make for +compilation and make install (as root) for installation of +libasyncns.

+ +

Acknowledgements

+ +

None so far

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

Get libasyncns's development sources from the Subversion repository (viewcvs):

+ +
svn checkout svn://seth.intheinter.net/libasyncns/trunk libasyncns
+ +

If you want to be notified whenever I release a new version of this software use the subscription feature of Freshmeat.

+ +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, January 2005
+
$Id$
+ + + 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; } -- cgit