From e94a29cf6d797e2188b0dd98fc1af0ee5019d55b Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sat, 15 Jan 2005 22:47:37 +0000 Subject: add documentation git-svn-id: file:///home/lennart/svn/public/heatload/trunk@10 3bca8330-beed-0310-b360-ea58cfc96e4b --- Makefile.am | 9 ++--- README.in | 71 --------------------------------- RELEASES | 8 ---- configure.ac | 2 +- doc/Makefile.am | 36 +++++++++++++++++ doc/README.html.in | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/screenshot.png | Bin 0 -> 14654 bytes doc/style.css | 25 ++++++++++++ 8 files changed, 178 insertions(+), 85 deletions(-) delete mode 100644 README.in delete mode 100644 RELEASES create mode 100644 doc/Makefile.am create mode 100644 doc/README.html.in create mode 100644 doc/screenshot.png create mode 100644 doc/style.css 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 - ---------------------------------------------------------------------- - -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 , 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 @@ + + + + + +heatload @PACKAGE_VERSION@ + + + + +

heatload @PACKAGE_VERSION@

+ +

Copyright 2005 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

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 +Lesser 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.

+ +

News

+ +
Sun 16 Jan 2005:

Version 0.3 released: +update to current gtkmm, major cleanups.

+ +
Thu 4 Apr 2002:

Version 0.3 released: Compilation fixes for libsigc++ on Ximian, Support for ACPI 20011018.

+ +
Wed 27 Mar 2002:

Version 0.3 released: initial release.

+ +

Overview

+ +

heatload is a tool von Linux which plots the CPU load +against the CPU temperature as measured by the ACPI subsystem. See this screenshot for an impression of its output.

+ +

Status

+ +

Version @PACKAGE_VERSION@ is quite stable and feature complete.

+ +

Documentation

+ +

There's not much to document. Just run it and watch its shiny graphics.

+ +

Requirements

+ +

Currently, heatload is tested on Linux 2.6 only.

+ +

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

+ +

heatload requires gtkmm 2.4 and Linux kernel with +support for ACPI on a machine that supports temperature measuring via +ACPI. (Not all machines having ACPI at all support temperature measurement via ACPI!)

+ +

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 +heatload.

+ +

Acknowledgements

+ +

None so far

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

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

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

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/screenshot.png b/doc/screenshot.png new file mode 100644 index 0000000..504983e Binary files /dev/null and b/doc/screenshot.png differ 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%; } -- cgit