add documentation

git-svn-id: file:///home/lennart/svn/public/heatload/trunk@10 3bca8330-beed-0310-b360-ea58cfc96e4b

8 files changed, 178 insertions, 85 deletions

diff --git a/Makefile.am b/Makefile.am
index 574c2fd..f1751f3 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -18,21 +18,20 @@
 # USA.
 
 EXTRA_DIST = bootstrap.sh README LICENSE
-SUBDIRS=src #doc
+SUBDIRS=src doc
 
 MAINTAINERCLEANFILES=README
 noinst_DATA = README
 
 README:
 	rm -f README
-	touch README
-#	$(MAKE) -C doc README
-#	cd $(srcdir) && ln -s doc/README README
+	$(MAKE) -C doc README
+	cd $(srcdir) && ln -s doc/README README
 
 homepage: all dist doxygen
 	test -d $$HOME/homepage/private
 	mkdir -p $$HOME/homepage/private/projects/heatload
-	cp heatload-@PACKAGE_VERSION@.tar.gz doc/README.html doc/style.css $$HOME/homepage/private/projects/heatload
+	cp heatload-@PACKAGE_VERSION@.tar.gz doc/README.html doc/style.css doc/screenshot.png $$HOME/homepage/private/projects/heatload
 	ln -sf README.html $$HOME/homepage/private/projects/heatload/index.html
 
 .PHONY: homepage
diff --git a/README.in b/README.in
deleted file mode 100644
index 6755576..0000000
--- a/README.in
+++ /dev/null
@@ -1,71 +0,0 @@
-heatload VERSION - CPU Load and ACPI Temperature Monitor
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Copyright 2002
-Lennart Poettering <mz686561746c6f6164@poettering.de>
-
----------------------------------------------------------------------
-
-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.
-
-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.
-
-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.
-
----------------------------------------------------------------------
-
-This Gnome utility produces nice looking realtime graphs for the
-current CPU load and ACPI temperature of your Linux machine. It is
-nice for monitoring the direct relation of the former to the latter.
-
-The reason I developed this program was that the ACPI implementation
-of my laptop seems to be broken, and I needed a simple way to
-determine when the machines became too hot.
-
-Requirements
-------------
-
-As of version 0.1 you need a Linux kernel 2.4 with a fairly recent
-ACPI patch. (I used 20020308) Without this patch, the utility will not
-recognize your temperature sensor. Starting with 0.2, I added support
-for plain 2.4.18-Kernels (and some kernel versions prior) with ACPI
-20011018 based on a patch by Ian Morgan. lm_sensor-devices are not
-supported. (Somebody wants to send me a patch?)
-
-For compiling you need a recent g++ with Gtk-- and Gnome--
-installed. I did my development with 1.2.8 resp. 1.2.2.
-
-Development
------------
-
-Development was done under Debian GNU Linux Woody for i386 from March
-2002. The used machine was a Medion 9580-F laptop.
-
-Installation
-------------
-
-Run "make" for compiling the program. You might want to install it
-permanently on your system by issuing "make install" as root. This
-install the heatload executable to /usr/local/bin/. For removing this
-installation you might want to try "make deinstall" as root.
-
-Internet
---------
-
-You may find up to date releases of this utility on
-	http://www.stud.uni-hamburg.de/users/lennart/projects/heatload/
-
-You may download this release from
-	http://www.stud.uni-hamburg.de/users/lennart/projects/heatload/heatload-VERSION.tar.gz
-
----------------------------------------------------------------------
-
-Lennart Poettering <mz686561746c6f6164@poettering.de>, 2002
diff --git a/RELEASES b/RELEASES
deleted file mode 100644
index 136e155..0000000
--- a/RELEASES
+++ /dev/null
@@ -1,8 +0,0 @@
-heatload 0.2:
-
-		 Compilation fixes for libsigc++ on Ximian
-		 Support for ACPI 20011018	 
-
-heatload 0.1:
-
-		 Initial Release
diff --git a/configure.ac b/configure.ac
index 3e0898c..4e6efdc 100644
--- a/configure.ac
+++ b/configure.ac
@@ -73,5 +73,5 @@ fi
 
 AM_CONDITIONAL([USE_LYNX], [test "x$lynx" = xyes])
 
-AC_CONFIG_FILES([Makefile src/Makefile]) # doc/Makefile doc/README.html])
+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..2c8dc4d
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,36 @@
+# $Id: Makefile.am 10 2005-01-07 20:34:53Z lennart $
+
+# This file is part of heatload.
+#
+# heatload 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.
+#
+# heatload 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 heatload; 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 screenshot.png
+
+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..c4241c6
--- /dev/null
+++ b/doc/README.html.in
@@ -0,0 +1,112 @@
+<?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>heatload @PACKAGE_VERSION@</title>
+<link rel="stylesheet" type="text/css" href="style.css" />
+</head>
+
+<body>
+<h1><a name="top">heatload @PACKAGE_VERSION@</a></h1>
+
+<p><i>Copyright 2005 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
+Lesser 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">Sun 16 Jan 2005: </div> <p class="news-text"><a
+href="@PACKAGE_URL@heatload-0.3.tar.gz">Version 0.3</a> released:
+update to current <tt>gtkmm</tt>, major cleanups.</p>
+
+<div class="news-date">Thu 4 Apr 2002: </div> <p class="news-text"><a
+href="@PACKAGE_URL@heatload-0.2.tar.gz">Version 0.3</a> released: Compilation fixes for <tt>libsigc++</tt> on Ximian, Support for ACPI 20011018.</p>
+
+<div class="news-date">Wed 27 Mar 2002: </div> <p class="news-text"><a
+href="@PACKAGE_URL@heatload-0.1.tar.gz">Version 0.3</a> released: initial release.</p>
+
+<h2><a name="overview">Overview</a></h2>
+
+<p><tt>heatload</tt> is a tool von Linux which plots the CPU load
+against the CPU temperature as measured by the ACPI subsystem. See <a
+href="screenshot.png">this screenshot</a> for an impression of its output.</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>There's not much to document. Just run it and watch its shiny graphics.</p>
+
+<h2><a name="requirements">Requirements</a></h2>
+
+<p>Currently, <tt>heatload</tt> is tested on Linux 2.6 only.</p>
+
+<p><tt>heatload</tt> was developed and tested on Debian GNU/Linux
+"testing" from January 2005, it should work on most other Linux
+distributions since it uses GNU autoconf for
+source code configuration.</p>
+
+<p><tt>heatload</tt> requires <a
+href="http://gtkmm.sourceforge.net">gtkmm</a> 2.4 and Linux kernel with
+support for ACPI on a machine that supports temperature measuring via
+ACPI. (<i>Not all machines having ACPI at all support temperature measurement via ACPI!</i>)</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>heatload</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@heatload-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
+
+<p>Get <tt>heatload</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://seth.intheinter.net/heatload">repository</a> (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=heatload">viewcvs</a>): </p>
+
+<pre>svn checkout svn://seth.intheinter.net/heatload/trunk heatload</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/heatload/">Freshmeat</a>.</p>
+
+<hr/>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, January 2005</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..504983e
--- /dev/null
+++ b/doc/screenshot.png
diff --git a/doc/style.css b/doc/style.css
new file mode 100644
index 0000000..ede92de
--- /dev/null
+++ b/doc/style.css
@@ -0,0 +1,25 @@
+/* $Id: style.css 10 2005-01-07 20:34:53Z lennart $ */
+
+/***
+ * This file is part of heatload.
+ *
+ * heatload 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.
+ *
+ * heatload 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 heatload; 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; } 
+a:link, a:visited { color: #900000; }       
+div.news-date { font-size: 80%; font-style: italic; } 
+pre { background-color: #f0f0f0; padding: 0.4cm; }
+.grey { color: #8f8f8f; font-size: 80%; }