path: root/doc/
diff options
authorLennart Poettering <>2004-08-20 16:22:04 +0000
committerLennart Poettering <>2004-08-20 16:22:04 +0000
commit5c2dc69ce2200739cf483b5208e51a51e8723e27 (patch)
treef967bc16c1f52dd04a0edeaf2dbdeba74c54a843 /doc/
parent7e79df122a9ac276a5ce889a0bbdb5ceb9be1f2a (diff)
add documentation
git-svn-id: file:///home/lennart/svn/public/libao-pulse/trunk@4 a8d83910-18e2-0310-866c-8ed7f9518005
Diffstat (limited to 'doc/')
1 files changed, 107 insertions, 0 deletions
diff --git a/doc/ b/doc/
new file mode 100644
index 0000000..dcb24ee
--- /dev/null
+++ b/doc/
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "">
+<html xmlns="">
+<title>libao-polyp @PACKAGE_VERSION@</title>
+<link rel="stylesheet" type="text/css" href="style.css" />
+<h1><a name="top">libao-polyp @PACKAGE_VERSION@</a></h1>
+<p><i>Copyright 2004 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</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>
+<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 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
+General Public License for more details.</p>
+<p>You should have received a copy of the GNU 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 Aug 20 2004: </div> <p class="news-text"><a
+href="@PACKAGE_URL@libao-polyp-0.1.tar.gz">Version 0.1</a> released</p>
+<h2><a name="overview">Overview</a></h2>
+<p><tt>libao-polyp</tt> is a <a href=""><tt>libao</tt></a> driver for the <a href=""><tt>polypaudio</tt></a> sound server.</p>
+<h2><a name="status">Status</a></h2>
+<p>It works, what is more to say?</p>
+<h2><a name="documentation">Documentation</a></h2>
+<p>There is not much to say. Just install this software, the driver will then be available under the name <tt>polyp</tt>.</p>
+<h2><a name="requirements">Requirements</a></h2>
+<p>Currently, <tt>libao-polyp</tt> is tested on Linux only.</p>
+<p><tt>libao-polyp</tt> was developed and tested on Debian GNU/Linux
+"testing" from July 2004, it should work on most other Linux
+distributions (and maybe Unix versions) since it uses GNU autoconf for
+source code configuration.</p>
+<p>Obviously <tt>libao-polyp</tt> requires an installation of
+<tt>polypaudio</tt> (version 0.2) and <tt>libao</tt> (version 0.8.5
+works, earlier versions probably as well).</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
+<p>Make sure that <tt>libao-polyp</tt>'s driver files are installed
+into <tt>libao</tt>'s driver directory. The exact path differs from
+distribution to distribution, but is probably something like
+<tt>/usr/lib/ao/plugins-2</tt>. To install <tt>libao-polyp</tt> to
+that directory make sure to pass <tt>--prefix=/usr</tt> to the
+<tt>configure</tt> command line.</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@libao-polyp-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
+<p>Get <tt>libao-polyp</tt>'s development sources from the <a href="">Subversion</a> <a href="">repository</a>. (<a href="">viewcvs</a>)</p>
+<p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="">Freshmeat</a>.</p>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, August 2004</address>
+<div class="grey"><i>$Id$</i></div>