Imported Upstream version 0.6.2.17
[psensor-pkg-debian.git] / src / psensor.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.4.
2 .TH PSENSOR "1" "March 2012" "psensor 0.6.2.17" "User Commands"
3 .SH NAME
4 psensor \- Temperature monitoring application
5 .SH SYNOPSIS
6 .B psensor
7 [\fIOPTION\fR]...
8 .SH DESCRIPTION
9
10 .PP
11 psensor is a GTK application for monitoring hardware sensors, including temperatures and fan speeds.
12 .PP
13
14 It displays a curve for each sensor, and uses Desktop Notification to
15 raise an alarm when a temperature is too high. On Ubuntu an
16 Application Indicator is also available, its icon changes when a
17 temperature alert is raised.
18
19 It can monitor:
20   * the temperature of the motherboard and CPU sensors (using lm\-sensors).
21   * the temperature of the NVidia GPUs (using XNVCtrl).
22   * the temperature and fan rotation speed of the ATI GPUs.
23   * the temperature of the Hard Disk Drives (using hddtemp).
24   * the rotation speed of the fans (using lm\-sensors).
25   * the sensors of a remote computer (using psensor\-server).
26
27 Psensor requires lm\-sensors to be correctly installed and configured,
28 it can be checked by running the command 'sensors'. If it has never be
29 done, you may need to run the command 'sensors\-detect' and follow the
30 instruction. See the manpages of sensors(1) and sensors\-detect(8) for
31 more information.
32
33 To retrieve the temperature of the Hard Disk Drives, the hddtemp
34 daemon must be running.
35
36 For remote monitoring:
37   * start psensor\-server(1) on the remote computer
38   * run psensor with '\-\-url' option: 'psensor \-\-url=http://localhost:3131'
39
40 ATI/AMD GPUs monitoring is available if the library libatiadlxx is
41 present in the directory /usr/lib and psensor has been compiled with
42 the ATI ADL SDK.
43
44 Log is written to '$HOME/.psensor/log'.
45 .SH OPTIONS
46 .TP
47 \fB\-h\fR, \fB\-\-help\fR
48 display this help and exit
49 .TP
50 \fB\-v\fR, \fB\-\-version\fR
51 display version information and exit
52 .TP
53 \fB\-u\fR, \fB\-\-url\fR=\fIURL\fR
54 the URL of the psensor\-server, example: http://hostname:3131
55 .TP
56 \fB\-d\fR, \fB\-\-debug\fR=\fILEVEL\fR
57 set the debug level, integer between 0 and 3
58 .SH "REPORTING BUGS"
59 Report bugs to: jeanfi@gmail.com
60 .PP
61 psensor home page: <http://wpitchoune.net/psensor>
62 .SH COPYRIGHT
63 Copyright \(co 2010\-2012 jeanfi@gmail.com
64 License GPLv2: GNU GPL version 2 or later <http://www.gnu.org/licenses/old\-licenses/gpl\-2.0.html>
65 .br
66 This is free software: you are free to change and  redistribute it.
67 There is NO WARRANTY, to the extent permitted by law.
68 .SH "SEE ALSO"
69
70 psensor\-server(1), sensors(1), sensors\-detect(8), hddtemp(8)