moved to gitlab
[psensor-pkg-debian.git] / README.html
diff --git a/README.html b/README.html
deleted file mode 100644 (file)
index 510d0dd..0000000
+++ /dev/null
@@ -1,695 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
-    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
-<head>\r
-<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.9" />\r
-<title>Psensor README</title>\r
-<style type="text/css">\r
-\r
-body {\r
-    background: #e2e2e2;\r
-    color: #333333;\r
-    font-family: Ubuntu,Arial,sans-serif;\r
-    line-height: 1.6;\r
-    font-weight: lighter;\r
-    margin: 1em 2em 2em 2em;\r
-    padding: 0 0 0 0;\r
-}\r
-\r
-h1 {\r
-    font-size: 2.813em;\r
-    margin: 0 0 0.267em 0;\r
-    padding: 0 0 0 0;\r
-    font-weight: normal;\r
-}\r
-\r
-h2 {\r
-    font-size: 2em;\r
-    margin: 0 0 0.375em;\r
-    padding: 0 0 0 0;\r
-    font-weight: normal;\r
-}\r
-\r
-h3 {\r
-    font-size: 1.438em;\r
-    margin: 0 0 0.522em;\r
-    padding: 0 0 0 0;\r
-    font-weight: normal;\r
-}\r
-\r
-h4 {\r
-    font-size: 1.219em;\r
-    margin: 0 0 0.615em;\r
-    padding: 0 0 0 0;\r
-    font-weight: normal;\r
-}\r
-\r
-h5 {\r
-    font-size: 1em;\r
-    margin: 0 0 0.75em;\r
-    padding: 0 0 0 0;\r
-    font-weight: bold;\r
-}\r
-\r
-h6 {\r
-    font-weight: normal;\r
-    font-size: 0.813em;\r
-    letter-spacing: 0.1em;\r
-    margin: 0 0 0.923em;\r
-    text-transform: uppercase;\r
-    padding: 0 0 0 0;\r
-}\r
-\r
-li {\r
-    margin: 0 0 0 1em;\r
-    line-height: 1.6;\r
-}\r
-\r
-li p {\r
-    margin: 0 0 0 0;\r
-}\r
-\r
-ul {\r
-    margin: 0 0 0 0;\r
-    padding: 0 0 0 0;\r
-}\r
-\r
-a:link, a:visited {\r
-    color: #19B6EE;\r
-    text-decoration: none;\r
-}\r
-\r
-a:hover {\r
-    text-decoration: underline;\r
-}\r
-\r
-code, pre, tt {\r
-    font-family: "Ubuntu Mono","Courier New",Courier,monospace;\r
-    font-weight: normal;\r
-    color: #333333;\r
-}\r
-\r
-pre {\r
-    background: none repeat scroll 0 0 #e0e0e0;\r
-    border-radius: 4px;\r
-    padding: 0.5em 0.5em;\r
-    margin: 0 0 0 0;\r
-    white-space: pre-wrap;\r
-    word-wrap: break-word;\r
-}\r
-\r
-table {\r
-    width: 100%;\r
-    text-align: left;\r
-}\r
-\r
-#footer {\r
-    margin: 0 0 0 0;\r
-    font-size: 0.8em;\r
-    font-weight: lighter;\r
-    clear: both;\r
-    text-align: right;\r
-}\r
-\r
-#page {\r
-    margin: 0 0 0 0;\r
-    padding: 0 0 0 0;\r
-}\r
-\r
-#main {\r
-    background: #ffffff;\r
-\r
-   -moz-box-sizing: border-box;\r
-\r
-    padding: 2em 2em 2em 2em;\r
-\r
-    -moz-border-radius: 4px;\r
-    -webkit-border-radius: 4px;\r
-    border-radius: 4px;\r
-\r
-    -webkit-box-shadow: 0 2px 2px 0 #C2C2C2;\r
-    box-shadow: 0 2px 2px 0 #C2C2C2;\r
-}\r
-\r
-#menu {\r
-    background: #ffffff;\r
-   -moz-box-sizing: border-box;\r
-    padding: 2em 2em 2em 2em;\r
-\r
-    -moz-border-radius: 4px;\r
-    -webkit-border-radius: 4px;\r
-    border-radius: 4px;\r
-\r
-    -webkit-box-shadow: 0 2px 2px 0 #C2C2C2;\r
-    box-shadow: 0 2px 2px 0 #C2C2C2;\r
-}\r
-\r
-#menu-list, #menu-list > li > ul  {\r
-    list-style-type: none;\r
-}\r
-\r
-/* menu on left col, content on right col */\r
-\r
-#menu {\r
-    float: left;\r
-    width: 18%;\r
-}\r
-\r
-#main {\r
-    float: right;\r
-    width: 80%;\r
-}\r
-\r
-/* asciidoc */\r
-\r
-#toc, #content {\r
-    margin: 0em 0em 2em 0em;\r
-\r
-    background: #ffffff;\r
-   -moz-box-sizing: border-box;\r
-    padding: 2em 2em 2em 2em;\r
-\r
-    -moz-border-radius: 4px;\r
-    -webkit-border-radius: 4px;\r
-    border-radius: 4px;\r
-\r
-    -webkit-box-shadow: 0 2px 2px 0 #C2C2C2;\r
-    box-shadow: 0 2px 2px 0 #C2C2C2;\r
-}\r
-\r
-\r
-</style>\r
-<script type="text/javascript">\r
-/*<![CDATA[*/\r
-var asciidoc = {  // Namespace.\r
-\r
-/////////////////////////////////////////////////////////////////////\r
-// Table Of Contents generator\r
-/////////////////////////////////////////////////////////////////////\r
-\r
-/* Author: Mihai Bazon, September 2002\r
- * http://students.infoiasi.ro/~mishoo\r
- *\r
- * Table Of Content generator\r
- * Version: 0.4\r
- *\r
- * Feel free to use this script under the terms of the GNU General Public\r
- * License, as long as you do not remove or alter this notice.\r
- */\r
-\r
- /* modified by Troy D. Hanson, September 2006. License: GPL */\r
- /* modified by Stuart Rackham, 2006, 2009. License: GPL */\r
-\r
-// toclevels = 1..4.\r
-toc: function (toclevels) {\r
-\r
-  function getText(el) {\r
-    var text = "";\r
-    for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
-      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.\r
-        text += i.data;\r
-      else if (i.firstChild != null)\r
-        text += getText(i);\r
-    }\r
-    return text;\r
-  }\r
-\r
-  function TocEntry(el, text, toclevel) {\r
-    this.element = el;\r
-    this.text = text;\r
-    this.toclevel = toclevel;\r
-  }\r
-\r
-  function tocEntries(el, toclevels) {\r
-    var result = new Array;\r
-    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');\r
-    // Function that scans the DOM tree for header elements (the DOM2\r
-    // nodeIterator API would be a better technique but not supported by all\r
-    // browsers).\r
-    var iterate = function (el) {\r
-      for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
-        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
-          var mo = re.exec(i.tagName);\r
-          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
-            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
-          }\r
-          iterate(i);\r
-        }\r
-      }\r
-    }\r
-    iterate(el);\r
-    return result;\r
-  }\r
-\r
-  var toc = document.getElementById("toc");\r
-  if (!toc) {\r
-    return;\r
-  }\r
-\r
-  // Delete existing TOC entries in case we're reloading the TOC.\r
-  var tocEntriesToRemove = [];\r
-  var i;\r
-  for (i = 0; i < toc.childNodes.length; i++) {\r
-    var entry = toc.childNodes[i];\r
-    if (entry.nodeName.toLowerCase() == 'div'\r
-     && entry.getAttribute("class")\r
-     && entry.getAttribute("class").match(/^toclevel/))\r
-      tocEntriesToRemove.push(entry);\r
-  }\r
-  for (i = 0; i < tocEntriesToRemove.length; i++) {\r
-    toc.removeChild(tocEntriesToRemove[i]);\r
-  }\r
-\r
-  // Rebuild TOC entries.\r
-  var entries = tocEntries(document.getElementById("content"), toclevels);\r
-  for (var i = 0; i < entries.length; ++i) {\r
-    var entry = entries[i];\r
-    if (entry.element.id == "")\r
-      entry.element.id = "_toc_" + i;\r
-    var a = document.createElement("a");\r
-    a.href = "#" + entry.element.id;\r
-    a.appendChild(document.createTextNode(entry.text));\r
-    var div = document.createElement("div");\r
-    div.appendChild(a);\r
-    div.className = "toclevel" + entry.toclevel;\r
-    toc.appendChild(div);\r
-  }\r
-  if (entries.length == 0)\r
-    toc.parentNode.removeChild(toc);\r
-},\r
-\r
-\r
-/////////////////////////////////////////////////////////////////////\r
-// Footnotes generator\r
-/////////////////////////////////////////////////////////////////////\r
-\r
-/* Based on footnote generation code from:\r
- * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
- */\r
-\r
-footnotes: function () {\r
-  // Delete existing footnote entries in case we're reloading the footnodes.\r
-  var i;\r
-  var noteholder = document.getElementById("footnotes");\r
-  if (!noteholder) {\r
-    return;\r
-  }\r
-  var entriesToRemove = [];\r
-  for (i = 0; i < noteholder.childNodes.length; i++) {\r
-    var entry = noteholder.childNodes[i];\r
-    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")\r
-      entriesToRemove.push(entry);\r
-  }\r
-  for (i = 0; i < entriesToRemove.length; i++) {\r
-    noteholder.removeChild(entriesToRemove[i]);\r
-  }\r
-\r
-  // Rebuild footnote entries.\r
-  var cont = document.getElementById("content");\r
-  var spans = cont.getElementsByTagName("span");\r
-  var refs = {};\r
-  var n = 0;\r
-  for (i=0; i<spans.length; i++) {\r
-    if (spans[i].className == "footnote") {\r
-      n++;\r
-      var note = spans[i].getAttribute("data-note");\r
-      if (!note) {\r
-        // Use [\s\S] in place of . so multi-line matches work.\r
-        // Because JavaScript has no s (dotall) regex flag.\r
-        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
-        spans[i].innerHTML =\r
-          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
-          "' title='View footnote' class='footnote'>" + n + "</a>]";\r
-        spans[i].setAttribute("data-note", note);\r
-      }\r
-      noteholder.innerHTML +=\r
-        "<div class='footnote' id='_footnote_" + n + "'>" +\r
-        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
-        n + "</a>. " + note + "</div>";\r
-      var id =spans[i].getAttribute("id");\r
-      if (id != null) refs["#"+id] = n;\r
-    }\r
-  }\r
-  if (n == 0)\r
-    noteholder.parentNode.removeChild(noteholder);\r
-  else {\r
-    // Process footnoterefs.\r
-    for (i=0; i<spans.length; i++) {\r
-      if (spans[i].className == "footnoteref") {\r
-        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
-        href = href.match(/#.*/)[0];  // Because IE return full URL.\r
-        n = refs[href];\r
-        spans[i].innerHTML =\r
-          "[<a href='#_footnote_" + n +\r
-          "' title='View footnote' class='footnote'>" + n + "</a>]";\r
-      }\r
-    }\r
-  }\r
-},\r
-\r
-install: function(toclevels) {\r
-  var timerId;\r
-\r
-  function reinstall() {\r
-    asciidoc.footnotes();\r
-    if (toclevels) {\r
-      asciidoc.toc(toclevels);\r
-    }\r
-  }\r
-\r
-  function reinstallAndRemoveTimer() {\r
-    clearInterval(timerId);\r
-    reinstall();\r
-  }\r
-\r
-  timerId = setInterval(reinstall, 500);\r
-  if (document.addEventListener)\r
-    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
-  else\r
-    window.onload = reinstallAndRemoveTimer;\r
-}\r
-\r
-}\r
-asciidoc.install(2);\r
-/*]]>*/\r
-</script>\r
-</head>\r
-<body class="article">\r
-<div id="header">\r
-<h1>Psensor README</h1>\r
-<div id="toc">
-  <div id="toctitle">Table of Contents</div>
-  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
-</div>\r
-</div>\r
-<div id="content">\r
-<div class="sect1">\r
-<h2 id="_introduction">1. Introduction</h2>\r
-<div class="sectionbody">\r
-<div class="paragraph"><p>Psensor is a graphical hardware monitoring application for Linux.</p></div>\r
-<div class="paragraph"><p>It draws realtime charts and raises alerts about:</p></div>\r
-<div class="ulist"><ul>\r
-<li>\r
-<p>\r
-the temperature of the motherboard and CPU sensors (using\r
-   lm-sensors).\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-the temperature of the NVidia GPUs (using XNVCtrl).\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-the temperature of ATI GPUs (using ATI ADL SDK).\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-the temperature of the Hard Disk Drives (using hddtemp, libatasmart\r
-   or udisks2).\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-the rotation speed of the fans.\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-the temperature of a remote computer.\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-the CPU load.\r
-</p>\r
-</li>\r
-</ul></div>\r
-<div class="paragraph"><p>Alerts are using Desktop Notification and a specific GTK+ status icon.</p></div>\r
-<div class="paragraph"><p>For Ubuntu users, Psensor is providing an Application Indicator which turns\r
-red under alert and a menu for quickly check all sensors.</p></div>\r
-<div class="paragraph"><p>It is possible to monitor remotely a computer:</p></div>\r
-<div class="ulist"><ul>\r
-<li>\r
-<p>\r
-start <code>psensor-server</code> on the remote computer.\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-start <code>psensor</code> using: <code>psensor --url=http://hostname:3131</code>.\r
-</p>\r
-</li>\r
-</ul></div>\r
-<div class="paragraph"><p><code>psensor-server</code> is a minimal Web server, a Web browser can be used to\r
-monitor the remote computer by opening the URL:\r
-<code>http://hostname:3131</code>.</p></div>\r
-<div class="admonitionblock">\r
-<table><tr>\r
-<td class="icon">\r
-<div class="title">Warning</div>\r
-</td>\r
-<td class="content"><code>psensor-server</code> does not provide any way to restrict the connection\r
-to the HTTP server, worst, no effort has been made against malicious\r
-HTTP attacks.  You should make the <code>psensor-server</code> port available\r
-only to a network or computer you trust by using the usual network\r
-security tools of the system (for example:\r
-<a href="http://www.netfilter.org/projects/iptables/index.html">iptables</a>).</td>\r
-</tr></table>\r
-</div>\r
-</div>\r
-</div>\r
-<div class="sect1">\r
-<h2 id="_installation_using_distribution_packages">2. Installation Using Distribution Packages</h2>\r
-<div class="sectionbody">\r
-<div class="sect2">\r
-<h3 id="_debian">2.1. Debian</h3>\r
-<div class="paragraph"><p>For Debian, the binary and source packages are available in the\r
-Wheezy, unstable and testing repositories.</p></div>\r
-<div class="paragraph"><p>Debian package information is available at:\r
-<a href="http://packages.qa.debian.org/p/psensor.html">http://packages.qa.debian.org/p/psensor.html</a>.</p></div>\r
-<div class="paragraph"><p>To do the installation:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><code>sudo apt-get install psensor psensor-server</code></pre>\r
-</div></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_ubuntu">2.2. Ubuntu</h3>\r
-<div class="paragraph"><p>Since Ubuntu Oneiric (11.10), psensor is available in the universe\r
-repository of Ubuntu.</p></div>\r
-<div class="paragraph"><p>To install <code>psensor</code> or <code>psensor-server</code>:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><code>sudo apt-get install psensor\r
-sudo apt-get install psensor-server</code></pre>\r
-</div></div>\r
-<div class="paragraph"><p>Or search them in the Ubuntu Software Center.</p></div>\r
-<div class="paragraph"><p>For other Ubuntu releases or user the more recent release, the easiest\r
-way is to use the dedicated PPA.</p></div>\r
-<div class="paragraph"><p>Last stable version:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><code>sudo apt-get apt-add-repository ppa:/jfi/psensor\r
-sudo apt-get update\r
-sudo apt-get install psensor\r
-sudo apt-get install psensor-server</code></pre>\r
-</div></div>\r
-<div class="paragraph"><p>Last development version which should not contain major bugs:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><code>sudo apt-get apt-add-repository ppa:/jfi/psensor-unstable\r
-sudo apt-get update\r
-sudo apt-get install psensor\r
-sudo apt-get install psensor-server</code></pre>\r
-</div></div>\r
-<div class="paragraph"><p>Daily trunk build which may contain major bugs and partialy\r
-implemented features:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><code>sudo apt-get apt-add-repository ppa:/jfi/psensor-daily-trunk\r
-sudo apt-get update\r
-sudo apt-get install psensor\r
-sudo apt-get install psensor-server</code></pre>\r
-</div></div>\r
-</div>\r
-</div>\r
-</div>\r
-<div class="sect1">\r
-<h2 id="_installation_from_source_archive">3. Installation From Source Archive</h2>\r
-<div class="sectionbody">\r
-<div class="paragraph"><p><code>psensor</code> and <code>psensor-server</code> can be compiled and installed on any\r
-modern GNU/Linux distribution.</p></div>\r
-<div class="sect2">\r
-<h3 id="_compilation_prerequisites">3.1. Compilation Prerequisites</h3>\r
-<div class="paragraph"><p>The compilation of <code>psensor</code> requires:</p></div>\r
-<div class="ulist"><ul>\r
-<li>\r
-<p>\r
-make\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-gcc (or llvm)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-lm-sensors\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library sensors4\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library gtk3 &gt;=3.4\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-help2man (optional, required to produce the manpage)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-asciidoc (optional, required to produce the html version of the\r
-   faq)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-cppcheck (optional, static source checker)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library libnotify (optional)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library libappindicator &gt;= 3.0 (optional)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library libXNVCtrl (optional)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library json-c &gt;= 0.11.99 and curl (optional, required for remote monitoring)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library unity (&gt;=v3.4.2, optional)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library gtop2 (optional, required for CPU usage)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library atasmart (optional, for disk monitoring)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library udisk2 (optional, for disk monitoring)\r
-</p>\r
-</li>\r
-</ul></div>\r
-<div class="paragraph"><p>The specific requirements for <code>psensor-server</code>:</p></div>\r
-<div class="ulist"><ul>\r
-<li>\r
-<p>\r
-library libmicrohttpd\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-library json-c &gt;= 0.11.99\r
-</p>\r
-</li>\r
-</ul></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_compilation_and_installation_steps">3.2. Compilation and Installation Steps</h3>\r
-<div class="olist arabic"><ol class="arabic">\r
-<li>\r
-<p>\r
-download the source archive from: <a href="http://wpitchoune.net/psensor/files">http://wpitchoune.net/psensor/files</a>\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-Extract files from the source archive\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-Compilation: <code>./configure;make clean all</code>\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-Installation:  <code>make install</code> (require to have root permission)\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-Start the sensor detection script: <code>sensors-detect</code> and follows the\r
-instructions. Reboot or activate the kernel modules which have\r
-been found.\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-Run: <code>psensor</code>\r
-</p>\r
-</li>\r
-</ol></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_ati_amd_gpu_support">3.3. ATI/AMD GPU Support</h3>\r
-<div class="paragraph"><p>When the OpenSource ATI driver is used, the monitoring\r
-information is available throw lm-sensors and does not require the\r
-following instructions.</p></div>\r
-<div class="paragraph"><p>When the proprietary ATI driver(Catalyst) is used, the build is\r
-requiring an additional library.</p></div>\r
-<div class="paragraph"><p>Download the\r
-<a href="http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx">ATI ADL SDK</a>\r
-and extracts the files of the archive into a directory [dir].</p></div>\r
-<div class="paragraph"><p>Replace the step 3. of the above section by <code>./configure\r
---with-libatiadl=[dir]</code> where <code>[dir]</code> must be the directory where you\r
-have extracted the ATI ADL SDK. Other steps are indentical.</p></div>\r
-</div>\r
-</div>\r
-</div>\r
-<div class="sect1">\r
-<h2 id="_contact">4. Contact</h2>\r
-<div class="sectionbody">\r
-<div class="paragraph"><p>Bugs and comments can be sent to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p></div>\r
-<div class="paragraph"><p>Home page: <a href="http://wpitchoune.net/psensor">http://wpitchoune.net/psensor</a></p></div>\r
-</div>\r
-</div>\r
-</div>\r
-<div id="footnotes"><hr /></div>\r
-<div id="footer">\r
-<div id="footer-text">\r
-Last updated\r
- 2016-06-05 13:12:53 CEST\r
-</div>\r
-</div>\r
-</body>\r
-</html>\r