X-Git-Url: http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blobdiff_plain;f=README;h=3b50a77ce265e5763cb4eb2ea94ff80727e99e93;hp=e5de761fb97017ebddb76b7cf5353dc6b267bf6b;hb=0acbbfd3bee0ebad1faae5b8314aea10a9cc123e;hpb=b47d3afdb62b65d8bfb6e715490cd6544228096b diff --git a/README b/README index e5de761..3b50a77 100644 --- a/README +++ b/README @@ -1,121 +1,172 @@ -Psensor - Temperature Monitoring For Linux ------------------------------------------- +Psensor README +============== -Psensor is a graphical temperature monitor for Linux. +Introduction +------------ + +Psensor is a graphical hardware monitoring application for Linux. -It can monitor: +It draws realtime charts and raises alerts about: - * the temperature of the motherboard and CPU sensors (using - lm-sensors). - * the temperature of the NVidia GPUs (using XNVCtrl). - * the temperature of the Hard Disk Drives (using hddtemp). - * the rotation speed of the fans (using lm-sensors). - * the temperature of a remote computer. + * the temperature of the motherboard and CPU sensors (using + lm-sensors). + * the temperature of the NVidia GPUs (using XNVCtrl). + * the temperature of ATI GPUs (using ATI ADL SDK). + * the temperature of the Hard Disk Drives (using hddtemp, libatasmart + or udisks2). + * the rotation speed of the fans. + * the temperature of a remote computer. + * the CPU load. -Alarms using Desktop Notification can be set to each sensor to notify -high temperatures. +Alerts are using Desktop Notification and a specific GTK+ status icon. -For Ubuntu users, Psensor is providing an Application Indicator to -alert users when a temperature is too high. +For Ubuntu users, Psensor is providing an Application Indicator which turns +red under alert and a menu for quickly check all sensors. -To monitor the temperature of a remote computer: +It is possible to monitor remotely a computer: - * start psensor-server on the remote computer. The default port is - 3131 and can be changed by using the '--port=PORT' command line - option. + * start +psensor-server+ on the remote computer. - * start psensor with the '--url' option: - psensor --url=http://hostname:3131 + * start +psensor+ using: +psensor --url=http://hostname:3131+. -WARNING: -psensor-server does not provide any way to restrict the connection to -the HTTP server, worst, no effort has been made against malicious HTTP -attacks. You should make the psensor-server port available only to a -network or computer you trust by using the usual network security -tools of the system (for example, iptables). ++psensor-server+ is a minimal Web server, a Web browser can be used to +monitor the remote computer by opening the URL: ++http://hostname:3131+. +[WARNING] ++psensor-server+ does not provide any way to restrict the connection +to the HTTP server, worst, no effort has been made against malicious +HTTP attacks. You should make the +psensor-server+ port available +only to a network or computer you trust by using the usual network +security tools of the system (for example: +http://www.netfilter.org/projects/iptables/index.html[iptables]). -Installation ------------- +Installation Using Distribution Packages +---------------------------------------- Debian ------- +~~~~~~ -For Debian, the binary and source packages are available in the wheezy -(testing) and sid (unstable) repositories. +For Debian, the binary and source packages are available in the +Wheezy, unstable and testing repositories. -Debian package information are available at: -http://packages.qa.debian.org/p/psensor.html +Debian package information is available at: +http://packages.qa.debian.org/p/psensor.html. + +To do the installation: +-------------------------------------------- +sudo apt-get install psensor psensor-server +-------------------------------------------- Ubuntu ------- +~~~~~~ + +Since Ubuntu Oneiric (11.10), psensor is available in the universe +repository of Ubuntu. + +To install +psensor+ or +psensor-server+: +------------------------------------ +sudo apt-get install psensor +sudo apt-get install psensor-server +------------------------------------ + +Or search them in the Ubuntu Software Center. -For Ubuntu, the easy way to install Psensor and Psensor-server is to -use the dedicated PPA. +For other Ubuntu releases or user the more recent release, the easiest +way is to use the dedicated PPA. -For the last stable version: +Last stable version: +------------------------------------------------- sudo apt-get apt-add-repository ppa:/jfi/psensor sudo apt-get update sudo apt-get install psensor +sudo apt-get install psensor-server +------------------------------------------------- -For the last development version: +Last development version which should not contain major bugs: +---------------------------------------------------------- sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable sudo apt-get update sudo apt-get install psensor sudo apt-get install psensor-server +---------------------------------------------------------- -Alternatively, you can download Ubuntu binary packages from: -http://wpitchoune.net/psensor/files/ubuntu/ -The manual installation of the psensor and psensor-server packages -requires also the installation of psensor-common which contains -the multiple languages support. +Daily trunk build which may contain major bugs and partialy +implemented features: +------------------------------------------------------------- +sudo apt-get apt-add-repository ppa:/jfi/psensor-daily-trunk +sudo apt-get update +sudo apt-get install psensor +sudo apt-get install psensor-server +------------------------------------------------------------- -Installation from source archive +Installation From Source Archive -------------------------------- -Psensor compilation requires: ++psensor+ and +psensor-server+ can be compiled and installed on any +modern GNU/Linux distribution. + +Compilation Prerequisites +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The compilation of +psensor+ requires: - * make/gcc + * make + * gcc (or llvm) * lm-sensors * library sensors4 - * library gtk2 - * library gconf2 + * library gtk3 >=3.4 * help2man + * asciidoc (optional, required to produce the html version of the + faq) + * cppcheck (optional, static source checker) * library libnotify (optional) - * library libappindicator (optional) + * library libappindicator >= 3.0 (optional) * library libXNVCtrl (optional) - * library json0 and curl (optional, required for remote monitoring) + * library json-c >= 0.11.99 and curl (optional, required for remote monitoring) * library unity (>=v3.4.2, optional) * library gtop2 (optional, required for CPU usage) + * library atasmart (optional, for disk monitoring) + * library udisk2 (optional, for disk monitoring) + +The specific requirements for +psensor-server+: -Psensor-server compilation requires: - * make/gcc - * lm-sensors - * library sensors4 - * help2man * library libmicrohttpd * library json0 - * library gtop2 (optional, required for CPU usage) Compilation and Installation Steps ----------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. download the source archive from: http://wpitchoune.net/psensor/files +2. Extract files from the source archive +3. Compilation: +./configure;make clean all+ +4. Installation: +make install+ (require to have root permission) +5. Start the sensor detection script: +sensors-detect+ and follows the +instructions. Reboot or activate the kernel modules which have +been found. +6. Run: +psensor+ - * Extract files from the source archive - * Compilation: - ./configure - make clean all - - * Installation: - make install +ATI/AMD GPU Support +~~~~~~~~~~~~~~~~~~~ - * Start the sensor detection script: 'sensors-detect' and follows the -instructions +When the OpenSource ATI driver is used, the monitoring +information is available throw lm-sensors and does not require the +following instructions. - * Verify the sensor detection by running: 'sensors' +When the proprietary ATI driver(Catalyst) is used, the build is +requiring an additional library. - * Run 'psensor' +Download the +http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx[ATI ADL SDK] +and extracts the files of the archive into a directory [dir]. + +Replace the step 3. of the above section by +./configure +--with-libatiadl=[dir]+ where +[dir]+ must be the directory where you +have extracted the ATI ADL SDK. Other steps are indentical. Contact ------- -Bugs and comments can be sent to jeanfi@gmail.com + +Bugs and comments can be sent to jeanfi@gmail.com. + Home page: http://wpitchoune.net/psensor \ No newline at end of file