Imported Debian patch 0.8.0.4-1
[psensor-pkg-ubuntu.git] / doc / faq.txt
1 Psensor Frequently Asked Questions
2 ==================================
3
4 [[S_NoSensors]]
5 No sensors or only cpu usage is displayed
6 -----------------------------------------
7
8 Psensor is relying on few libraries or softwares for retrieving the information about the computer:
9
10         - motherboard and CPUs sensors: the information is retrieved
11           from the lm-sensors library, it requires that
12           ‘sensors-detect’ has been run and the kernel module
13           correctly installed. ‘sensors’ can be used for checking.
14
15         - GPUs: it depends on which driver you are using:
16
17                 * Opensource drivers (nouveau for Nvidia GPUs or
18                   radeon/ati for ATI GPUs) is used and support sensor
19                   monitoring for your GPU, the information is using
20                   lm-sensors, same steps than above.
21
22                 * proprietary driver Nvidia: run ‘nvidia-settings’ to
23                   check that it supports sensors monitoring.
24
25                 * proprietary driver Catalyst/fglx: use ‘aticonfig’ to
26                   check that it supports sensors monitoring. Important
27                   note: it requires that you are using a Psensor
28                   binary compiled with the ATI support.
29
30         - HDDs: it uses the hddtemp daemon. Verifies that it is
31           correctly reporting temperature by using the ‘sudo hddtemp
32           /dev/sd?’ command. If hddtemp does not support your disk,
33           you may want to try using the libatasmart support instead
34           (option –use-libatasmart option).
35
36 If the underlying software is reporting sensors which are not
37 displayed by Psensor, it is probably a bug in Psensor, so please
38 report it. Otherwise, the issue is on the underlying software itself
39 and you should contact the corresponding development team or refer to
40 its documentation.
41
42 [[S_ATIMonitoring]]
43 How to monitor an ATI card using the Catalyst driver?
44 -----------------------------------------------------
45
46 For monitoring ATI card using the proprietary Catalyst driver, Psensor
47 must be compiled with a proprietary library which is not packaged in
48 any Linux distribution.
49
50 Unfortunely, due to the license of this library, I cannot provide a
51 compiled version of Psensor, even in a Ubuntu PPA or Ubuntu/Debian
52 standard repositories. You have to compile Psensor sensor. You can
53 find the instructions in the section “ATI/AMD GPU Support” of the
54 README file available in the Psensor source archives.
55
56 If you are using the ATI OpenSource driver, it is not needed to
57 compile Psensor with this proprietary library.  
58
59 [[S_WrongTemperature]]
60 The reported temperature is obviously wrong
61 -------------------------------------------
62
63 If the reported temperature is obviously wrong (never change, lower
64 than the ambiant temperature, negative, higher than the sun
65 temperature, etc):
66
67         - most of the time it is not a bug in Psensor nor in the
68           underlying monitoring libraries:
69
70                 * if the temperature does not change, it might be due
71                   to an existent sensor not wired by the hardware
72                   manufacturer.
73
74                 * the goal of the sensor is to allow the system to
75                   detect critical temperature and NOT to report an
76                   exact temperature. Most sensors report a relative
77                   temperature. The more it differs from the critical
78                   temperature , the more it is wrong.
79
80         - It is only a bug in Psensor if the underlying libraries
81           report a different information than Psensor (use the
82           appropriate command or software: ‘sensors’, ‘aticonfig’ or
83           ‘hddtemp’ to check). In this case, please report a bug.
84
85 [[S_WhatIsTheSensor]]
86 What is the sensors XXXX?
87 -------------------------
88
89 Since Psensor v0.7.0.4, open the preferences of the sensor (click on
90 its name in the main window and select the menu item Preferences), and
91 look at the Chip field.
92
93 For older Psensor releases, look at the Id field, if the string is
94 starting with:
95
96         - ‘lmsensor coretemp’: Intel CPU.
97         - ‘lmsensor k10temp’,'lmsensor k8temp’,'lmsensor fam15h_power’: AMD CPU.
98         - ‘nvidia’ or ‘lmsensor nouveau’: NVIDIA GPU.
99         - ‘hdd’: hard disk drive.
100         - ‘amd’: AMD GPU.
101         - ‘lmsensor C B’: C is the name of the chip, B the name of the adapter.
102
103 For more information about lmsensor devices, see
104 http://lm-sensors.org/wiki/Devices.
105
106 [[S_BugReport]]
107 How to report a bug?
108 --------------------
109
110 Please use https://bugs.launchpad.net/psensor/+filebug to report bugs
111 even if it can only reproduced with a non-Ubuntu distribution or a
112 release not available in the standard Ubuntu repositories.
113
114 You can also use
115 https://bugs.launchpad.net/ubuntu/+source/psensor/+filebug if the bug
116 can be reproduced with a package from the standard Ubuntu
117 repositories.
118
119 If you don’t want to use the launchpad, you can send the report by
120 email to:
121
122       - psensor-users@googlegroups.com (require registration at:
123         https://groups.google.com/forum/?fromgroups&hl=en#!forum/psensor-users)
124       - or jeanfi@gmail.com.
125
126 If the bug is concerning Debian or Ubuntu derivatives distribution,
127 please add in its description the output of the command ‘apt-cache
128 policy psensor’.
129
130 If it is related to the Psensor source compilation, please add the
131 full output of the ‘configure’ command.
132
133 [[S_SubmitIdea]]
134 How to send ideas, questions or comments?
135 -----------------------------------------
136
137 Check the FAQ or the TODO pages.
138
139 If you don’t find the information, you can send an email to the public
140 mailing-list psensor-users@googlegroups.com (require registration at:
141 https://groups.google.com/forum/?fromgroups&hl=en#!forum/psensor-users) 
142 or send an email directly to me: jeanfi@gmail.com.
143         
144
145 [[S_Contribute]]
146 How to contribute?
147 ------------------
148
149 See http://wpitchoune.net/blog/psensor/how-to-contribute/.
150
151 [[S_UbuntuInstall]]
152 How to install Psensor on Ubuntu?
153 ---------------------------------
154
155 Psensor is in the official repository, search “psensor” in the software center and install it. More information at: http://wpitchoune.net/blog/psensor/ubuntu-integration/.
156
157 [[S_DebianInstall]]
158 How to install Psensor on Debian?
159 ---------------------------------
160
161 Psensor will be in the official repository since Debian 7.0. You can get the last packaged version from the sid repository. More information at: http://packages.qa.debian.org/p/psensor.html.
162
163 [[S_PPA]]
164 What is the difference between the 3 Ubuntu PPAs?
165 -------------------------------------------------
166
167         - ppa:jfi/ppa: last stable version.
168
169         - ppa:jfi/psensor-unstable: last development version, no major
170           bug is expected.
171
172         - ppa:jfi/psensor-daily-trunk: build each day directly from
173           the SVN source repository. It may contain major bugs or
174           incomplete features. Useful for contributors or testing
175           whether a bug is fixed.
176
177 [[S_ArchLinuxInstall]]
178 How to install Psensor on ArchLinux?
179 ------------------------------------
180
181 See http://aur.archlinux.org/packages.php?ID=37807.
182
183 [[S_OtherInstall]]
184 How to install Psensor on my Linux distribution?
185 ------------------------------------------------
186
187 Psensor packages are available in the standard repositories of Ubuntu
188 (since Oneiric) and Debian (since v7) distributions.
189
190 For other distributions, you will find the compilation and
191 installation instructions in the section ‘Installation from source
192 archive’ in the README file of the source archive. Psensor should
193 compile in any modern distribution.
194
195 [[S_LOG]]
196 How to log sensors temperatures?
197 --------------------------------
198
199 The best way is probably to use sensord or a custom script based on
200 the output of the different commands like sensors.
201
202 Anyway, as I received several requests about such feature, since the
203 0.7.0.4 release it is implemented in both psensor ( menu preferences >
204 sensors > enable log of measures) and psensor-server (–sensor-log-file
205 option).  
206
207 [[S_NO_GRAPH_DISPLAYED]]
208
209 No graphs are displayed, but the table of the main window is displaying sensors
210 -------------------------------------------------------------------------------
211
212 In the sensors table of the main window, switch on the checkbox of the last
213 column (named "Enabled" or "Graph" depending on the Psensor version).
214
215 [[S_SimilarSoft]]
216 Is there any other similar softwares?
217 -------------------------------------
218
219 Here is a list of few well-known sensors monitoring softwares:
220
221         - for X11: http://freecode.com/projects/xsensors
222
223         - for GNOME2: http://sensors-applet.sourceforge.net/
224
225         - for Ubuntu Unity: https://launchpad.net/indicator-sensors
226
227         - more general, but can be configured to display sensors
228           information: http://conky.sourceforge.net/