added cppchecker in the list of optionnal builddep
[psensor.git] / README
1 Psensor - Temperature Monitoring For Linux
2 ------------------------------------------
3
4 Psensor is a graphical temperature monitor for Linux.
5
6 It can monitor:
7
8  * the temperature of the motherboard and CPU sensors (using
9    lm-sensors).
10  * the temperature of the NVidia GPUs (using XNVCtrl).
11  * the temperature of the Hard Disk Drives (using hddtemp or libatasmart).
12  * the rotation speed of the fans (using lm-sensors).
13  * the temperature of a remote computer.
14  * the cpu load.
15
16 Alarms using Desktop Notification can be set to each sensor to notify
17 high temperatures.
18
19 For Ubuntu users, Psensor is providing an Application Indicator to
20 alert users when a temperature is too high.
21
22 To monitor the temperature of a remote computer:
23
24  * start psensor-server on the remote computer. The default port is
25    3131 and can be changed by using the '--port=PORT' command line
26    option.
27
28  * start psensor with the '--url' option: psensor
29   --url=http://hostname:3131
30
31 WARNING: 
32 psensor-server does not provide any way to restrict the connection to
33 the HTTP server, worst, no effort has been made against malicious HTTP
34 attacks.  You should make the psensor-server port available only to a
35 network or computer you trust by using the usual network security
36 tools of the system (for example, iptables).
37
38   
39 Installation
40 ------------
41
42 Psensor can be compiled and installed on any modern linux
43 distribution.
44
45 Debian
46 ------
47
48 For Debian, the binary and source packages are available in the wheezy
49 (testing) and sid (unstable) repositories.
50
51 Debian package information are available at:
52 http://packages.qa.debian.org/p/psensor.html
53
54 Compilation requires the following packages:
55
56 gettext libgtk-3-dev libgconf2-dev libnotify-dev libsensors4-dev
57 help2man libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev
58 libgtop2-dev libatasmart-dev
59
60 Debian kfreebsd
61 ---------------
62
63 Compilation requires the following packages:
64 gcc libgtk3.0-dev libsensors4-dev libgconf2-dev help2man
65 libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev libgtop2-dev
66 libatasmart-dev
67
68 Ubuntu
69 ------
70
71 Notes about installation on Ubuntu is available at:
72 http://wpitchoune.net/blog/psensor/ubuntu-integration
73
74 Since Ubuntu Oneiric (11.10), psensor is available in the universe
75 repository of Ubuntu.
76
77 For other Ubuntu releases, the easy way to install Psensor and
78 Psensor-server is to use the dedicated PPA.
79
80 For the last stable version:
81 sudo apt-get apt-add-repository ppa:/jfi/psensor
82 sudo apt-get update
83 sudo apt-get install psensor
84
85 For the last development version:
86 sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable
87 sudo apt-get update
88 sudo apt-get install psensor
89 sudo apt-get install psensor-server
90
91 ATI/AMD GPU Support
92 -------------------
93
94 To compile Psensor with ATI support on Ubuntu:
95
96  * installs the usual Psensor build dependencies and fglrx ubuntu
97    package.
98
99  * downloads the ATI ADL SDK from:
100    http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx and
101    extracts the files of the archive into a directory [dir].
102
103  * configure the build environment: 
104    ./configure --with-libatiadl=[dir]   
105    where [dir] must be the directory where you have extracted the ATI
106    ADL SDK.
107
108  * then follow usual GNU autotools compilation:
109    make clean all
110    make install
111
112 Installation from source archive
113 --------------------------------
114
115 Psensor compilation requires:
116
117  * make/gcc     
118  * lm-sensors
119  * library sensors4
120  * library gtk3
121  * library gconf2
122  * help2man 
123  * cppcheck (optional, static source checker)
124  * library libnotify (optional)
125  * library libappindicator (optional)
126  * library libXNVCtrl (optional)
127  * library json0 and curl (optional, required for remote monitoring)
128  * library unity (>=v3.4.2, optional)
129  * library gtop2 (optional, required for CPU usage)
130  * library atasmart (optional, for disk monitoring)
131
132 Psensor-server compilation requires:
133  * make/gcc     
134  * lm-sensors
135  * library sensors4
136  * help2man 
137  * library libmicrohttpd 
138  * library json0
139  * cppcheck (optional, static source checker)
140  * library gtop2 (optional, required for CPU usage)
141  * library atasmart (optional, for disk monitoring)
142
143 Compilation and Installation Steps
144 ----------------------------------
145
146  * Extract files from the source archive
147  * Compilation:
148    ./configure
149    make clean all
150    
151  * Installation:
152    make install
153
154  * Start the sensor detection script: 'sensors-detect' and follows the
155    instructions
156
157  * Verify the sensor detection by running: 'sensors'
158
159  * Run 'psensor'
160
161 Compilation on Fedora 17
162 ------------------------
163
164  * install mandatory packages:
165    sudo yum install gcc gtk3-devel GConf2-devel lm_sensors-devel
166
167  * install additional recommended packages:
168    sudo yum install libatasmart-devel libcurl-devel json-c-devel
169                     libmicrohttpd-devel help2man libnotify-devel
170                     libgtop2-devel
171
172  * follow instructions from 'Compilation and Installation Steps'
173
174 Contact
175 -------
176 Bugs and comments can be sent to jeanfi@gmail.com
177 Home page: http://wpitchoune.net/psensor