c75e33a8d916fd97db2a00f7f520ecaea0ccdfbc
[www.git] / src / psensor / index.adoc
1 = psensor
2
3 == A Graphical Temperature Monitoring Application
4
5 Psensor is a graphical hardware temperature monitor for Linux.
6
7 It can monitor:
8
9 - the temperature of the motherboard and CPU sensors (using http://www.lm-sensors.org/[lm-sensors]).
10 - the temperature of the NVidia GPUs (using XNVCtrl).
11 - the temperature of ATI/AMD GPUs (not enabled in Ubuntu PPAs or official
12   distribution repositories, see the http://wpitchoune.net/psensor/doc/README.html#_ati_amd_gpu_support[instructions for enabling its support]).
13 - the temperature of the Hard Disk Drives (using hddtemp or libatasmart).
14 - the rotation speed of the fans (using lm-sensors).
15 - the CPU usage (since 0.6.2.10 and using Gtop2).
16
17 image::http://wpitchoune.net/psensor/screenshots/psensor-last.png[]
18 image::http://wpitchoune.net/psensor/screenshots/psensor-2011-06-16.png[]
19
20 The application is designed to be simple and easy to use. The CPU and memory consumption are not significant.
21
22 Psensor is released under GPLv2 license terms.
23
24 == Usage Information
25
26 First step is to install `lm-sensors`, for Ubuntu:
27
28 [source,script]
29 ----
30 sudo apt-get install lm-sensors
31 ----
32
33 Then, starts the detection of your hardware sensors:
34
35 [source,script]
36 ----
37 sudo sensors-detect
38 ----
39
40 Verify that it works:
41
42 [source,script]
43 ----
44 sensors
45 ----
46
47 It should display something like:
48
49 ----
50 coretemp-isa-0000
51 Adapter: ISA adapter
52 Core 0:      +46.0C  (high = +76.0C, crit = +100.0C)
53
54 coretemp-isa-0001
55 Adapter: ISA adapter
56 Core 1:      +44.0C  (high = +76.0C, crit = +100.0C)
57
58 ...
59 ----
60
61 Then you can proceed to the installation of psensor. For Ubuntu and derivatives,
62  you should look at the Ubuntu support page.
63
64 And finally launch the psensor executable.
65
66 More information are available in the Psensor FAQ.
67
68 == Source Code
69
70     Download psensor
71     Get source from GIT repository: git clone http://git.wpitchoune.net/psensor.git
72     Browse source code
73
74 == Linux Distribution Support
75
76 Psensor should compile on any modern distribution including GTK+ v3 and lm-sensors which are quite common. For Linux Distribution still stuck on GTK+ v2, the old 0.6.x releases of Psensor can be used.
77
78 If you have trouble compiling Psensor on a specific Linux distribution, don’t hesitate to report it.
79
80 Binary packages of Psensor are available for few Linux distributions:
81
82     Psensor PPA for Ubuntu
83     Psensor is in the official universe repository of Ubuntu since version 11.10 (Oneiric)
84     Psensor packages for Debian, Psensor is in the standard repository of Debian since 7.0.
85     Binary RPM package for OpenSuse: thanks to djs_core for the packaging.
86     Package for ArchLinux
87     Psensor v0.2.6 is installed by default in PartedMagic since version 5.0.
88
89 == Contact
90
91 The Google Group psensor-users can be used for discussion, questions and bug report.
92
93 For announces or general information subscribe to Psensor Google+ page.
94
95 Alternatively, you can contact me by e-mail: jeanfi@gmail.com.