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