Merge tag 'upstream/1.1.2'

[psensor-pkg-ubuntu.git] / src / description.txt

diff --git a/src/description.txt b/src/description.txt
new file mode 100644 (file)
index 0000000..3dfdd56
--- /dev/null
+++ b/src/description.txt
@@ -0,0 +1,45 @@
+[description]
+
+/psensor is a/
+
+It displays a curve for each sensor, and uses Desktop Notification to
+raise an alarm when a temperature is too high. On Ubuntu an
+Application Indicator is also available, its icon changes when a
+temperature alert is raised.
+
+It can monitor:
+  * the temperature of the motherboard and CPU sensors (using lm\-sensors).
+  * the temperature of the NVidia GPUs (using XNVCtrl).
+  * the temperature and fan rotation speed of the ATI GPUs.
+  * the temperature of the Hard Disk Drives (using hddtemp or atasmart
+    library).
+  * the rotation speed of the fans (using lm\-sensors).
+  * the sensors of a remote computer (using psensor\-server).
+
+Psensor requires lm\-sensors to be correctly installed and configured,
+it can be checked by running the command 'sensors'. If it has never be
+done, you may need to run the command 'sensors\-detect' and follow the
+instruction. See the manpages of sensors(1) and sensors\-detect(8) for
+more information.
+
+To retrieve the temperature of the Hard Disk Drives, the hddtemp
+daemon must be running or atasmart used ('\-\-use\-libatasmart').
+
+For remote monitoring:
+  * start psensor\-server(1) on the remote computer
+  * run psensor with '\-\-url' option: 'psensor \-\-url=http://localhost:3131'
+
+ATI/AMD GPUs monitoring is available if the library libatiadlxx is
+present in the directory /usr/lib and psensor has been compiled with
+the ATI ADL SDK.
+
+Log messages are written to '$HOME/.psensor/log'.
+
+By default, if a Psensor process is already running, the command
+psensor will show the graph window then exit.  
+It is possible to run multiple instances of Psensor by using the
+option '\-\-new\-instance'.
+
+[SEE ALSO]
+
+psensor\-server(1), sensors(1), sensors\-detect(8), hddtemp(8)