From 110d1ea1d8151e679ce2cd5c0a976a1194789621 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Orsini Date: Sat, 15 Sep 2012 20:38:57 +0000 Subject: [PATCH] improved the README and use the asciidoc syntax adds html version of the README in the distrib --- Makefile.am | 10 +- Makefile.in | 11 +- README | 219 ++++++++++---------- README.html | 668 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 798 insertions(+), 110 deletions(-) create mode 100644 README.html diff --git a/Makefile.am b/Makefile.am index 0575377..40db776 100644 --- a/Makefile.am +++ b/Makefile.am @@ -15,7 +15,12 @@ SUBDIRS = doc \ www \ tests -dist_doc_DATA = README COPYING NEWS AUTHORS INSTALL +dist_doc_DATA = AUTHORS \ + COPYING \ + INSTALL \ + NEWS \ + README \ + README.html autostartdir = $(sysconfdir)/xdg/autostart autostart_DATA = psensor.desktop @@ -25,4 +30,5 @@ desktop_DATA = psensor.desktop EXTRA_DIST = $(desktop_DATA) $(autostart_DATA) - +README.html: README www/style.css + asciidoc --theme style -a themedir=`pwd`/www -n -a toc README diff --git a/Makefile.in b/Makefile.in index b77ebfc..8e47db1 100644 --- a/Makefile.in +++ b/Makefile.in @@ -305,7 +305,13 @@ SUBDIRS = doc \ www \ tests -dist_doc_DATA = README COPYING NEWS AUTHORS INSTALL +dist_doc_DATA = AUTHORS \ + COPYING \ + INSTALL \ + NEWS \ + README \ + README.html + autostartdir = $(sysconfdir)/xdg/autostart autostart_DATA = psensor.desktop desktopdir = $(datadir)/applications @@ -875,6 +881,9 @@ uninstall-am: uninstall-autostartDATA uninstall-desktopDATA \ uninstall-desktopDATA uninstall-dist_docDATA +README.html: README www/style.css + asciidoc --theme style -a themedir=`pwd`/www -n -a toc README + # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: diff --git a/README b/README index 6901ada..18608f9 100644 --- a/README +++ b/README @@ -1,9 +1,12 @@ -Psensor - Temperature Monitoring For Linux ------------------------------------------- +Psensor +======= -Psensor is a graphical temperature monitor for Linux. +Introduction +------------ + +Psensor is a graphical hardware monitoring application for Linux. -It can monitor: +It draws realtime charts and raises alerts about: * the temperature of the motherboard and CPU sensors (using lm-sensors). @@ -13,107 +16,101 @@ It can monitor: * the temperature of a remote computer. * the cpu load. -Alarms using Desktop Notification can be set to each sensor to notify -high temperatures. +Alerts are using Desktop Notification and a specific GTK+ status icon. -For Ubuntu users, Psensor is providing an Application Indicator to -alert users when a temperature is too high. +For Ubuntu users, Psensor is providing an Application Indicator which turns +red under alert and a menu for quickly check all sensors. -To monitor the temperature of a remote computer: +It is possible to monitor remotely a computer: - * start psensor-server on the remote computer. The default port is - 3131 and can be changed by using the '--port=PORT' command line - option. + * start +psensor-server+ on the remote computer. - * start psensor with the '--url' option: psensor - --url=http://hostname:3131 + * start +psensor+ using: +psensor --url=http://hostname:3131+. -WARNING: -psensor-server does not provide any way to restrict the connection to -the HTTP server, worst, no effort has been made against malicious HTTP -attacks. You should make the psensor-server port available only to a -network or computer you trust by using the usual network security -tools of the system (for example, iptables). ++psensor-server+ is a minimal Web server, a Web browser can be used to +monitor the remote computer by opening the URL: ++http://hostname:3131+. +[WARNING] ++psensor-server+ does not provide any way to restrict the connection +to the HTTP server, worst, no effort has been made against malicious +HTTP attacks. You should make the +psensor-server+ port available +only to a network or computer you trust by using the usual network +security tools of the system (for example: +http://www.netfilter.org/projects/iptables/index.html[iptables]). -Installation ------------- - -Psensor can be compiled and installed on any modern linux -distribution. +Installation Using Distribution Packages +---------------------------------------- Debian ------- - -For Debian, the binary and source packages are available in the wheezy -(testing) and sid (unstable) repositories. +~~~~~~ -Debian package information are available at: -http://packages.qa.debian.org/p/psensor.html +For Debian, the binary and source packages are available in the +Wheezy, unstable and testing repositories. -Compilation requires the following packages: +Debian package information is available at: +http://packages.qa.debian.org/p/psensor.html. -asciidoc cppcheck gettext libgtk-3-dev libgconf2-dev libnotify-dev -libsensors4-dev help2man libcurl4-openssl-dev libjson0-dev -libmicrohttpd-dev libgtop2-dev libatasmart-dev - -Debian kfreebsd ---------------- - -Compilation requires the following packages: -asciidoc cppcheck gcc libgtk3.0-dev libsensors4-dev libgconf2-dev -help2man libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev -libgtop2-dev libatasmart-dev +To do the installation: +-------------------------------------------- +sudo apt-get install psensor psensor-server +-------------------------------------------- Ubuntu ------- - -Notes about installation on Ubuntu is available at: -http://wpitchoune.net/blog/psensor/ubuntu-integration +~~~~~~ Since Ubuntu Oneiric (11.10), psensor is available in the universe repository of Ubuntu. -For other Ubuntu releases, the easy way to install Psensor and -Psensor-server is to use the dedicated PPA. +To install +psensor+ or +psensor-server+: +------------------------------------ +sudo apt-get install psensor +sudo apt-get install psensor-server +------------------------------------ + +Or search them in the Ubuntu Software Center. + +For other Ubuntu releases or user the more recent release, the easiest +way is to use the dedicated PPA. -For the last stable version: +Last stable version: +------------------------------------------------- sudo apt-get apt-add-repository ppa:/jfi/psensor sudo apt-get update sudo apt-get install psensor +sudo apt-get install psensor-server +------------------------------------------------- -For the last development version: +Last development version which should not contain major bugs: +---------------------------------------------------------- sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable sudo apt-get update sudo apt-get install psensor sudo apt-get install psensor-server +---------------------------------------------------------- -ATI/AMD GPU Support -------------------- - -To compile Psensor with ATI support on Ubuntu: - - * installs the usual Psensor build dependencies and fglrx ubuntu - package. +Daily trunk build which may contain major bugs and partialy +implemented features: +------------------------------------------------------------- +sudo apt-get apt-add-repository ppa:/jfi/psensor-daily-trunk +sudo apt-get update +sudo apt-get install psensor +sudo apt-get install psensor-server +------------------------------------------------------------- - * downloads the ATI ADL SDK from: - http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx and - extracts the files of the archive into a directory [dir]. +Installation From Source Archive +-------------------------------- - * configure the build environment: - ./configure --with-libatiadl=[dir] - where [dir] must be the directory where you have extracted the ATI - ADL SDK. ++psensor+ and +psensor-server+ can be compiled and installed on any +modern GNU/Linux distribution. - * then follow usual GNU autotools compilation: - make clean all - make install +Compilation Prerequisites +~~~~~~~~~~~~~~~~~~~~~~~~~ -Installation from source archive --------------------------------- +The compilation of +psensor+ requires: -Psensor compilation requires: - * make/gcc + * make + * gcc (or llvm) * lm-sensors * library sensors4 * library gtk3 @@ -130,52 +127,60 @@ Psensor compilation requires: * library gtop2 (optional, required for CPU usage) * library atasmart (optional, for disk monitoring) -Psensor-server compilation requires: +The specific requirements for +psensor-server+: - * make/gcc - * lm-sensors - * library sensors4 - * help2man * library libmicrohttpd * library json0 - * asciidoc (optional, required to produce the html version of the - faq) - * cppcheck (optional, static source checker) - * library gtop2 (optional, required for CPU usage) - * library atasmart (optional, for disk monitoring) - -Compilation and Installation Steps ----------------------------------- - - * Extract files from the source archive - * Compilation: - ./configure - make clean all - - * Installation: - make install - * Start the sensor detection script: 'sensors-detect' and follows the - instructions +For Debian: +----------------------------------------------------------------- +sudo apt-get install asciidoc cppcheck gcc gettext libgtk-3-dev +libgconf2-dev libnotify-dev libsensors4-dev help2man +libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev libgtop2-dev +libatasmart-dev make +----------------------------------------------------------------- + +For Fedora 17: +----------------------------------------------------------------------- +sudo yum install gcc gtk3-devel GConf2-devel lm_sensors-devel cppcheck +libatasmart-devel libcurl-devel json-c-devel libmicrohttpd-devel +help2man libnotify-devel libgtop2-devel make +----------------------------------------------------------------------- - * Verify the sensor detection by running: 'sensors' +Compilation and Installation Steps +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. download the source archive from: http://wpitchoune.net/psensor/files +2. Extract files from the source archive +3. Compilation: +./configure;make clean all+ +4. Installation: +make install+ (require to have root permission) +5. Start the sensor detection script: +sensors-detect+ and follows the +instructions. Then, teboot or activate the kernel modules which have +been found. +7. To monitor HDDs, the +hddtemp+ daemon must be installed and running. +8. Run: +psensor+ - * Run 'psensor' +ATI/AMD GPU Support +~~~~~~~~~~~~~~~~~~~ -Compilation on Fedora 17 ------------------------- +When the OpenSource ATI driver(nouveau) is used, the monitoring +information is available throw lm-sensors and does not require the +following instructions. - * install mandatory packages: - sudo yum install gcc gtk3-devel GConf2-devel lm_sensors-devel +When the proprietary ATI driver(Catalyst) is used, the build is +requiring an additional library. - * install additional recommended packages: - sudo yum install cppcheck libatasmart-devel libcurl-devel - json-c-devel libmicrohttpd-devel help2man - libnotify-devel libgtop2-devel +Download the +http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx[ATI ADL SDK] +and extracts the files of the archive into a directory [dir]. - * follow instructions from 'Compilation and Installation Steps' +Replace the step 7. of the above section by +./configure +--with-libatiadl=[dir]+ where +[dir]+ must be the directory where you +have extracted the ATI ADL SDK. Other steps are indentical. Contact ------- -Bugs and comments can be sent to jeanfi@gmail.com + +Bugs and comments can be sent to jeanfi@gmail.com. + Home page: http://wpitchoune.net/psensor \ No newline at end of file diff --git a/README.html b/README.html new file mode 100644 index 0000000..be46ce2 --- /dev/null +++ b/README.html @@ -0,0 +1,668 @@ + + + + + +Psensor + + + + + +
+
+

1. Introduction

+
+

Psensor is a graphical hardware monitoring application for Linux.

+

It draws realtime charts and raises alerts about:

+
    +
  • +

    +the temperature of the motherboard and CPU sensors (using + lm-sensors). +

    +
    • +
  • +

    +the temperature of the NVidia GPUs (using XNVCtrl). +

    +
    • +
  • +

    +the temperature of the Hard Disk Drives (using hddtemp or libatasmart). +

    +
    • +
  • +

    +the rotation speed of the fans (using lm-sensors). +

    +
    • +
  • +

    +the temperature of a remote computer. +

    +
    • +
  • +

    +the cpu load. +

    +
    • +
+

Alerts are using Desktop Notification and a specific GTK+ status icon.

+

For Ubuntu users, Psensor is providing an Application Indicator which turns +red under alert and a menu for quickly check all sensors.

+

It is possible to monitor remotely a computer:

+
    +
  • +

    +start psensor-server on the remote computer. +

    +
    • +
  • +

    +start psensor using: psensor --url=http://hostname:3131. +

    +
    • +
+

psensor-server is a minimal Web server, a Web browser can be used to +monitor the remote computer by opening the URL: +http://hostname:3131.

+
+ + + +
+
Warning
+		psensor-server does not provide any way to restrict the connection +to the HTTP server, worst, no effort has been made against malicious +HTTP attacks. You should make the psensor-server port available +only to a network or computer you trust by using the usual network +security tools of the system (for example: +iptables).
+
+
+
+
+

2. Installation Using Distribution Packages

+
+
+

2.1. Debian

+

For Debian, the binary and source packages are available in the +Wheezy, unstable and testing repositories.

+

Debian package information is available at: +http://packages.qa.debian.org/p/psensor.html.

+

To do the installation:

+
+
+
sudo apt-get install psensor psensor-server
+
+
+
+

2.2. Ubuntu

+

Since Ubuntu Oneiric (11.10), psensor is available in the universe +repository of Ubuntu.

+

To install psensor or psensor-server:

+
+
+
sudo apt-get install psensor
+sudo apt-get install psensor-server
+
+

Or search them in the Ubuntu Software Center.

+

For other Ubuntu releases or user the more recent release, the easiest +way is to use the dedicated PPA.

+

Last stable version:

+
+
+
sudo apt-get apt-add-repository ppa:/jfi/psensor
+sudo apt-get update
+sudo apt-get install psensor
+sudo apt-get install psensor-server
+
+

Last development version which should not contain major bugs:

+
+
+
sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable
+sudo apt-get update
+sudo apt-get install psensor
+sudo apt-get install psensor-server
+
+

Daily trunk build which may contain major bugs and partialy +implemented features:

+
+
+
sudo apt-get apt-add-repository ppa:/jfi/psensor-daily-trunk
+sudo apt-get update
+sudo apt-get install psensor
+sudo apt-get install psensor-server
+
+
+
+
+
+

3. Installation From Source Archive

+
+

psensor and psensor-server can be compiled and installed on any +modern GNU/Linux distribution.

+
+

3.1. Compilation Prerequisites

+

The compilation of psensor requires:

+
    +
  • +

    +make +

    +
    • +
  • +

    +gcc (or llvm) +

    +
    • +
  • +

    +lm-sensors +

    +
    • +
  • +

    +library sensors4 +

    +
    • +
  • +

    +library gtk3 +

    +
    • +
  • +

    +library gconf2 +

    +
    • +
  • +

    +help2man +

    +
    • +
  • +

    +asciidoc (optional, required to produce the html version of the + faq) +

    +
    • +
  • +

    +cppcheck (optional, static source checker) +

    +
    • +
  • +

    +library libnotify (optional) +

    +
    • +
  • +

    +library libappindicator (optional) +

    +
    • +
  • +

    +library libXNVCtrl (optional) +

    +
    • +
  • +

    +library json0 and curl (optional, required for remote monitoring) +

    +
    • +
  • +

    +library unity (>=v3.4.2, optional) +

    +
    • +
  • +

    +library gtop2 (optional, required for CPU usage) +

    +
    • +
  • +

    +library atasmart (optional, for disk monitoring) +

    +
    • +
+

The specific requirements for psensor-server:

+
    +
  • +

    +library libmicrohttpd +

    +
    • +
  • +

    +library json0 +

    +
    • +
+

For Debian:

+
+
+
sudo apt-get install asciidoc cppcheck gcc gettext libgtk-3-dev
+libgconf2-dev libnotify-dev libsensors4-dev help2man
+libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev libgtop2-dev
+libatasmart-dev make
+
+

For Fedora 17:

+
+
+
sudo yum install gcc gtk3-devel GConf2-devel lm_sensors-devel cppcheck
+libatasmart-devel libcurl-devel json-c-devel libmicrohttpd-devel
+help2man libnotify-devel libgtop2-devel make
+
+
+
+

3.2. Compilation and Installation Steps

+
    +
  1. +

    +download the source archive from: http://wpitchoune.net/psensor/files +

    +
    2. +
  2. +

    +Extract files from the source archive +

    +
    3. +
  3. +

    +Compilation: ./configure;make clean all +

    +
    4. +
  4. +

    +Installation: make install (require to have root permission) +

    +
    5. +
  5. +

    +Start the sensor detection script: sensors-detect and follows the +instructions. Then, teboot or activate the kernel modules which have +been found. +

    +
    6. +
  6. +

    +To monitor HDDs, the hddtemp daemon must be installed and running. +

    +
    7. +
  7. +

    +Run: psensor +

    +
    8. +
+
+
+

3.3. ATI/AMD GPU Support

+

When the OpenSource ATI driver(nouveau) is used, the monitoring +information is available throw lm-sensors and does not require the +following instructions.

+

When the proprietary ATI driver(Catalyst) is used, the build is +requiring an additional library.

+

Download the +ATI ADL SDK +and extracts the files of the archive into a directory [dir].

+

Replace the step 7. of the above section by ./configure +--with-libatiadl=[dir] where [dir] must be the directory where you +have extracted the ATI ADL SDK. Other steps are indentical.

+
+
+
+
+

4. Contact

+
+

Bugs and comments can be sent to jeanfi@gmail.com.

+

Home page: http://wpitchoune.net/psensor

+
+
+
+
+ + + -- 2.7.4