Imported Debian patch 0.8.0.4-1.1
[psensor-pkg-debian.git] / src / description.txt
1 [description]
2
3 /psensor is a/
4
5 It displays a curve for each sensor, and uses Desktop Notification to
6 raise an alarm when a temperature is too high. On Ubuntu an
7 Application Indicator is also available, its icon changes when a
8 temperature alert is raised.
9
10 It can monitor:
11   * the temperature of the motherboard and CPU sensors (using lm\-sensors).
12   * the temperature of the NVidia GPUs (using XNVCtrl).
13   * the temperature and fan rotation speed of the ATI GPUs.
14   * the temperature of the Hard Disk Drives (using hddtemp or atasmart
15     library).
16   * the rotation speed of the fans (using lm\-sensors).
17   * the sensors of a remote computer (using psensor\-server).
18
19 Psensor requires lm\-sensors to be correctly installed and configured,
20 it can be checked by running the command 'sensors'. If it has never be
21 done, you may need to run the command 'sensors\-detect' and follow the
22 instruction. See the manpages of sensors(1) and sensors\-detect(8) for
23 more information.
24
25 To retrieve the temperature of the Hard Disk Drives, the hddtemp
26 daemon must be running or atasmart used ('\-\-use\-libatasmart').
27
28 For remote monitoring:
29   * start psensor\-server(1) on the remote computer
30   * run psensor with '\-\-url' option: 'psensor \-\-url=http://localhost:3131'
31
32 ATI/AMD GPUs monitoring is available if the library libatiadlxx is
33 present in the directory /usr/lib and psensor has been compiled with
34 the ATI ADL SDK.
35
36 Log messages are written to '$HOME/.psensor/log'.
37
38 By default, if a Psensor process is already running, the command
39 psensor will show the graph window then exit.  
40 It is possible to run multiple instances of Psensor by using the
41 option '\-\-new\-instance'.
42
43 [SEE ALSO]
44
45 psensor\-server(1), sensors(1), sensors\-detect(8), hddtemp(8)