5aaf8b981cac0a1da931b1044b6f1d245d4d5377
[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 link: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`.
27
28 For Ubuntu:
29
30 [source,script]
31 ----
32 sudo apt-get install lm-sensors
33 ----
34
35 Then, starts the detection of your hardware sensors:
36
37 [source,script]
38 ----
39 sudo sensors-detect
40 ----
41
42 Verify that it works:
43
44 [source,script]
45 ----
46 sensors
47 ----
48
49 It should display something like:
50
51 ----
52 coretemp-isa-0000
53 Adapter: ISA adapter
54 Core 0:      +46.0C  (high = +76.0C, crit = +100.0C)
55
56 coretemp-isa-0001
57 Adapter: ISA adapter
58 Core 1:      +44.0C  (high = +76.0C, crit = +100.0C)
59
60 ...
61 ----
62
63 Then you can proceed to the installation of `psensor`. For Ubuntu and derivatives,
64  you should look at the link:psensor_ubuntu.html[Ubuntu support page].
65
66 And finally launch the `psensor` executable.
67
68 More information are available in the link:faq.html[Psensor FAQ].
69
70 == Source Code
71
72 * link:files[Download psensor]
73 * Get source from the GIT repository:
74 ----
75 git clone http://git.wpitchoune.net/psensor.git
76 ----
77 * link:http://git.wpitchoune.net/gitweb?p=psensor.git[Browse source code]
78
79 == Linux Distribution Support
80
81 `psensor` should compile on any modern distribution including `GTK+`` v3 and
82 `lm-sensors` which are quite common. For Linux Distribution still stuck on
83  `GTK+` v2, the old 0.6.x releases of `psensor` can be used.
84
85 If you have trouble compiling `psensor` on a specific Linux distribution,
86 don’t hesitate to report it.
87
88 Binary packages of `psensor` are available for few Linux distributions:
89
90 * package for Ubuntu is in the official universe repository since version 11.10 (Oneiric)
91 * http://packages.qa.debian.org/p/psensor.html[package for Debian] is in the standard repository since 7.0
92 * https://launchpad.net/~jfi/+archive/ubuntu/ppa[PPA for Ubuntu]
93 * http://software.opensuse.org/package/psensor[package for OpenSuse]
94 * https://aur.archlinux.org/packages/psensor/[package for ArchLinux].
95
96 == Contact
97
98 The Google Group https://groups.google.com/forum/?fromgroups&hl=en#!forum/psensor-users[psensor-users] can be used for discussion, questions and bug report.
99
100 For announces or general information subscribe to Psensor https://plus.google.com/100166747457211594542[Google+ page].
101
102 Alternatively, you can contact me by e-mail: jeanfi@gmail.com.