add documentation

git-svn-id: file:///home/lennart/svn/public/paman/trunk@18 cdefa82f-4ce1-0310-97f5-ab6066f37c3c
author: Lennart Poettering <lennart@poettering.net> 2004-08-19 22:40:58 +0000
committer: Lennart Poettering <lennart@poettering.net> 2004-08-19 22:40:58 +0000
commit: 5653891432df807a266ecb82f0c5a488711cba30 (patch)
tree: f4577e19234b4de87e5283f50ba7b398d08cb6aa
parent: 5853d14cab5661ebd6aa21d183f53668d8839b46 (diff)
6 files changed, 203 insertions, 3 deletions
diff --git a/Makefile.am b/Makefile.am
index 516f7ce..b0fbb62 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,8 +17,11 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 # USA.
 
-EXTRA_DIST = bootstrap.sh
-SUBDIRS=src
+EXTRA_DIST = bootstrap.sh README LICENSE
+SUBDIRS=src doc
+
+MAINTAINERCLEANFILES=README
+noinst_DATA = README
 
 README:
 	rm -f README
diff --git a/configure.ac b/configure.ac
index be10066..0f1c7aa 100644
--- a/configure.ac
+++ b/configure.ac
@@ -55,5 +55,24 @@ if test "x$GCC" = "xyes" ; then
    CFLAGS="$CFLAGS -pipe -Wall -W -Wno-unused-parameter"
 fi
 
-AC_CONFIG_FILES([Makefile src/Makefile])
+# LYNX documentation generation
+AC_ARG_ENABLE(lynx,
+        AS_HELP_STRING(--disable-lynx,Turn off lynx usage for documentation generation),
+[case "${enableval}" in
+  yes) lynx=yes ;;
+  no)  lynx=no ;;
+  *) AC_MSG_ERROR(bad value ${enableval} for --disable-lynx) ;;
+esac],[lynx=yes])
+
+if test x$lynx = xyes ; then
+   AC_CHECK_PROG(have_lynx, lynx, yes, no)
+
+   if test x$have_lynx = xno ; then
+     AC_MSG_ERROR([*** Sorry, you have to install lynx or use --disable-lynx ***])
+   fi
+fi
+
+AM_CONDITIONAL([USE_LYNX], [test "x$lynx" = xyes])
+
+AC_CONFIG_FILES([Makefile src/Makefile doc/Makefile doc/README.html])
 AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..577a2c5
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,36 @@
+# $Id$
+
+# This file is part of Polypaudio Manager.
+#
+# Polypaudio Manager 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.
+#
+# Polypaudio Manager 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 General Public License
+# along with Polypaudio Manager; 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 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 -e < README.html
+
+.PHONY: tidy
+
diff --git a/doc/README.html.in b/doc/README.html.in
new file mode 100644
index 0000000..63ee6fb
--- /dev/null
+++ b/doc/README.html.in
@@ -0,0 +1,108 @@
+<?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>Polypaudio Manager @PACKAGE_VERSION@</title>
+<link rel="stylesheet" type="text/css" href="style.css" />
+</head>
+
+<body>
+<h1><a name="top">Polypaudio Manager @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>
+</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 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
+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">Sat Aug 20 2004: </div> <p class="news-text"><a
+href="@PACKAGE_URL@paman-0.1.tar.gz">Version 0.1</a> released</p>
+
+<h2><a name="overview">Overview</a></h2>
+
+<p>Polypaudio Manager (<tt>paman</tt>) is a simple GTK frontend for the <a
+href="http://0pointer.de/lennart/projects/polypaudio/">polypaudio</a>
+sound server.</p>
+
+<p>Everybody loves <a href="@PACKAGE_URL@/screenshot.png">screenshots</a>.</p>
+
+<h2><a name="status">Status</a></h2>
+
+<p>With the current version of <tt>paman</tt> you may browser most of
+polypaudio's internals. There is support for changing volume of sinks
+and sink outputs. You're able to play samples from the sample
+cache.</p>
+  
+<h2><a name="documentation">Documentation</a></h2>
+
+<p>There is not much to say. Just run <tt>paman</tt> and see yourself. 
+
+<h2><a name="requirements">Requirements</a></h2>
+
+<p>Currently, <tt>paman</tt> is tested on Linux only.</p>
+
+<p><tt>paman</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><tt>paman</tt> requires <a href="http://gtkmm.sf.net/"><tt>gtkmm</tt></a> and <tt>glademmm</tt> installed.</p>
+
+<p>Obviously <tt>paman</tt> requires an installation of <tt>polypaudio</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>paman</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@paman-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
+
+<p>Get <tt>paman</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="https://seth.intheinter.net:8081/svn/paman/">repository</a>. (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=paman">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="http://freshmeat.net/projects/paman/">Freshmeat</a>.</p>
+
+<hr/>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, August 2004</address>
+<div class="grey"><i>$Id$</i></div>
+
+</body>
+</html>
diff --git a/doc/screenshot.png b/doc/screenshot.png
new file mode 100644
index 0000000..18a6b91
--- /dev/null
+++ b/doc/screenshot.png
diff --git a/doc/style.css b/doc/style.css
new file mode 100644
index 0000000..d44a401
--- /dev/null
+++ b/doc/style.css
@@ -0,0 +1,34 @@
+/* $Id$ */
+
+/***
+ * This file is part of Polypaudio Manager.
+ *
+ * Polypaudio Manager 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.
+ *
+ * Polypaudio Manager 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 General Public License
+ * along with Polypaudio Manager; 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;  }
author	Lennart Poettering <lennart@poettering.net>	2004-08-19 22:40:58 +0000
committer	Lennart Poettering <lennart@poettering.net>	2004-08-19 22:40:58 +0000
commit	5653891432df807a266ecb82f0c5a488711cba30 (patch)
tree	f4577e19234b4de87e5283f50ba7b398d08cb6aa
parent	5853d14cab5661ebd6aa21d183f53668d8839b46 (diff)