summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Larabel <michael@phx-laptop.(none)>2008-05-30 18:35:34 -0400
committerMichael Larabel <michael@phx-laptop.(none)>2008-05-30 18:35:34 -0400
commitdb38764aad336ca84b4276bd1408f92bec04a1ec (patch)
tree78df511e3da075de67b0b5750f3c89d37daf4c39
parent57790e6294e857bcd0919ec7c3bc4dd034eba484 (diff)
downloadphoronix-test-suite-upstream-db38764aad336ca84b4276bd1408f92bec04a1ec.tar.gz
phoronix-test-suite-upstream-db38764aad336ca84b4276bd1408f92bec04a1ec.tar.xz
phoronix-test-suite-upstream-db38764aad336ca84b4276bd1408f92bec04a1ec.zip
Update PTS Options documentation and add sensor monitoring documentation
l---------README1
-rw-r--r--README.html1
-rw-r--r--documentation/index.html3
-rw-r--r--documentation/pts_options.html2
-rw-r--r--documentation/sensor_monitoring.html46
5 files changed, 51 insertions, 2 deletions
diff --git a/README b/README
deleted file mode 120000
index fa37ede..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-documentation/index.html \ No newline at end of file
diff --git a/README.html b/README.html
new file mode 100644
index 0000000..ec96bfb
--- /dev/null
+++ b/README.html
@@ -0,0 +1 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><title>Phoronix Test Suite</title><meta http-equiv="REFRESH" content="0;url=documentation/index.html"></HEAD><BODY></BODY></HTML>
diff --git a/documentation/index.html b/documentation/index.html
index 7091962..78231cb 100644
--- a/documentation/index.html
+++ b/documentation/index.html
@@ -34,11 +34,12 @@ PTS Global allows you to browse all uploaded results, search these results, and
Suite as either a developer, profile/suite maintainer for your favorite software
package(s) (or other software that you develop), or support for your company, please contact <em>phoronix [at] phoronix.com</em>.</p>
<p>Additionally, there are the <a href="http://www.phoronix.com/forums/forumdisplay.php?f=49">Phoronix Test Suite Forums</a> for support questions and related discussions as well as the <a href="http://phoronix-test-suite.com/mailman/listinfo/trondheim-pts_phoronix-test-suite.com">Phoronix Test Suite mailing list</a>.</p>
+<h3><a href="10_press_release.html">Phoronix Test Suite 1.0 Press Release</a></h3>
<h2>Documentation</h2>
<h3><a href="install.html">Installation</a></h3>
<h3><a href="pts_options.html">Explanation Of User Options</a></h3>
<h3><a href="writing_your_first_test.html">Writing Your First Test Profile</a></h3>
-<h3><a href="10_press_release.html">1.0 Press Release</a></h3>
+<h3><a href="sensor_monitoring.html">System Sensor Monitoring</a></h3>
<h3><a href="credits.html">Development Credits</a></h3>
<h2>XML Syntax / Specifications</h2>
<h3><a href="specifications_xml_test.html">Test Profile</a></h3>
diff --git a/documentation/pts_options.html b/documentation/pts_options.html
index 5ebed3e..a89a6cf 100644
--- a/documentation/pts_options.html
+++ b/documentation/pts_options.html
@@ -137,6 +137,8 @@ This option can be used when making modifications to the graphing code or its
color/option configuration file and testing the changes.</p>
<p><strong>initial-config</strong></p>
<p>This option will generate a new user configuration (user-config.xml) file.</p>
+<p><strong>sensors</strong></p>
+<p>Show sensors detected by the Phoronix Test Suite and read their current values.</p>
<!-- END OF PTS AREA -->
</div></div><div class="pts_doc_fixed"><div class="pts_doc_bottom"><div style="float: left;"><a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a></div><div style="float: right;">Copyright &copy; 2008 by <a href="http://www.phoronixmedia.com/">Phoronix Media</a>.</div></div></div>
</body>
diff --git a/documentation/sensor_monitoring.html b/documentation/sensor_monitoring.html
new file mode 100644
index 0000000..11f1e32
--- /dev/null
+++ b/documentation/sensor_monitoring.html
@@ -0,0 +1,46 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<Title>Phoronix Test Suite - System Sensor Monitoring</Title>
+<link href="includes/pts-documentation.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="pts_doc_header"><div class="pts_doc_fixed"><div id="pts_doc_logo"></div></div></div>
+<div class="pts_doc_fixed">
+<div class="pts_doc_notice"><div style="float: left"><a href="index.html">&lt;&lt; Documentation Home</a></div><div style="float: right;">System Sensor Monitoring</div></div>
+<div class="pts_doc_main">
+<!-- PTS AREA -->
+<h1>System Sensor Monitoring</h1>
+<p>The Phoronix Test Suite supports monitoring system sensors to look at trends
+and provide other benefits. The Phoronix Test Suite will automatically monitor
+the selected sensors while each test is running and at the end will then provide
+the low and high thresholds for each sensor as well as the average. In addition,
+the sensor results are then plotted on line graphs and can be viewed through the
+PTS Results Viewer. This sensor detection and monitoring is done through <a href="http://www.lm-sensors.org/">LM_Sensors</a>
+and ACPI interfaces. The GPU sensor monitoring is done through proprietary ATI
+and NVIDIA extensions.</p>
+<p>The Phoronix Test Suite is capable of measuring the GPU temperature, CPU temperature,
+system temperature, battery power consumption, CPU voltage, +3.33V line voltage,
++5.00V line voltage, and +12.00V line voltage. Additional sensors will be supported
+in the future.</p>
+<p>The full list of supported sensor options can be found by running <em>phoronix-test-suite
+sensor-options</em>. The sensors actually detected on the current system and their
+values can be read by running <em>phoronix-test-suite sensors</em>. Selecting
+sensors to monitor is performed through the <em>MONITOR</em> environmental variable.
+As examples, to monitor just the CPU temperature while running the universe suite,
+one would run <em>MONITOR=cpu.temp phoronix-test-suite benchmark universe</em>.
+To monitor all sensors while running the Nexuiz game, one would run <em>MONITOR=all
+phoronix-test-suite benchmark nexuiz</em>. To monitor the temperature and voltage
+of the CPU, run <em>MONITOR=cpu.temp,cpu.voltage phoronix-test-suite benchmark
+universe</em>. This feature works no matter the suite or test being run.</p>
+<p>ACPI will automatically be used if it's supported on the system and LM_Sensors
+will be used if it has previously been installed and configured (by running <em>sensors-detect</em>
+as root).</p>
+<p>Once the test(s) are completed, the sensor statistics are printed to the standard
+output and the user is prompted to view the results with the PTS Results Viewer
+in their web browser. The sensor graphs are saved to their default location of
+<em>~/.phoronix-test-suite/system-monitor/</em>. At this time, sensor results
+are not uploadable to PTS Global.</p>
+<!-- END OF PTS AREA -->
+</div></div><div class="pts_doc_fixed"><div class="pts_doc_bottom"><div style="float: left;"><a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a></div><div style="float: right;">Copyright &copy; 2008 by <a href="http://www.phoronixmedia.com/">Phoronix Media</a>.</div></div></div>
+</body>
+</html>