projects / psensor-pkg-debian.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Imported Upstream version 1.0.1
[psensor-pkg-debian.git] / README
diff --git a/README b/README
index 8daf7f0..43123c8 100644 (file)
--- a/README
+++ b/README
@@ -1,156 +1,196 @@
-Psensor - Temperature Monitoring For Linux
-------------------------------------------
+Psensor README
+==============
 
 
-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).
  * the temperature of the NVidia GPUs (using XNVCtrl).
 
  * 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).
+ * 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.
 
  * the rotation speed of the fans (using lm-sensors).
  * 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
 
 Debian
-------
+~~~~~~
 
 
-For Debian, the binary and source packages are available in the wheezy
-(testing) and sid (unstable) repositories.
+For Debian, the binary and source packages are available in the
+Wheezy, unstable and testing repositories.
 
 
-Debian package information are available at:
-http://packages.qa.debian.org/p/psensor.html
+Debian package information is available at:
+http://packages.qa.debian.org/p/psensor.html.
 
 
-Compilation requires the following packages:
-
-gettext libgtk-3-dev libgconf2-dev libnotify-dev libsensors4-dev
-help2man libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev
-libgtop2-dev
-
-Debian kfreebsd
----------------
-
-Compilation requires the following packages:
-gcc libgtk2.0-dev libsensors4-dev libgconf2-dev help2man
-libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev libgtop2-dev
+To do the installation:
+--------------------------------------------
+sudo apt-get install psensor psensor-server
+--------------------------------------------
 
 Ubuntu
 
 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.
 
 
 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 the last stable version:
+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 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
 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
+----------------------------------------------------------
 
 
-Alternatively, you can download Ubuntu binary packages from:
-http://wpitchoune.net/psensor/files/ubuntu/
-The manual installation of the psensor and psensor-server packages
-requires also the installation of psensor-common which contains
-the multiple languages support.
-
-Centos 6
---------
+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
+-------------------------------------------------------------
 
 
-psensor can be compiled on Centos 6.0, by installing the following
-packages:
-gcc gtk2-devel GConf2-devel help2man gettext-devel libnotify-deval
-lm_sensors-devel libgtop2-devel
+Installation From Source Archive
+--------------------------------
 
 
-As microhttpd and json-c libraries are not available in the standard centos
-repository, psensor-server cannot be compiled and the remote
-monitoring feature of psensor will not be available.
++psensor+ and +psensor-server+ can be compiled and installed on any
+modern GNU/Linux distribution.
 
 
-Installation from source archive
---------------------------------
+Compilation Prerequisites
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
-Psensor compilation requires:
+The compilation of +psensor+ requires:
 
 
- * make/gcc    
+ * make
+ * gcc (or llvm)
  * lm-sensors
  * library sensors4
  * lm-sensors
  * library sensors4
- * library gtk2 (>= 2.18)
+ * library gtk3 >=3.4
  * library gconf2
  * help2man 
  * 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 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+:
 
 
-Psensor-server compilation requires:
- * make/gcc    
- * lm-sensors
- * library sensors4
- * help2man 
  * library libmicrohttpd 
  * library json0
  * library libmicrohttpd 
  * library json0
- * library gtop2 (optional, required for CPU usage)
+
+For Debian 7.0:
+-----------------------------------------------------------------
+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
+-----------------------------------------------------------------------
+
+For Ubuntu 12.10:
+-------------------------------------------------------------------------
+sudo apt-get install asciidoc autoconf automake autopoint
+debhelper (>= 9) cppcheck gettext help2man libappindicator3-dev
+libatasmart-dev libcurl4-gnutls-dev libgconf2-dev libgtk-3-dev
+libgtop2-dev libjson0-dev libmicrohttpd-dev libnotify-dev
+libsensors4-dev libunity-dev nvidia-settings perl
+
+-------------------------------------------------------------------------
 
 Compilation and Installation Steps
 
 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. Reboot or activate the kernel modules which have
+been found.
+6. To monitor HDDs, the +hddtemp+ daemon must be installed and running.
+7. Run: +psensor+
 
 
- * Extract files from the source archive
- * Compilation:
-   ./configure
-   make clean all
-   
- * Installation:
-   make install
+ATI/AMD GPU Support
+~~~~~~~~~~~~~~~~~~~
 
 
- * Start the sensor detection script: 'sensors-detect' and follows the
-   instructions
+When the OpenSource ATI driver is used, the monitoring
+information is available throw lm-sensors and does not require the
+following instructions.
 
 
- * Verify the sensor detection by running: 'sensors'
+When the proprietary ATI driver(Catalyst) is used, the build is
+requiring an additional library.
 
 
- * Run 'psensor'
+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].
+
+Replace the step 3. 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
 -------
 
 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
 Home page: http://wpitchoune.net/psensor
\ No newline at end of file
Debian packages for psensor