src/psensor/index.adoc

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