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