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