Summary
Description: Phoronix Test Suite open-source benchmarking development
Last Change: Tue 5/21/13 15:49
Recent Commits
>
--git a/CHANGE-LOG b/CHANGE-LOG
index aa3c96d..c33ae40 100644
--- a/CHANGE-LOG
+++ b/CHANGE-LOG
@@ -1,6 +1,7 @@
PHORONIX TEST SUITE CHANGE-LOG
-Phoronix Test Suite (Git)
+Phoronix Test Suite 4.0
+23 July 2012
- pts-core: Initial implementation of the PTS4 Local Results Viewer
- pts-core: Initial command of ob-test-profile-analyze
diff --git a/README b/README
index 3d5ce4e..e052bd9 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-Phoronix Test Suite 4.0.0m4 <http://www.phoronix-test-suite.com/>
+Phoronix Test Suite 4.0.0 <http://www.phoronix-test-suite.com/>
The Phoronix Test Suite is the most comprehensive testing and benchmarking
platform available for Linux, Solaris, Mac OS X, and BSD operating systems. The
diff --git a/documentation/man-pages/phoronix-test-suite.1 b/documentation/man-pages/phoronix-test-suite.1
index eccfd8e..50e6799 100644
--- a/documentation/man-pages/phoronix-test-suite.1
+++ b/documentation/man-pages/phoronix-test-suite.1
@@ -1,4 +1,4 @@
-.TH phoronix-test-suite 1 "www.phoronix-test-suite.com" "4.0.0m4"
+.TH phoronix-test-suite 1 "www.phoronix-test-suite.com" "4.0.0"
.SH NAME
phoronix-test-suite \- The Phoronix Test Suite is an extensible open-source platform for performing testing and performance evaluation.
.SH SYNOPSIS
@@ -230,6 +230,9 @@ This option can be used for setting an XML value in the Phoronix Test Suite user
This option will display the Phoronix Test Suite client version.
.TP
.SH MODULES
+.B r
+p
+.TP
.B list-modules
This option will list all of the available Phoronix Test Suite modules on this system.
.TP
@@ -239,13 +242,6 @@ This option will show detailed information on a Phoronix Test Suite module such
.B module-setup [Phoronix Test Suite Module]
This option will allow you to configure all available end-user options for a Phoronix Test Suite module. These options are then stored within the user's configuration file. Not all modules may have options that can be configured by the end-user.
.TP
-.B test-module [Phoronix Test Suite Module]
-This option can be used for debugging a Phoronix Test Suite module.
-.TP
-.SH WEB USER INTERFACE
-.B r
-p
-.TP
.SH SEE ALSO
.B Websites:
.br
diff --git a/documentation/phoronix-test-suite.html b/documentation/phoronix-test-suite.html
index baf9c37..a734577 100644
--- a/documentation/phoronix-test-suite.html
+++ b/documentation/phoronix-test-suite.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Phoronix Test Suite v4.0.0m4 - Test Client Documentation</title></head><body><h1>Phoronix Test Suite</h1><hr style="height: 50px; border: 0;"><ol><li><a href="#GettingStarted">Getting Started</a></li><li><a href="#UserOptions">User Options</a></li><li><a href="#ModuleOptions">Module Options</a></li><li><a href="#InstallationInstructions">Installation Instructions</a></li><li><a href="#ExternalDependencies">External Dependencies</a></li><li><a href="#Configuration">Configuration</a></li><li><a href="#GeneralInformation">General Information</a></li><li><a href="#VirtualTestSuites">Virtual Test Suites</a></li><li><a href="#ComponentTesting">Component Testing</a></li><li><a href="#Phoromatic">Phoromatic</a></li><li><a href="#PTSDesktopLive">PTS Desktop Live</a></li><li><a href="#DevelopmentCredits">Development Credits</a></li></ol><hr style="height: 50px; border: 0;"><a name="GettingStarted"></a><h1>Getting Started</h1>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Phoronix Test Suite v4.0.0 - Test Client Documentation</title></head><body><h1>Phoronix Test Suite</h1><hr style="height: 50px; border: 0;"><ol><li><a href="#GettingStarted">Getting Started</a></li><li><a href="#UserOptions">User Options</a></li><li><a href="#ModuleOptions">Module Options</a></li><li><a href="#InstallationInstructions">Installation Instructions</a></li><li><a href="#ExternalDependencies">External Dependencies</a></li><li><a href="#Configuration">Configuration</a></li><li><a href="#GeneralInformation">General Information</a></li><li><a href="#VirtualTestSuites">Virtual Test Suites</a></li><li><a href="#ComponentTesting">Component Testing</a></li><li><a href="#Phoromatic">Phoromatic</a></li><li><a href="#PTSDesktopLive">PTS Desktop Live</a></li><li><a href="#DevelopmentCredits">Development Credits</a></li></ol><hr style="height: 50px; border: 0;"><a name="GettingStarted"></a><h1>Getting Started</h1>
<h1>Overview</h1>
<p>The Phoronix Test Suite is the most comprehensive testing and benchmarking platform available for Linux, Solaris, Mac OS X, and BSD operating systems. The Phoronix Test Suite allows for carrying out tests in a fully automated manner from test installation to execution and reporting. All tests are meant to be easily reproducible, easy-to-use, and support fully automated execution. The Phoronix Test Suite is open-source under the GNU GPLv3 license and is developed by Phoronix Media in cooperation with partners. Version 1.0 of the Phoronix Test Suite was publicly released in 2008.</p>
<p>The Phoronix Test Suite client itself is a test framework for providing seamless execution of test profiles and test suites. There are more than 200 tests available by default, which are transparently available via <a href="http://openbenchmarking.org/">OpenBenchmarking.org</a> integration. Of these default test profiles there is a range of sub-systems that can be tested and a range of hardware from mobile devices to desktops and worksrtations/servers. New tests can be easily introduced via the Phoronix Test Suite's extensible test architecture, with test profiles consisting of XML files and shell scripts. Test profiles can produce a quantitative result or other qualitative/abstract results like image quality comparisons and pass/fail. Using Phoronix Test Suite modules, other data can also be automatically collected at run-time such as the system power consumption, disk usage, and other software/hardware sensors. Test suites contain references to test profiles to execute as part of a set or can also reference other test suites. Test suites are defined via an XML schema.</p>
@@ -10,7 +10,7 @@
<h1>Phoromatic</h1>
<p>Phoromatic is a remote management system for the Phoronix Test Suite that allows the automatic scheduling of tests, remote installation of new tests, and the management of multiple test systems all through an intuitive, easy-to-use web interface. Tests can be scheduled to automatically run on a routine basis across multiple test systems. Phoromatic can also interface with revision control systems to offer support for issuing new tests on a context-basis, such as whenever a Git commit has been pushed or new daily image available. The test results are then available from this central, secure location.</p>
<p>Phoromatic is an add-on to the Phoronix Test Suite that's primarily intended for enterprise users when facilitating tests across a wide-spectrum of hardware within a test lab or when needing to carry out tests on a routine basis.</p>
-<hr style="height: 50px; border: 0;"><a name="UserOptions"></a><h1>User Options</h1><p>The following options are currently supported by the Phoronix Test Suite client. A list of available options can also be found by running <em>phoronix-test-suite help.</em></p><hr><h1>Test Installation</h1><h3>install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) inside the testing environment directory). The install process from downloading of the test files to the installation is fully automated. The install option needs to be supplied with the test name or suite as an argument. Optionally, a OpenBenchmarking.org ID or the name of a saved results file can be supplied as well and the test(s) to install will automatically be extracted from that information. If the test is already installed and was run by the latest version of the installation process, no action will be taken. Multiple arguments can be supplied to install additional tests at the same time.</p><h3>install-dependencies<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the external dependencies needed by the selected test(s) using the distribution's package management system. For example, some tests depend upon GCC for compiling code. If GCC is not detected on the system, the Phoronix Test Suite will attempt to install GCC using the distribution's package management system. If you are running this command as a local user, you may be prompted for the root password while the process is running. For unsupported distributions, the dependency names will be displayed along with common names for the package. The install-dependencies option needs to be supplied with the test name or suite as an argument. When using the install option, the external dependencies are automatically checked.</p><h3>make-download-cache<em> </em></h3><p>This option will create a download cache for use by the Phoronix Test Suite.</p><h3>remove-installed-test<em> [Test]</em></h3><p>This option will permanently remove a installed test by the Phoronix Test Suite.</p><h1>Testing</h1><h3>benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s). This option is equivalent to running phoronix-test-suite with the install option followed by the run option. Multiple arguments can be supplied to run additional tests at the same time and save the results into one file.</p><h3>finish-run<em> [Test Result]</em></h3><p>This option can be used if a test run had not properly finished running all tests within a saved results file. Using this option when specifying a saved results file where all tests had not completed will attempt to finish testing on the remaining tests where there are missing results.</p><h3>run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s).</p><h3>run-tests-in-suite<em> </em></h3><p>This option can be used if you wish to run all of the tests found in a supplied suite, but you wish to re-configure each of the test options rather than using the defaults supplied by the suite.</p><h1>Batch Testing</h1><h3>batch-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the benchmark option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>If you wish to run the install process in the Phoronix Test Suite batch mode but do not wish to run any tests at this time. Running the install process in the batch mode will use the default values and not prompt the user of any possible options, to ensure the process is fully automated.</p><h3>batch-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the run option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-setup<em> </em></h3><p>This option is used to configure the batch mode options for the Phoronix Test Suite, which is subsequently written to the user configuration file. Among the options are whether to automatically upload the test results to OpenBenchmarking.org and prompting for the saved file name.</p><h3>default-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s) in the defaults mode. This option is equivalent to running phoronix-test-suite with the install option followed by the default-run option.</p><h3>default-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s). The name of the test or suite must be supplied or the OpenBenchmarking.org ID or saved local file name. Multiple arguments can be supplied to run additional tests at the same time and save the results in a suite-like fashion. Unlike the normal run option, the default-run will not prompt the user to select from the available test options but will instead use the default options as automatically set by pts-core or the test profile. Use batch-run to automatically test all of the available options.</p><h1>OpenBenchmarking.org</h1><h3>clone-result<em> [OpenBenchmarking ID] ...</em></h3><p>This option will download a local copy of a file that was saved to OpenBenchmarking.org, as long as a valid public ID is supplied. More than one ID can be specified and the results will then be merged.</p><h3>openbenchmarking-changes<em> </em></h3><p>This option will list recent changes to test profiles of enabled OpenBenchmarking.org repositories.</p><h3>openbenchmarking-launcher<em> </em></h3><p>This option is called automatically with the .openbenchmarking MIME file extension support for launching OpenBenchmarking.org operations.</p><h3>openbenchmarking-login<em> </em></h3><p>This option is used for controlling your Phoronix Test Suite client options for OpenBechmarking.org and syncing the client to your account.</p><h3>openbenchmarking-refresh<em> </em></h3><p>This option is used for refreshing the stored OpenBenchmarking.org repostory information and other data. The Phoronix Test Suite will automatically refresh this data every three days or when other thresholds are exceeded, but this command can be used to manually refresh/updates the data.</p><h3>openbenchmarking-repositories<em> </em></h3><p>This option will list the OpenBenchmarking.org repositories currently linked to this Phoronix Test Suite client instance.</p><h3>upload-result<em> [Test Result]</em></h3><p>This option is used for uploading a test result to OpenBenchmarking.org.</p><h3>upload-test-profile<em> </em></h3><p>This option can be used for uploading a test profile to your account on OpenBenchmarking.org. By uploading your test profile to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution in a seamless manner by other Phoronix Test Suite clients.</p><h3>upload-test-suite<em> </em></h3><p>This option can be used for uploading a test suite to your account on OpenBenchmarking.org. By uploading your test suite to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution.</p><h1>System</h1><h3>detailed-system-info<em> </em></h3><p>Display detailed information about the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>diagnostics<em> </em></h3><p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p><h3>interactive<em> </em></h3><p>A simple text-driven interactive interface to the Phoronix Test Suite.</p><h3>system-info<em> </em></h3><p>Display the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>system-sensors<em> </em></h3><p>Display the installed system hardware and software sensors in real-time as detected by the Phoronix Test Suite Phodevi Library.</p><h1>Information</h1><h3>info<em> [Test | Suite | OpenBenchmarking.org ID | Test Result]</em></h3><p>This option will show details about the supplied test, suite, virtual suite, or result file.</p><h3>list-available-suites<em> </em></h3><p>This option will list all available test suites that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-tests<em> </em></h3><p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-virtual-suites<em> </em></h3><p>This option will list all available virtual test suites that can be dynamically created based upon the available tests from enabled OpenBenchmarking.org repositories.</p><h3>list-installed-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are already installed on the system that the Phoronix Test Suite may potentially depend upon by test profiles.</p><h3>list-installed-suites<em> </em></h3><p>This option will list all suites that are currently installed on the system.</p><h3>list-installed-tests<em> </em></h3><p>This option will list all test profiles that are currently installed on the system.</p><h3>list-missing-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are missing from the system that the Phoronix Test Suite may potentially need by select test profiles.</p><h3>list-possible-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are are potentially used by the Phoronix Test Suite.</p><h3>list-saved-results<em> </em></h3><p>This option will list all of the saved test results found on the system.</p><h3>list-test-usage<em> </em></h3><p>This option will list various details about installed tests and their usage.</p><h1>Asset Creation</h1><h3>debug-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the install option but will yield more information during the run process that can be used to debug issues with a test profile installer or to verify the test profile is functioning correctly.</p><h3>debug-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the <em>run</em> option but will yield more information during the run process that can be used to debug issues with a test profile or to verify the test profile is functioning correctly.</p><h3>debug-test-download-links<em> [Test | Suite]</em></h3><p>This option will check all download links within the specified test profile(s) to ensure there are no broken URLs.</p><h3>download-test-files<em> [Test | Suite] ...</em></h3><p>This will download the selected test file(s) to the Phoronix Test Suite download cache but will not install the tests.</p><h3>force-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will force the installation (or re-installation) of a test or suite. The arguments and process is similar to the install option but even if the test is installed, the entire installation process will automatically be executed. This option is generally used when debugging a test installation problem.</p><h3>result-file-to-suite<em> [Test Result]</em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run, that is based upon an existing test results file.</p><h3>validate-result-file<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite result file as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-profile<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test profile as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-suite<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test suite as being compliant against the OpenBenchmarking.org specification.</p><h1>Result Management</h1><h3>copy-run-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change an existing test run within a saved results file.</p><h3>extract-from-result-file<em> [Test Result]</em></h3><p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract.</p><h3>merge-results<em> [Test Result] ...</em></h3><p>This option will manually merge multiple sets of test results generated by the Phoronix Test Suite.</p><h3>refresh-graphs<em> [Test Result]</em></h3><p>This option will re-render and save all result graphs within a saved file. This option can be used when making modifications to the graphing code or its color/option configuration file and testing the changes.</p><h3>remove-from-result-file<em> [Test Result]</em></h3><p>This option is used if there is a set of test results you wish to remove/delete from a saved results file. The user must specify a saved results file and then they will be prompted to select the results identifier associated with the results they wish to remove.</p><h3>remove-result<em> [Test Result]</em></h3><p>This option will permanently remove the saved file set that is set as the first argument.</p><h3>rename-identifier-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the name of the identifier in a test results file that is shown in the Phoronix Test Suite Results Viewer and the contained graphs.</p><h3>reorder-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the order in which test results are shown in the Phoronix Test Suite Results Viewer and the contained graphs. The user must specify a saved results file and then they will be prompted to select the results identifiers one at a time in the order they would like them to be displayed from left to right.</p><h3>result-file-to-csv<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing.</p><h3>result-file-to-pdf<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a PDF file.</p><h3>result-file-to-text<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information to the terminal. The test results are also outputted.</p><h3>show-result<em> [Test Result]</em></h3><p>Open up the test results in the Phoronix Test Suite Result Viewer or on OpenBenchmarking.org.</p><h1>Result Analytics</h1><h3>analyze-all-runs<em> [Test Result]</em></h3><p>This option will generate a candlestick graph showing the distribution of results from all trial runs. The candlestick graph is similar to the Japanese candlestick charts used by the financial industry, except instead of representing stock data it is numerical result data from all trial runs.\n\nThe tip of the upper-wick represents the highest value of the test runs with the tip of the lower-wick representing the lowest value of all test runs. The upper-edge of the candle body represents the first or last run value and the lower-edge represents the first or last run value. Lastly, if the last run value is less than the first run value, the candle body is the same color as the graph background, otherwise the last run value is greater.</p><h3>analyze-batch<em> [Test Result]</em></h3><p>This option will analyze a batch results file and plot out the performance impact from the different options onto a line graph (i.e. to see the impact that changing the video resolution has on the system's performance).</p><h3>analyze-image-delta<em> [Test Result]</em></h3><p>This option will analyze a test result file if it contains any test results that produced an image quality comparison (IQC) and will render image deltas illustrating the difference between images from two test results.</p><h1>Other</h1><h3>build-suite<em> </em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run. Optionally, passed as arguments can be the test(s) or suite(s) to add to the suite to be created, instead of being prompted through the process.</p><h3>help<em> </em></h3><p>This option will display the list of available Phoronix Test Suite commands.</p><h3>network-setup<em> </em></h3><p>This option allows the user to configure how the Phoronix Test Suite connects to OpenBenchmarking.org and other web-services. Connecting through an HTTP proxy can be configured through this option.</p><h3>rebuild-composite-xml<em> [Test Result]</em></h3><p>This option can be used to rebuild your composite XML file in the event that the main result file was corrupted and the test-X.xml files are still present in the result file directory.</p><h3>user-config-reset<em> </em></h3><p>This option can be used for resetting the Phoronix Test Suite user configuration file to its default state.</p><h3>user-config-set<em> </em></h3><p>This option can be used for setting an XML value in the Phoronix Test Suite user configuration file.</p><h3>version<em> </em></h3><p>This option will display the Phoronix Test Suite client version.</p><h1>Modules</h1><h3>list-modules<em> </em></h3><p>This option will list all of the available Phoronix Test Suite modules on this system.</p><h3>module-info<em> [Phoronix Test Suite Module]</em></h3><p>This option will show detailed information on a Phoronix Test Suite module such as the version, developer, and a description of its purpose.</p><h3>module-setup<em> [Phoronix Test Suite Module]</em></h3><p>This option will allow you to configure all available end-user options for a Phoronix Test Suite module. These options are then stored within the user's configuration file. Not all modules may have options that can be configured by the end-user.</p><h3>test-module<em> [Phoronix Test Suite Module]</em></h3><p>This option can be used for debugging a Phoronix Test Suite module.</p><h1>Web User Interface</h1><h3>webui<em> </em></h3><p>Launch the Phoronix Test Suite web user-interface.</p><hr style="height: 50px; border: 0;"><a name="ModuleOptions"></a><h1>Module Options</h1><p>The following list is the modules included with the Phoronix Test Suite that are intended to extend the functionality of pts-core. Some of these options have commands that can be run directly in a similiar manner to the other Phoronix Test Suite user commands. Some modules are just meant to be loaded directly by adding the module name to the LoadModules tag in ~/.phoronix-test-suite/user-config.xml or via the PTS_MODULES environmental variable. A list of available modules is also available by running <em>phoronix-test-suite list-modules.</em></p><hr><h2>Dummy Module</h2><p>This is a simple module intended for developers to just demonstrate some of the module functions.</p><p>phoronix-test-suite dummy_module.dummy-command</p><h2>OpenBenchmarking.org Ekofisk</h2><p>The Ekofisk client is used for connecting to OpenBenchmarking.org to facilitate the automatic running of tests, generally across multiple test nodes in a routine manner.</p><p>phoronix-test-suite ekofisk.start</p><p>phoronix-test-suite ekofisk.user-system-return</p><h2>Graphics Event Checker</h2><p>This module checks a number of events prior to and and after running a test to make sure the graphics sub-system was not put in a sour or unintended state by the application. For instance, it makes sure syncing to vBlank is not forced through the driver and that a graphics test has not left the display in an unintended mode.</p><h2>Graphics Override</h2><p>This module allows you to override some graphics rendering settings for the ATI and NVIDIA drivers while running the Phoronix Test Suite.</p><p>This module utilizes the following environmental variables: FORCE_AA, FORCE_AF.</p><h2>MATISK</h2><p>My Automated Test Infrastructure Setup Kit</p><p>phoronix-test-suite matisk.run</p><p>phoronix-test-suite matisk.template</p><h2>Phoromatic Client</h2><p>The Phoromatic client is used for connecting to a Phoromatic server (Phoromatic.com or a locally run server) to facilitate the automatic running of tests, generally across multiple test nodes in a routine manner. For more details visit http://www.phoromatic.com/</p><p>phoronix-test-suite phoromatic.start</p><p>phoronix-test-suite phoromatic.user-system-return</p><p>phoronix-test-suite phoromatic.upload-results</p><p>phoronix-test-suite phoromatic.clone-results</p><p>phoronix-test-suite phoromatic.system-schedule</p><p>phoronix-test-suite phoromatic.system-schedule-today</p><p>phoronix-test-suite phoromatic.send-message</p><h2>Result Notifier</h2><p>A notification module.</p><h2>System Monitor</h2><p>This module contains sensor monitoring support.</p><p>This module utilizes the following environmental variables: MONITOR, PERFORMANCE_PER_WATT.</p><h2>Timed Screenshot</h2><p>This is a module that will take a screenshot of the system at a pre-defined interval. ImageMagick must be installed onto the system prior to using this module.</p><p>This module utilizes the following environmental variables: SCREENSHOT_INTERVAL.</p><h2>Toggle Screensaver</h2><p>This module toggles the system's screensaver while the Phoronix Test Suite is running. At this time, the GNOME and KDE screensavers are supported.</p><p>This module utilizes the following environmental variables: HALT_SCREENSAVER.</p><h2>Update Checker</h2><p>This module checks to see if the Phoronix Test Suite -- and its tests and suites -- are up to date.</p><hr style="height: 50px; border: 0;"><a name="InstallationInstructions"></a><h1>Installation Instructions</h1>
+<hr style="height: 50px; border: 0;"><a name="UserOptions"></a><h1>User Options</h1><p>The following options are currently supported by the Phoronix Test Suite client. A list of available options can also be found by running <em>phoronix-test-suite help.</em></p><hr><h1>Test Installation</h1><h3>install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) inside the testing environment directory). The install process from downloading of the test files to the installation is fully automated. The install option needs to be supplied with the test name or suite as an argument. Optionally, a OpenBenchmarking.org ID or the name of a saved results file can be supplied as well and the test(s) to install will automatically be extracted from that information. If the test is already installed and was run by the latest version of the installation process, no action will be taken. Multiple arguments can be supplied to install additional tests at the same time.</p><h3>install-dependencies<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the external dependencies needed by the selected test(s) using the distribution's package management system. For example, some tests depend upon GCC for compiling code. If GCC is not detected on the system, the Phoronix Test Suite will attempt to install GCC using the distribution's package management system. If you are running this command as a local user, you may be prompted for the root password while the process is running. For unsupported distributions, the dependency names will be displayed along with common names for the package. The install-dependencies option needs to be supplied with the test name or suite as an argument. When using the install option, the external dependencies are automatically checked.</p><h3>make-download-cache<em> </em></h3><p>This option will create a download cache for use by the Phoronix Test Suite.</p><h3>remove-installed-test<em> [Test]</em></h3><p>This option will permanently remove a installed test by the Phoronix Test Suite.</p><h1>Testing</h1><h3>benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s). This option is equivalent to running phoronix-test-suite with the install option followed by the run option. Multiple arguments can be supplied to run additional tests at the same time and save the results into one file.</p><h3>finish-run<em> [Test Result]</em></h3><p>This option can be used if a test run had not properly finished running all tests within a saved results file. Using this option when specifying a saved results file where all tests had not completed will attempt to finish testing on the remaining tests where there are missing results.</p><h3>run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s).</p><h3>run-tests-in-suite<em> </em></h3><p>This option can be used if you wish to run all of the tests found in a supplied suite, but you wish to re-configure each of the test options rather than using the defaults supplied by the suite.</p><h1>Batch Testing</h1><h3>batch-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the benchmark option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>If you wish to run the install process in the Phoronix Test Suite batch mode but do not wish to run any tests at this time. Running the install process in the batch mode will use the default values and not prompt the user of any possible options, to ensure the process is fully automated.</p><h3>batch-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the run option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-setup<em> </em></h3><p>This option is used to configure the batch mode options for the Phoronix Test Suite, which is subsequently written to the user configuration file. Among the options are whether to automatically upload the test results to OpenBenchmarking.org and prompting for the saved file name.</p><h3>default-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s) in the defaults mode. This option is equivalent to running phoronix-test-suite with the install option followed by the default-run option.</p><h3>default-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s). The name of the test or suite must be supplied or the OpenBenchmarking.org ID or saved local file name. Multiple arguments can be supplied to run additional tests at the same time and save the results in a suite-like fashion. Unlike the normal run option, the default-run will not prompt the user to select from the available test options but will instead use the default options as automatically set by pts-core or the test profile. Use batch-run to automatically test all of the available options.</p><h1>OpenBenchmarking.org</h1><h3>clone-result<em> [OpenBenchmarking ID] ...</em></h3><p>This option will download a local copy of a file that was saved to OpenBenchmarking.org, as long as a valid public ID is supplied. More than one ID can be specified and the results will then be merged.</p><h3>openbenchmarking-changes<em> </em></h3><p>This option will list recent changes to test profiles of enabled OpenBenchmarking.org repositories.</p><h3>openbenchmarking-launcher<em> </em></h3><p>This option is called automatically with the .openbenchmarking MIME file extension support for launching OpenBenchmarking.org operations.</p><h3>openbenchmarking-login<em> </em></h3><p>This option is used for controlling your Phoronix Test Suite client options for OpenBechmarking.org and syncing the client to your account.</p><h3>openbenchmarking-refresh<em> </em></h3><p>This option is used for refreshing the stored OpenBenchmarking.org repostory information and other data. The Phoronix Test Suite will automatically refresh this data every three days or when other thresholds are exceeded, but this command can be used to manually refresh/updates the data.</p><h3>openbenchmarking-repositories<em> </em></h3><p>This option will list the OpenBenchmarking.org repositories currently linked to this Phoronix Test Suite client instance.</p><h3>upload-result<em> [Test Result]</em></h3><p>This option is used for uploading a test result to OpenBenchmarking.org.</p><h3>upload-test-profile<em> </em></h3><p>This option can be used for uploading a test profile to your account on OpenBenchmarking.org. By uploading your test profile to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution in a seamless manner by other Phoronix Test Suite clients.</p><h3>upload-test-suite<em> </em></h3><p>This option can be used for uploading a test suite to your account on OpenBenchmarking.org. By uploading your test suite to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution.</p><h1>System</h1><h3>detailed-system-info<em> </em></h3><p>Display detailed information about the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>diagnostics<em> </em></h3><p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p><h3>interactive<em> </em></h3><p>A simple text-driven interactive interface to the Phoronix Test Suite.</p><h3>system-info<em> </em></h3><p>Display the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>system-sensors<em> </em></h3><p>Display the installed system hardware and software sensors in real-time as detected by the Phoronix Test Suite Phodevi Library.</p><h1>Information</h1><h3>info<em> [Test | Suite | OpenBenchmarking.org ID | Test Result]</em></h3><p>This option will show details about the supplied test, suite, virtual suite, or result file.</p><h3>list-available-suites<em> </em></h3><p>This option will list all available test suites that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-tests<em> </em></h3><p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-virtual-suites<em> </em></h3><p>This option will list all available virtual test suites that can be dynamically created based upon the available tests from enabled OpenBenchmarking.org repositories.</p><h3>list-installed-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are already installed on the system that the Phoronix Test Suite may potentially depend upon by test profiles.</p><h3>list-installed-suites<em> </em></h3><p>This option will list all suites that are currently installed on the system.</p><h3>list-installed-tests<em> </em></h3><p>This option will list all test profiles that are currently installed on the system.</p><h3>list-missing-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are missing from the system that the Phoronix Test Suite may potentially need by select test profiles.</p><h3>list-possible-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are are potentially used by the Phoronix Test Suite.</p><h3>list-saved-results<em> </em></h3><p>This option will list all of the saved test results found on the system.</p><h3>list-test-usage<em> </em></h3><p>This option will list various details about installed tests and their usage.</p><h1>Asset Creation</h1><h3>debug-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the install option but will yield more information during the run process that can be used to debug issues with a test profile installer or to verify the test profile is functioning correctly.</p><h3>debug-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the <em>run</em> option but will yield more information during the run process that can be used to debug issues with a test profile or to verify the test profile is functioning correctly.</p><h3>debug-test-download-links<em> [Test | Suite]</em></h3><p>This option will check all download links within the specified test profile(s) to ensure there are no broken URLs.</p><h3>download-test-files<em> [Test | Suite] ...</em></h3><p>This will download the selected test file(s) to the Phoronix Test Suite download cache but will not install the tests.</p><h3>force-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will force the installation (or re-installation) of a test or suite. The arguments and process is similar to the install option but even if the test is installed, the entire installation process will automatically be executed. This option is generally used when debugging a test installation problem.</p><h3>result-file-to-suite<em> [Test Result]</em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run, that is based upon an existing test results file.</p><h3>validate-result-file<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite result file as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-profile<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test profile as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-suite<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test suite as being compliant against the OpenBenchmarking.org specification.</p><h1>Result Management</h1><h3>copy-run-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change an existing test run within a saved results file.</p><h3>extract-from-result-file<em> [Test Result]</em></h3><p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract.</p><h3>merge-results<em> [Test Result] ...</em></h3><p>This option will manually merge multiple sets of test results generated by the Phoronix Test Suite.</p><h3>refresh-graphs<em> [Test Result]</em></h3><p>This option will re-render and save all result graphs within a saved file. This option can be used when making modifications to the graphing code or its color/option configuration file and testing the changes.</p><h3>remove-from-result-file<em> [Test Result]</em></h3><p>This option is used if there is a set of test results you wish to remove/delete from a saved results file. The user must specify a saved results file and then they will be prompted to select the results identifier associated with the results they wish to remove.</p><h3>remove-result<em> [Test Result]</em></h3><p>This option will permanently remove the saved file set that is set as the first argument.</p><h3>rename-identifier-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the name of the identifier in a test results file that is shown in the Phoronix Test Suite Results Viewer and the contained graphs.</p><h3>reorder-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the order in which test results are shown in the Phoronix Test Suite Results Viewer and the contained graphs. The user must specify a saved results file and then they will be prompted to select the results identifiers one at a time in the order they would like them to be displayed from left to right.</p><h3>result-file-to-csv<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing.</p><h3>result-file-to-pdf<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a PDF file.</p><h3>result-file-to-text<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information to the terminal. The test results are also outputted.</p><h3>show-result<em> [Test Result]</em></h3><p>Open up the test results in the Phoronix Test Suite Result Viewer or on OpenBenchmarking.org.</p><h1>Result Analytics</h1><h3>analyze-all-runs<em> [Test Result]</em></h3><p>This option will generate a candlestick graph showing the distribution of results from all trial runs. The candlestick graph is similar to the Japanese candlestick charts used by the financial industry, except instead of representing stock data it is numerical result data from all trial runs.\n\nThe tip of the upper-wick represents the highest value of the test runs with the tip of the lower-wick representing the lowest value of all test runs. The upper-edge of the candle body represents the first or last run value and the lower-edge represents the first or last run value. Lastly, if the last run value is less than the first run value, the candle body is the same color as the graph background, otherwise the last run value is greater.</p><h3>analyze-batch<em> [Test Result]</em></h3><p>This option will analyze a batch results file and plot out the performance impact from the different options onto a line graph (i.e. to see the impact that changing the video resolution has on the system's performance).</p><h3>analyze-image-delta<em> [Test Result]</em></h3><p>This option will analyze a test result file if it contains any test results that produced an image quality comparison (IQC) and will render image deltas illustrating the difference between images from two test results.</p><h1>Other</h1><h3>build-suite<em> </em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run. Optionally, passed as arguments can be the test(s) or suite(s) to add to the suite to be created, instead of being prompted through the process.</p><h3>help<em> </em></h3><p>This option will display the list of available Phoronix Test Suite commands.</p><h3>network-setup<em> </em></h3><p>This option allows the user to configure how the Phoronix Test Suite connects to OpenBenchmarking.org and other web-services. Connecting through an HTTP proxy can be configured through this option.</p><h3>rebuild-composite-xml<em> [Test Result]</em></h3><p>This option can be used to rebuild your composite XML file in the event that the main result file was corrupted and the test-X.xml files are still present in the result file directory.</p><h3>user-config-reset<em> </em></h3><p>This option can be used for resetting the Phoronix Test Suite user configuration file to its default state.</p><h3>user-config-set<em> </em></h3><p>This option can be used for setting an XML value in the Phoronix Test Suite user configuration file.</p><h3>version<em> </em></h3><p>This option will display the Phoronix Test Suite client version.</p><h1>Modules</h1><h3>list-modules<em> </em></h3><p>This option will list all of the available Phoronix Test Suite modules on this system.</p><h3>module-info<em> [Phoronix Test Suite Module]</em></h3><p>This option will show detailed information on a Phoronix Test Suite module such as the version, developer, and a description of its purpose.</p><h3>module-setup<em> [Phoronix Test Suite Module]</em></h3><p>This option will allow you to configure all available end-user options for a Phoronix Test Suite module. These options are then stored within the user's configuration file. Not all modules may have options that can be configured by the end-user.</p><h3>test-module<em> [Phoronix Test Suite Module]</em></h3><p>This option can be used for debugging a Phoronix Test Suite module.</p><hr style="height: 50px; border: 0;"><a name="ModuleOptions"></a><h1>Module Options</h1><p>The following list is the modules included with the Phoronix Test Suite that are intended to extend the functionality of pts-core. Some of these options have commands that can be run directly in a similiar manner to the other Phoronix Test Suite user commands. Some modules are just meant to be loaded directly by adding the module name to the LoadModules tag in ~/.phoronix-test-suite/user-config.xml or via the PTS_MODULES environmental variable. A list of available modules is also available by running <em>phoronix-test-suite list-modules.</em></p><hr><h2>Dummy Module</h2><p>This is a simple module intended for developers to just demonstrate some of the module functions.</p><p>phoronix-test-suite dummy_module.dummy-command</p><h2>OpenBenchmarking.org Ekofisk</h2><p>The Ekofisk client is used for connecting to OpenBenchmarking.org to facilitate the automatic running of tests, generally across multiple test nodes in a routine manner.</p><p>phoronix-test-suite ekofisk.start</p><p>phoronix-test-suite ekofisk.user-system-return</p><h2>Graphics Event Checker</h2><p>This module checks a number of events prior to and and after running a test to make sure the graphics sub-system was not put in a sour or unintended state by the application. For instance, it makes sure syncing to vBlank is not forced through the driver and that a graphics test has not left the display in an unintended mode.</p><h2>Graphics Override</h2><p>This module allows you to override some graphics rendering settings for the ATI and NVIDIA drivers while running the Phoronix Test Suite.</p><p>This module utilizes the following environmental variables: FORCE_AA, FORCE_AF.</p><h2>MATISK</h2><p>My Automated Test Infrastructure Setup Kit</p><p>phoronix-test-suite matisk.run</p><p>phoronix-test-suite matisk.template</p><h2>Phoromatic Client</h2><p>The Phoromatic client is used for connecting to a Phoromatic server (Phoromatic.com or a locally run server) to facilitate the automatic running of tests, generally across multiple test nodes in a routine manner. For more details visit http://www.phoromatic.com/</p><p>phoronix-test-suite phoromatic.start</p><p>phoronix-test-suite phoromatic.user-system-return</p><p>phoronix-test-suite phoromatic.upload-results</p><p>phoronix-test-suite phoromatic.clone-results</p><p>phoronix-test-suite phoromatic.system-schedule</p><p>phoronix-test-suite phoromatic.system-schedule-today</p><p>phoronix-test-suite phoromatic.send-message</p><h2>Result Notifier</h2><p>A notification module.</p><h2>System Monitor</h2><p>This module contains sensor monitoring support.</p><p>This module utilizes the following environmental variables: MONITOR, PERFORMANCE_PER_WATT.</p><h2>Timed Screenshot</h2><p>This is a module that will take a screenshot of the system at a pre-defined interval. ImageMagick must be installed onto the system prior to using this module.</p><p>This module utilizes the following environmental variables: SCREENSHOT_INTERVAL.</p><h2>Toggle Screensaver</h2><p>This module toggles the system's screensaver while the Phoronix Test Suite is running. At this time, the GNOME and KDE screensavers are supported.</p><p>This module utilizes the following environmental variables: HALT_SCREENSAVER.</p><h2>Update Checker</h2><p>This module checks to see if the Phoronix Test Suite -- and its tests and suites -- are up to date.</p><hr style="height: 50px; border: 0;"><a name="InstallationInstructions"></a><h1>Installation Instructions</h1>
<h1>Setup Overview</h1>
<p>The Phoronix Test Suite supports Linux, Apple Mac OS X, Microsoft Windows, Solaris, Hurd, BSD, and other operating system environments. The only Linux distribution-specific code deals with the external dependencies support feature that are set by individual test profiles. If you are not running one of the supported Linux distributions, Solaris, BSD, or Mac OS X, you may need to install a package manually (as instructed by the Phoronix Test Suite) in order for a test to run. An example of an external dependency would be GCC and the OpenGL Utility Toolkit being needed for test profiles that build an OpenGL benchmark from source-code.</p>
<p>Among the distributions where the Phoronix Test Suite has been officially tested include Ubuntu, Fedora, Mandriva / Mageia, Gentoo, PCLinuxOS, Arch Linux, Pardus, OpenSuSE, Optware, webOS, Zenwalk, CentOS, Red Hat Enterprise Linux, Oracle Linux, Scientific Linux, Debian, Mint, MEPIS, and Amazon Linux EC2.</p>
@@ -34,7 +34,7 @@
<p>Major updates to the Phoronix Test Suite are released on a quarterly basis. The latest stable and development versions of the Phoronix Test Suite are available at <a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a>. The Git repository where the latest Phoronix Test Suite code is provided is hosted at <a href="http://www.phorogit.com/">Phorogit.com</a> and can be cloned/pulled from the <em>http://www.phorogit.com/repo/phoronix-test-suite.git</em> repository. The latest upstream development code is housed in the master tree while older Phoronix Test Suite releases are available in their respective Git branches based upon the release's code-name.</p>
<p>If building the PHP package from upstream sources, it should just be a matter of running <em>./configure</em> with the <em>--enable-zip</em> flag (all other requirements should be apart of the stock PHP configuration) to satisfy the PHP needs of the Phoronix Test Suite.</p>
<h2>File Structure</h2>
-<p>If manually changing the location of the <em>phoronix-test-suite</em> launcher file, the <em>PTS_USER_PATH</em> environmental variable must be adjusted inside the file to reflect the absolute location that leads to the root directory of the <em>pts</em> and <em>pts-core</em> folders. The <em>pts-core</em> directory contains the "engine" of the Phoronix Test Suite.</p>
+<p>If manually changing the location of the <em>phoronix-test-suite</em> launcher file, the <em>PTS_USER_PATH</em> environment variable must be adjusted inside the file to reflect the absolute location that leads to the root directory of the <em>pts</em> and <em>pts-core</em> folders. The <em>pts-core</em> directory contains the "engine" of the Phoronix Test Suite.</p>
<h2>Running Locally</h2>
<p>The Phoronix Test Suite can be simply extracted from the downloaded <em>.tar.gz</em> or <em>.zip</em> file or it can also be installed system-wide. If you just wish to run the Phoronix Test Suite without installing it, open a terminal and run <em>./phoronix-test-suite <options></em> from the same directory.</p>
<h2>Generic Installation</h2>
@@ -59,7 +59,7 @@
<p>The Phoronix Test Suite support on Windows is in development and will function just fine, but is not yet feature complete compared to the other operating systems support. At this time the Phoronix Test Suite client is dependent upon PHP being installed to <em>C:\Program Files (x86)\PHP\php</em>. The Phoronix Test Suite also uses <a href="http://www.cpuid.com/cpuz.php">CPU-Z</a> for much of the hardware detection support on Windows and is dependent upon CPU-Z being installed to <em>C:\Program Files\CPUID\CPU-Z\cpuz.exe</em> if you wish to utilize this hardware reporting feature. In terms of the Microsoft Windows support, right now the Phoronix Test Suite is developed and solely tested against Windows 7 x64.</p>
<h2>Facebook HipHop</h2>
<p>The Phoronix Test Suite can also be transformed/compiled from PHP into C++ using <a href="https://github.com/facebook/hiphop-php">Facebook's HipHop</a> and GCC. This support though is still early and not officially supported. To compile the Phoronix Test Suite using HipHop/GCC, run <em>find . -name "*.php" > files.list && hphp --input-list=files.list -k 1 --log=3 --include-path="." --cluster-count=50 -v "AllDynamic=true" -v "AllVolatile=true"</em> from the root <em>phoronix-test-suite/</em> directory. It can then be executed in the form of <em>/tmp/hphp_XXX/program -f pts-core/phoronix-test-suite.php system-info</em>.</p>
-<hr style="height: 50px; border: 0;"><a name="ExternalDependencies"></a><h1>External Dependencies</h1><p>The Phoronix Test Suite has a feature known as "External Dependencies" where the Phoronix Test Suite can attempt to automatically install some of the test-specific dependencies on supported distributions. If running on a distribution where there is currently no External Dependencies profile, the needed package name(s) are listed for manual installation.</p><p>Below are a list of the operating systems that currently have external dependencies support within the Phoronix Test Suite for the automatic installation of needed test files.</p><hr><ul></ul><li>Amazon</li><li>Angstrom</li><li>Arch Linux</li><li>CentOS</li><li>ClearOS</li><li>ClearOS Core Server</li><li>Debian</li><li>Dragonfly</li><li>Fedora</li><li>Fluxbuntu</li><li>FreeBSD</li><li>GNU KFreeBSD</li><li>Gentoo</li><li>Goobuntu</li><li>HP</li><li>Joli Cloud</li><li>Linux Mint</li><li>MEPIS</li><li>Mandriva</li><li>MeeGo</li><li>Moblin</li><li>Mythbuntu</li><li>NetBSD</li><li>Nexenta Core</li><li>OLPC</li><li>OpenIndiana</li><li>OpenSolaris</li><li>OpenSuSE</li><li>Optware</li><li>Oracle Server</li><li>PCLinuxOS</li><li>PTS Desktop Live</li><li>PTS Linux Live</li><li>Palm</li><li>Pardus Linux</li><li>Red Hat Enterprise</li><li>Red Hat Enterprise Server</li><li>SUSE Linux</li><li>Scientific</li><li>ScientificSL</li><li>Ubuntu</li><li>Zenwalk</li><li>gNewSense</li><hr style="height: 50px; border: 0;"><a name="Configuration"></a><h1>Configuration</h1>
+<hr style="height: 50px; border: 0;"><a name="ExternalDependencies"></a><h1>External Dependencies</h1><p>The Phoronix Test Suite has a feature known as "External Dependencies" where the Phoronix Test Suite can attempt to automatically install some of the test-specific dependencies on supported distributions. If running on a distribution where there is currently no External Dependencies profile, the needed package name(s) are listed for manual installation.</p><p>Below are a list of the operating systems that currently have external dependencies support within the Phoronix Test Suite for the automatic installation of needed test files.</p><hr><ul></ul><li>Amazon</li><li>Angstrom</li><li>Arch Linux</li><li>CentOS</li><li>ClearOS</li><li>ClearOS Core Server</li><li>Debian</li><li>Dragonfly</li><li>Fedora</li><li>Fluxbuntu</li><li>FreeBSD</li><li>GNU KFreeBSD</li><li>Gentoo</li><li>Goobuntu</li><li>HP</li><li>Joli Cloud</li><li>Linux Mint</li><li>MEPIS</li><li>Mandriva</li><li>MeeGo</li><li>Moblin</li><li>Mythbuntu</li><li>NetBSD</li><li>Nexenta Core</li><li>OLPC</li><li>OpenIndiana</li><li>OpenSolaris</li><li>OpenSuSE</li><li>Optware</li><li>Oracle Server</li><li>PCLinuxOS</li><li>PTS Desktop Live</li><li>PTS Linux Live</li><li>Palm</li><li>Pardus Linux</li><li>Red Hat Enterprise</li><li>Red Hat Enterprise Server</li><li>SUSE</li><li>SUSE Linux</li><li>Scientific</li><li>ScientificSL</li><li>Ubuntu</li><li>Zenwalk</li><li>gNewSense</li><hr style="height: 50px; border: 0;"><a name="Configuration"></a><h1>Configuration</h1>
<h1>User Files & Folders</h1>
<p><strong>~/.phoronix-test-suite/user-config.xml</strong></p>
<p>This is a per-user configuration file. Among the information stored here is the test options, locations for storing files, and batch mode options. This file is formatted in XML.</p>
@@ -77,7 +77,7 @@
<p>This is the directory where test profiles are stored.</p>
<p><strong>~/.phoronix-test-suite/test-suites/</strong></p>
<p>This is the directory where test suites are stored.</p>
-<h1>Environmental Variables</h1>
+<h1>Environment Variables</h1>
<p><strong>TEST_RESULTS_NAME</strong></p>
<p>When this variable is set, the value will be used as the name for automatically saving the test results.</p>
<p><strong>TEST_RESULTS_IDENTIFIER</strong></p>
@@ -85,7 +85,7 @@
<p><strong>TEST_RESULTS_DESCRIPTION</strong></p>
<p>When this variable is set, the value will be used as the test results description when saving the test results.</p>
<p><strong>PRESET_OPTIONS</strong></p>
-<p>For setting any test option(s) from an environmental variable rather than being prompted for the options when running a test. Example: <em>PRESET_OPTIONS="stream.run-type=Add" ./phoronix-test-suite benchmark stream</em></p>
+<p>For setting any test option(s) from an environment variable rather than being prompted for the options when running a test. Example: <em>PRESET_OPTIONS="stream.run-type=Add" ./phoronix-test-suite benchmark stream</em></p>
<p><strong>SKIP_TESTS</strong></p>
<p>If there are any test(s) to exempt from the testing process, specify them in this variable. Multiple tests can be waived by delimiting each test identifier by a comma. A test hardware type (i.e. Graphics) can also be supplied for skipping a range of tests.</p>
<p><strong>PTS_MODULE_SETUP</strong></p>
@@ -121,7 +121,7 @@
<p><strong>DEFAULT_VIDEO_MODE</strong></p>
<p>If Phodevi fails to detect the system's monitor standard / default resolution, the mode can be specified in this variable. Example: <em>DEFAULT_VIDEO_MODE=1680x1050 phoronix-test-suite benchmark nexuiz</em>.</p>
<p><strong>SKIP_EXTERNAL_DEPENDENCIES</strong></p>
-<p>To skip the Phoronix Test Suite external dependency checking/installation when installing a test, set this environmental variable to <em>1</em>. If wishing to skip only certain external dependencies, set this variable's value to the name of the external dependencies (the generic dependency names used by the Phoronix Test Suite) to not install. Multiple dependencies to skip can be delimited by a comma.</p>
+<p>To skip the Phoronix Test Suite external dependency checking/installation when installing a test, set this environment variable to <em>1</em>. If wishing to skip only certain external dependencies, set this variable's value to the name of the external dependencies (the generic dependency names used by the Phoronix Test Suite) to not install. Multiple dependencies to skip can be delimited by a comma.</p>
<hr style="height: 50px; border: 0;"><a name="GeneralInformation"></a><h1>General Information</h1>
<h1>Frequently Asked Questions</h1>
<p><strong><em>Q:</em> May I use the Phoronix Test Suite when running benchmarks for my own publication or blog? Are there any publishing restrictions?</strong></p>
@@ -147,12 +147,12 @@
<p>- When running a test where you are prompted to enter any test options, multiple selections can be performed -- which will result in multiple test runs for each combination of the selected option(s) -- by separating each intended test option / number with a comma.</p>
<p>- When being prompted for the test identifier or the file name for saving the results, several user variables are supported. These include <em>$VIDEO_RESOLUTION</em>, <em>$VIDEO_CARD</em>, <em>$OPERATING_SYSTEM</em>, <em>$PROCESSOR</em>, <em>$MOTHERBOARD</em>, <em>$CHIPSET</em>, and <em>$KERNEL_VERSION</em>. If any of these variables are entered, the Phoronix Test Suite will replace them with their respective values before saving the results.</p>
<p>- If <em>RemoveDownloadFiles</em> is set to <em>TRUE</em> within the <em>user-config.xml</em> file, once a test has been installed the originally downloaded files for that test will be automatically removed. This conserves disk space but will cause these files to be re-downloaded the next time the test needs to be re-installed. This will also not back up the downloaded files to the Phoronix Test Suite download cache. Enabling this option is just recommended for users with very limited disk space.</p>
-<p>- If the amount of video memory for your graphics card is incorrectly reported by the Phoronix Test Suite (you can check by running <em>phoronix-test-suite diagnostics</em>), you can use the <em>VIDEO_MEMORY=</em> environmental variable for overriding the video memory capacity (in Megabytes) used by the Phoronix Test Suite.</p>
-<p>- If the <em>DISPLAY</em> environmental variable is not set or <em>NO_GRAPHICS_TESTS</em> environmental variable is set, tests of type <em>Graphics</em> will not be run. Likewise, if <em>NO_SYSTEM_TESTS</em> environmental variable is set, tests of type <em>System</em> will not run. This applies to all test types where <em>NO_<TEST TYPE>_TESTS</em> is set.</p>
+<p>- If the amount of video memory for your graphics card is incorrectly reported by the Phoronix Test Suite (you can check by running <em>phoronix-test-suite diagnostics</em>), you can use the <em>VIDEO_MEMORY=</em> environment variable for overriding the video memory capacity (in Megabytes) used by the Phoronix Test Suite.</p>
+<p>- If the <em>DISPLAY</em> environment variable is not set or <em>NO_GRAPHICS_TESTS</em> environment variable is set, tests of type <em>Graphics</em> will not be run. Likewise, if <em>NO_SYSTEM_TESTS</em> environment variable is set, tests of type <em>System</em> will not run. This applies to all test types where <em>NO_<TEST TYPE>_TESTS</em> is set.</p>
<p>- If while running multiple tests you want to quit the testing prematurely, in a new terminal window type <em>touch ~/.phoronix-test-suite/halt-testing</em>. All results for tests that had already run will be saved (permitting you opted to save the results), except for the test currently being run.</p>
<p>- If you wish to stop the current test run prematurely but continue the testing process, in a new terminal window type <em>touch ~/.phoronix-test-suite/skip-test</em>.</p>
-<p>- If you want the specified test(s) to run in a loop for a set period of time, use the <em>TOTAL_LOOP_TIME</em> environmental variable. For instance, running <em>TOTAL_LOOP_TIME=120 phoronix-test-suite benchmark ffmpeg</em> would keep running the ffmpeg test profile for 120 minutes.</p>
-<p>- If you want the specified test(s) to run in a loop for a set number of times, use the <em>TOTAL_LOOP_COUNT</em> environmental variable. For instance, running <em>TOTAL_LOOP_COUNT=3 phoronix-test-suite benchmark ffmpeg</em> would keep running the ffmpeg test profile three times.</p>
+<p>- If you want the specified test(s) to run in a loop for a set period of time, use the <em>TOTAL_LOOP_TIME</em> environment variable. For instance, running <em>TOTAL_LOOP_TIME=120 phoronix-test-suite benchmark ffmpeg</em> would keep running the ffmpeg test profile for 120 minutes.</p>
+<p>- If you want the specified test(s) to run in a loop for a set number of times, use the <em>TOTAL_LOOP_COUNT</em> environment variable. For instance, running <em>TOTAL_LOOP_COUNT=3 phoronix-test-suite benchmark ffmpeg</em> would keep running the ffmpeg test profile three times.</p>
<p>- When any tests are being installed and when tests are being run, a lock is created in the system's temporary directory with the name <em>phoronix-test-suite.active</em> (i.e. <em>/tmp/phoronix-test-suite.active</em>) and is removed upon completion. Thus if you have any system scripts that you wish to run when tests are not running or being installed as to not impact the results, one simple way to handle this is by having the script check for the existence of this lock.</p>
<h2>Configuration</h2>
<p>- The user configuration options for the Phoronix Test Suite are stored in <em>~/.phoronix-test-suite/user-config.xml</em>. The batch mode options are also stored within this file and those can be adjusted by running <em>phoronix-test-suite batch-setup</em>.</p>
diff --git a/documentation/stubs/00_user_options.html b/documentation/stubs/00_user_options.html
index 68903e9..743137c 100644
--- a/documentation/stubs/00_user_options.html
+++ b/documentation/stubs/00_user_options.html
@@ -1 +1 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>User Options</title></head><body><p>The following options are currently supported by the Phoronix Test Suite client. A list of available options can also be found by running <em>phoronix-test-suite help.</em><hr></p><h1>Test Installation</h1><h3>install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) inside the testing environment directory). The install process from downloading of the test files to the installation is fully automated. The install option needs to be supplied with the test name or suite as an argument. Optionally, a OpenBenchmarking.org ID or the name of a saved results file can be supplied as well and the test(s) to install will automatically be extracted from that information. If the test is already installed and was run by the latest version of the installation process, no action will be taken. Multiple arguments can be supplied to install additional tests at the same time.</p><h3>install-dependencies<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the external dependencies needed by the selected test(s) using the distribution's package management system. For example, some tests depend upon GCC for compiling code. If GCC is not detected on the system, the Phoronix Test Suite will attempt to install GCC using the distribution's package management system. If you are running this command as a local user, you may be prompted for the root password while the process is running. For unsupported distributions, the dependency names will be displayed along with common names for the package. The install-dependencies option needs to be supplied with the test name or suite as an argument. When using the install option, the external dependencies are automatically checked.</p><h3>make-download-cache<em> </em></h3><p>This option will create a download cache for use by the Phoronix Test Suite.</p><h3>remove-installed-test<em> [Test]</em></h3><p>This option will permanently remove a installed test by the Phoronix Test Suite.</p><h1>Testing</h1><h3>benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s). This option is equivalent to running phoronix-test-suite with the install option followed by the run option. Multiple arguments can be supplied to run additional tests at the same time and save the results into one file.</p><h3>finish-run<em> [Test Result]</em></h3><p>This option can be used if a test run had not properly finished running all tests within a saved results file. Using this option when specifying a saved results file where all tests had not completed will attempt to finish testing on the remaining tests where there are missing results.</p><h3>run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s).</p><h3>run-tests-in-suite<em> </em></h3><p>This option can be used if you wish to run all of the tests found in a supplied suite, but you wish to re-configure each of the test options rather than using the defaults supplied by the suite.</p><h1>Batch Testing</h1><h3>batch-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the benchmark option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>If you wish to run the install process in the Phoronix Test Suite batch mode but do not wish to run any tests at this time. Running the install process in the batch mode will use the default values and not prompt the user of any possible options, to ensure the process is fully automated.</p><h3>batch-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the run option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-setup<em> </em></h3><p>This option is used to configure the batch mode options for the Phoronix Test Suite, which is subsequently written to the user configuration file. Among the options are whether to automatically upload the test results to OpenBenchmarking.org and prompting for the saved file name.</p><h3>default-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s) in the defaults mode. This option is equivalent to running phoronix-test-suite with the install option followed by the default-run option.</p><h3>default-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s). The name of the test or suite must be supplied or the OpenBenchmarking.org ID or saved local file name. Multiple arguments can be supplied to run additional tests at the same time and save the results in a suite-like fashion. Unlike the normal run option, the default-run will not prompt the user to select from the available test options but will instead use the default options as automatically set by pts-core or the test profile. Use batch-run to automatically test all of the available options.</p><h1>OpenBenchmarking.org</h1><h3>clone-result<em> [OpenBenchmarking ID] ...</em></h3><p>This option will download a local copy of a file that was saved to OpenBenchmarking.org, as long as a valid public ID is supplied. More than one ID can be specified and the results will then be merged.</p><h3>openbenchmarking-changes<em> </em></h3><p>This option will list recent changes to test profiles of enabled OpenBenchmarking.org repositories.</p><h3>openbenchmarking-launcher<em> </em></h3><p>This option is called automatically with the .openbenchmarking MIME file extension support for launching OpenBenchmarking.org operations.</p><h3>openbenchmarking-login<em> </em></h3><p>This option is used for controlling your Phoronix Test Suite client options for OpenBechmarking.org and syncing the client to your account.</p><h3>openbenchmarking-refresh<em> </em></h3><p>This option is used for refreshing the stored OpenBenchmarking.org repostory information and other data. The Phoronix Test Suite will automatically refresh this data every three days or when other thresholds are exceeded, but this command can be used to manually refresh/updates the data.</p><h3>openbenchmarking-repositories<em> </em></h3><p>This option will list the OpenBenchmarking.org repositories currently linked to this Phoronix Test Suite client instance.</p><h3>upload-result<em> [Test Result]</em></h3><p>This option is used for uploading a test result to OpenBenchmarking.org.</p><h3>upload-test-profile<em> </em></h3><p>This option can be used for uploading a test profile to your account on OpenBenchmarking.org. By uploading your test profile to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution in a seamless manner by other Phoronix Test Suite clients.</p><h3>upload-test-suite<em> </em></h3><p>This option can be used for uploading a test suite to your account on OpenBenchmarking.org. By uploading your test suite to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution.</p><h1>System</h1><h3>detailed-system-info<em> </em></h3><p>Display detailed information about the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>diagnostics<em> </em></h3><p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p><h3>interactive<em> </em></h3><p>A simple text-driven interactive interface to the Phoronix Test Suite.</p><h3>system-info<em> </em></h3><p>Display the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>system-sensors<em> </em></h3><p>Display the installed system hardware and software sensors in real-time as detected by the Phoronix Test Suite Phodevi Library.</p><h1>Information</h1><h3>info<em> [Test | Suite | OpenBenchmarking.org ID | Test Result]</em></h3><p>This option will show details about the supplied test, suite, virtual suite, or result file.</p><h3>list-available-suites<em> </em></h3><p>This option will list all available test suites that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-tests<em> </em></h3><p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-virtual-suites<em> </em></h3><p>This option will list all available virtual test suites that can be dynamically created based upon the available tests from enabled OpenBenchmarking.org repositories.</p><h3>list-installed-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are already installed on the system that the Phoronix Test Suite may potentially depend upon by test profiles.</p><h3>list-installed-suites<em> </em></h3><p>This option will list all suites that are currently installed on the system.</p><h3>list-installed-tests<em> </em></h3><p>This option will list all test profiles that are currently installed on the system.</p><h3>list-missing-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are missing from the system that the Phoronix Test Suite may potentially need by select test profiles.</p><h3>list-possible-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are are potentially used by the Phoronix Test Suite.</p><h3>list-saved-results<em> </em></h3><p>This option will list all of the saved test results found on the system.</p><h3>list-test-usage<em> </em></h3><p>This option will list various details about installed tests and their usage.</p><h1>Asset Creation</h1><h3>debug-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the install option but will yield more information during the run process that can be used to debug issues with a test profile installer or to verify the test profile is functioning correctly.</p><h3>debug-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the <em>run</em> option but will yield more information during the run process that can be used to debug issues with a test profile or to verify the test profile is functioning correctly.</p><h3>debug-test-download-links<em> [Test | Suite]</em></h3><p>This option will check all download links within the specified test profile(s) to ensure there are no broken URLs.</p><h3>download-test-files<em> [Test | Suite] ...</em></h3><p>This will download the selected test file(s) to the Phoronix Test Suite download cache but will not install the tests.</p><h3>force-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will force the installation (or re-installation) of a test or suite. The arguments and process is similar to the install option but even if the test is installed, the entire installation process will automatically be executed. This option is generally used when debugging a test installation problem.</p><h3>result-file-to-suite<em> [Test Result]</em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run, that is based upon an existing test results file.</p><h3>validate-result-file<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite result file as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-profile<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test profile as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-suite<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test suite as being compliant against the OpenBenchmarking.org specification.</p><h1>Result Management</h1><h3>copy-run-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change an existing test run within a saved results file.</p><h3>extract-from-result-file<em> [Test Result]</em></h3><p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract.</p><h3>merge-results<em> [Test Result] ...</em></h3><p>This option will manually merge multiple sets of test results generated by the Phoronix Test Suite.</p><h3>refresh-graphs<em> [Test Result]</em></h3><p>This option will re-render and save all result graphs within a saved file. This option can be used when making modifications to the graphing code or its color/option configuration file and testing the changes.</p><h3>remove-from-result-file<em> [Test Result]</em></h3><p>This option is used if there is a set of test results you wish to remove/delete from a saved results file. The user must specify a saved results file and then they will be prompted to select the results identifier associated with the results they wish to remove.</p><h3>remove-result<em> [Test Result]</em></h3><p>This option will permanently remove the saved file set that is set as the first argument.</p><h3>rename-identifier-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the name of the identifier in a test results file that is shown in the Phoronix Test Suite Results Viewer and the contained graphs.</p><h3>reorder-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the order in which test results are shown in the Phoronix Test Suite Results Viewer and the contained graphs. The user must specify a saved results file and then they will be prompted to select the results identifiers one at a time in the order they would like them to be displayed from left to right.</p><h3>result-file-to-csv<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing.</p><h3>result-file-to-pdf<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a PDF file.</p><h3>result-file-to-text<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information to the terminal. The test results are also outputted.</p><h3>show-result<em> [Test Result]</em></h3><p>Open up the test results in the Phoronix Test Suite Result Viewer or on OpenBenchmarking.org.</p><h1>Result Analytics</h1><h3>analyze-all-runs<em> [Test Result]</em></h3><p>This option will generate a candlestick graph showing the distribution of results from all trial runs. The candlestick graph is similar to the Japanese candlestick charts used by the financial industry, except instead of representing stock data it is numerical result data from all trial runs.\n\nThe tip of the upper-wick represents the highest value of the test runs with the tip of the lower-wick representing the lowest value of all test runs. The upper-edge of the candle body represents the first or last run value and the lower-edge represents the first or last run value. Lastly, if the last run value is less than the first run value, the candle body is the same color as the graph background, otherwise the last run value is greater.</p><h3>analyze-batch<em> [Test Result]</em></h3><p>This option will analyze a batch results file and plot out the performance impact from the different options onto a line graph (i.e. to see the impact that changing the video resolution has on the system's performance).</p><h3>analyze-image-delta<em> [Test Result]</em></h3><p>This option will analyze a test result file if it contains any test results that produced an image quality comparison (IQC) and will render image deltas illustrating the difference between images from two test results.</p><h1>Other</h1><h3>build-suite<em> </em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run. Optionally, passed as arguments can be the test(s) or suite(s) to add to the suite to be created, instead of being prompted through the process.</p><h3>help<em> </em></h3><p>This option will display the list of available Phoronix Test Suite commands.</p><h3>network-setup<em> </em></h3><p>This option allows the user to configure how the Phoronix Test Suite connects to OpenBenchmarking.org and other web-services. Connecting through an HTTP proxy can be configured through this option.</p><h3>rebuild-composite-xml<em> [Test Result]</em></h3><p>This option can be used to rebuild your composite XML file in the event that the main result file was corrupted and the test-X.xml files are still present in the result file directory.</p><h3>user-config-reset<em> </em></h3><p>This option can be used for resetting the Phoronix Test Suite user configuration file to its default state.</p><h3>user-config-set<em> </em></h3><p>This option can be used for setting an XML value in the Phoronix Test Suite user configuration file.</p><h3>version<em> </em></h3><p>This option will display the Phoronix Test Suite client version.</p><h1>Modules</h1><h3>list-modules<em> </em></h3><p>This option will list all of the available Phoronix Test Suite modules on this system.</p><h3>module-info<em> [Phoronix Test Suite Module]</em></h3><p>This option will show detailed information on a Phoronix Test Suite module such as the version, developer, and a description of its purpose.</p><h3>module-setup<em> [Phoronix Test Suite Module]</em></h3><p>This option will allow you to configure all available end-user options for a Phoronix Test Suite module. These options are then stored within the user's configuration file. Not all modules may have options that can be configured by the end-user.</p><h3>test-module<em> [Phoronix Test Suite Module]</em></h3><p>This option can be used for debugging a Phoronix Test Suite module.</p><h1>Web User Interface</h1><h3>webui<em> </em></h3><p>Launch the Phoronix Test Suite web user-interface.</p></body></html>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>User Options</title></head><body><p>The following options are currently supported by the Phoronix Test Suite client. A list of available options can also be found by running <em>phoronix-test-suite help.</em><hr></p><h1>Test Installation</h1><h3>install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) inside the testing environment directory). The install process from downloading of the test files to the installation is fully automated. The install option needs to be supplied with the test name or suite as an argument. Optionally, a OpenBenchmarking.org ID or the name of a saved results file can be supplied as well and the test(s) to install will automatically be extracted from that information. If the test is already installed and was run by the latest version of the installation process, no action will be taken. Multiple arguments can be supplied to install additional tests at the same time.</p><h3>install-dependencies<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the external dependencies needed by the selected test(s) using the distribution's package management system. For example, some tests depend upon GCC for compiling code. If GCC is not detected on the system, the Phoronix Test Suite will attempt to install GCC using the distribution's package management system. If you are running this command as a local user, you may be prompted for the root password while the process is running. For unsupported distributions, the dependency names will be displayed along with common names for the package. The install-dependencies option needs to be supplied with the test name or suite as an argument. When using the install option, the external dependencies are automatically checked.</p><h3>make-download-cache<em> </em></h3><p>This option will create a download cache for use by the Phoronix Test Suite.</p><h3>remove-installed-test<em> [Test]</em></h3><p>This option will permanently remove a installed test by the Phoronix Test Suite.</p><h1>Testing</h1><h3>benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s). This option is equivalent to running phoronix-test-suite with the install option followed by the run option. Multiple arguments can be supplied to run additional tests at the same time and save the results into one file.</p><h3>finish-run<em> [Test Result]</em></h3><p>This option can be used if a test run had not properly finished running all tests within a saved results file. Using this option when specifying a saved results file where all tests had not completed will attempt to finish testing on the remaining tests where there are missing results.</p><h3>run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s).</p><h3>run-tests-in-suite<em> </em></h3><p>This option can be used if you wish to run all of the tests found in a supplied suite, but you wish to re-configure each of the test options rather than using the defaults supplied by the suite.</p><h1>Batch Testing</h1><h3>batch-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the benchmark option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>If you wish to run the install process in the Phoronix Test Suite batch mode but do not wish to run any tests at this time. Running the install process in the batch mode will use the default values and not prompt the user of any possible options, to ensure the process is fully automated.</p><h3>batch-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option and its arguments are equivalent to the run option, but the process will be run in the Phoronix Test Suite batch mode.</p><h3>batch-setup<em> </em></h3><p>This option is used to configure the batch mode options for the Phoronix Test Suite, which is subsequently written to the user configuration file. Among the options are whether to automatically upload the test results to OpenBenchmarking.org and prompting for the saved file name.</p><h3>default-benchmark<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will install the selected test(s) (if needed) and will proceed to run the test(s) in the defaults mode. This option is equivalent to running phoronix-test-suite with the install option followed by the default-run option.</p><h3>default-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will run the selected test(s). The name of the test or suite must be supplied or the OpenBenchmarking.org ID or saved local file name. Multiple arguments can be supplied to run additional tests at the same time and save the results in a suite-like fashion. Unlike the normal run option, the default-run will not prompt the user to select from the available test options but will instead use the default options as automatically set by pts-core or the test profile. Use batch-run to automatically test all of the available options.</p><h1>OpenBenchmarking.org</h1><h3>clone-result<em> [OpenBenchmarking ID] ...</em></h3><p>This option will download a local copy of a file that was saved to OpenBenchmarking.org, as long as a valid public ID is supplied. More than one ID can be specified and the results will then be merged.</p><h3>openbenchmarking-changes<em> </em></h3><p>This option will list recent changes to test profiles of enabled OpenBenchmarking.org repositories.</p><h3>openbenchmarking-launcher<em> </em></h3><p>This option is called automatically with the .openbenchmarking MIME file extension support for launching OpenBenchmarking.org operations.</p><h3>openbenchmarking-login<em> </em></h3><p>This option is used for controlling your Phoronix Test Suite client options for OpenBechmarking.org and syncing the client to your account.</p><h3>openbenchmarking-refresh<em> </em></h3><p>This option is used for refreshing the stored OpenBenchmarking.org repostory information and other data. The Phoronix Test Suite will automatically refresh this data every three days or when other thresholds are exceeded, but this command can be used to manually refresh/updates the data.</p><h3>openbenchmarking-repositories<em> </em></h3><p>This option will list the OpenBenchmarking.org repositories currently linked to this Phoronix Test Suite client instance.</p><h3>upload-result<em> [Test Result]</em></h3><p>This option is used for uploading a test result to OpenBenchmarking.org.</p><h3>upload-test-profile<em> </em></h3><p>This option can be used for uploading a test profile to your account on OpenBenchmarking.org. By uploading your test profile to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution in a seamless manner by other Phoronix Test Suite clients.</p><h3>upload-test-suite<em> </em></h3><p>This option can be used for uploading a test suite to your account on OpenBenchmarking.org. By uploading your test suite to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution.</p><h1>System</h1><h3>detailed-system-info<em> </em></h3><p>Display detailed information about the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>diagnostics<em> </em></h3><p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p><h3>interactive<em> </em></h3><p>A simple text-driven interactive interface to the Phoronix Test Suite.</p><h3>system-info<em> </em></h3><p>Display the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library.</p><h3>system-sensors<em> </em></h3><p>Display the installed system hardware and software sensors in real-time as detected by the Phoronix Test Suite Phodevi Library.</p><h1>Information</h1><h3>info<em> [Test | Suite | OpenBenchmarking.org ID | Test Result]</em></h3><p>This option will show details about the supplied test, suite, virtual suite, or result file.</p><h3>list-available-suites<em> </em></h3><p>This option will list all available test suites that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-tests<em> </em></h3><p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories.</p><h3>list-available-virtual-suites<em> </em></h3><p>This option will list all available virtual test suites that can be dynamically created based upon the available tests from enabled OpenBenchmarking.org repositories.</p><h3>list-installed-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are already installed on the system that the Phoronix Test Suite may potentially depend upon by test profiles.</p><h3>list-installed-suites<em> </em></h3><p>This option will list all suites that are currently installed on the system.</p><h3>list-installed-tests<em> </em></h3><p>This option will list all test profiles that are currently installed on the system.</p><h3>list-missing-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are missing from the system that the Phoronix Test Suite may potentially need by select test profiles.</p><h3>list-possible-dependencies<em> </em></h3><p>This option will list all of the packages / external test dependencies that are are potentially used by the Phoronix Test Suite.</p><h3>list-saved-results<em> </em></h3><p>This option will list all of the saved test results found on the system.</p><h3>list-test-usage<em> </em></h3><p>This option will list various details about installed tests and their usage.</p><h1>Asset Creation</h1><h3>debug-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the install option but will yield more information during the run process that can be used to debug issues with a test profile installer or to verify the test profile is functioning correctly.</p><h3>debug-run<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option is intended for use by test profile writers and is identical to the <em>run</em> option but will yield more information during the run process that can be used to debug issues with a test profile or to verify the test profile is functioning correctly.</p><h3>debug-test-download-links<em> [Test | Suite]</em></h3><p>This option will check all download links within the specified test profile(s) to ensure there are no broken URLs.</p><h3>download-test-files<em> [Test | Suite] ...</em></h3><p>This will download the selected test file(s) to the Phoronix Test Suite download cache but will not install the tests.</p><h3>force-install<em> [Test | Suite | OpenBenchmarking.org ID | Test Result] ...</em></h3><p>This option will force the installation (or re-installation) of a test or suite. The arguments and process is similar to the install option but even if the test is installed, the entire installation process will automatically be executed. This option is generally used when debugging a test installation problem.</p><h3>result-file-to-suite<em> [Test Result]</em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run, that is based upon an existing test results file.</p><h3>validate-result-file<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite result file as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-profile<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test profile as being compliant against the OpenBenchmarking.org specification.</p><h3>validate-test-suite<em> </em></h3><p>This option can be used for validating a Phoronix Test Suite test suite as being compliant against the OpenBenchmarking.org specification.</p><h1>Result Management</h1><h3>copy-run-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change an existing test run within a saved results file.</p><h3>extract-from-result-file<em> [Test Result]</em></h3><p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract.</p><h3>merge-results<em> [Test Result] ...</em></h3><p>This option will manually merge multiple sets of test results generated by the Phoronix Test Suite.</p><h3>refresh-graphs<em> [Test Result]</em></h3><p>This option will re-render and save all result graphs within a saved file. This option can be used when making modifications to the graphing code or its color/option configuration file and testing the changes.</p><h3>remove-from-result-file<em> [Test Result]</em></h3><p>This option is used if there is a set of test results you wish to remove/delete from a saved results file. The user must specify a saved results file and then they will be prompted to select the results identifier associated with the results they wish to remove.</p><h3>remove-result<em> [Test Result]</em></h3><p>This option will permanently remove the saved file set that is set as the first argument.</p><h3>rename-identifier-in-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the name of the identifier in a test results file that is shown in the Phoronix Test Suite Results Viewer and the contained graphs.</p><h3>reorder-result-file<em> [Test Result]</em></h3><p>This option is used if you wish to change the order in which test results are shown in the Phoronix Test Suite Results Viewer and the contained graphs. The user must specify a saved results file and then they will be prompted to select the results identifiers one at a time in the order they would like them to be displayed from left to right.</p><h3>result-file-to-csv<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing.</p><h3>result-file-to-pdf<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information along with the results to a PDF file.</p><h3>result-file-to-text<em> [Test Result]</em></h3><p>This option will read a saved test results file and output the system hardware and software information to the terminal. The test results are also outputted.</p><h3>show-result<em> [Test Result]</em></h3><p>Open up the test results in the Phoronix Test Suite Result Viewer or on OpenBenchmarking.org.</p><h1>Result Analytics</h1><h3>analyze-all-runs<em> [Test Result]</em></h3><p>This option will generate a candlestick graph showing the distribution of results from all trial runs. The candlestick graph is similar to the Japanese candlestick charts used by the financial industry, except instead of representing stock data it is numerical result data from all trial runs.\n\nThe tip of the upper-wick represents the highest value of the test runs with the tip of the lower-wick representing the lowest value of all test runs. The upper-edge of the candle body represents the first or last run value and the lower-edge represents the first or last run value. Lastly, if the last run value is less than the first run value, the candle body is the same color as the graph background, otherwise the last run value is greater.</p><h3>analyze-batch<em> [Test Result]</em></h3><p>This option will analyze a batch results file and plot out the performance impact from the different options onto a line graph (i.e. to see the impact that changing the video resolution has on the system's performance).</p><h3>analyze-image-delta<em> [Test Result]</em></h3><p>This option will analyze a test result file if it contains any test results that produced an image quality comparison (IQC) and will render image deltas illustrating the difference between images from two test results.</p><h1>Other</h1><h3>build-suite<em> </em></h3><p>This option will guide the user through the process of generating their own test suite, which they can then run. Optionally, passed as arguments can be the test(s) or suite(s) to add to the suite to be created, instead of being prompted through the process.</p><h3>help<em> </em></h3><p>This option will display the list of available Phoronix Test Suite commands.</p><h3>network-setup<em> </em></h3><p>This option allows the user to configure how the Phoronix Test Suite connects to OpenBenchmarking.org and other web-services. Connecting through an HTTP proxy can be configured through this option.</p><h3>rebuild-composite-xml<em> [Test Result]</em></h3><p>This option can be used to rebuild your composite XML file in the event that the main result file was corrupted and the test-X.xml files are still present in the result file directory.</p><h3>user-config-reset<em> </em></h3><p>This option can be used for resetting the Phoronix Test Suite user configuration file to its default state.</p><h3>user-config-set<em> </em></h3><p>This option can be used for setting an XML value in the Phoronix Test Suite user configuration file.</p><h3>version<em> </em></h3><p>This option will display the Phoronix Test Suite client version.</p><h1>Modules</h1><h3>list-modules<em> </em></h3><p>This option will list all of the available Phoronix Test Suite modules on this system.</p><h3>module-info<em> [Phoronix Test Suite Module]</em></h3><p>This option will show detailed information on a Phoronix Test Suite module such as the version, developer, and a description of its purpose.</p><h3>module-setup<em> [Phoronix Test Suite Module]</em></h3><p>This option will allow you to configure all available end-user options for a Phoronix Test Suite module. These options are then stored within the user's configuration file. Not all modules may have options that can be configured by the end-user.</p><h3>test-module<em> [Phoronix Test Suite Module]</em></h3><p>This option can be used for debugging a Phoronix Test Suite module.</p></body></html>
diff --git a/documentation/stubs/02_external_dependencies.html b/documentation/stubs/02_external_dependencies.html
index 1d25e07..6b43ce3 100644
--- a/documentation/stubs/02_external_dependencies.html
+++ b/documentation/stubs/02_external_dependencies.html
@@ -1 +1 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>External Dependencies</title></head><body><p>The Phoronix Test Suite has a feature known as "External Dependencies" where the Phoronix Test Suite can attempt to automatically install some of the test-specific dependencies on supported distributions. If running on a distribution where there is currently no External Dependencies profile, the needed package name(s) are listed for manual installation.</p><p>Below are a list of the operating systems that currently have external dependencies support within the Phoronix Test Suite for the automatic installation of needed test files.<hr><ul></ul><li>Amazon</li><li>Angstrom</li><li>Arch Linux</li><li>CentOS</li><li>ClearOS</li><li>ClearOS Core Server</li><li>Debian</li><li>Dragonfly</li><li>Fedora</li><li>Fluxbuntu</li><li>FreeBSD</li><li>GNU KFreeBSD</li><li>Gentoo</li><li>Goobuntu</li><li>HP</li><li>Joli Cloud</li><li>Linux Mint</li><li>MEPIS</li><li>Mandriva</li><li>MeeGo</li><li>Moblin</li><li>Mythbuntu</li><li>NetBSD</li><li>Nexenta Core</li><li>OLPC</li><li>OpenIndiana</li><li>OpenSolaris</li><li>OpenSuSE</li><li>Optware</li><li>Oracle Server</li><li>PCLinuxOS</li><li>PTS Desktop Live</li><li>PTS Linux Live</li><li>Palm</li><li>Pardus Linux</li><li>Red Hat Enterprise</li><li>Red Hat Enterprise Server</li><li>SUSE Linux</li><li>Scientific</li><li>ScientificSL</li><li>Ubuntu</li><li>Zenwalk</li><li>gNewSense</li></p></body></html>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>External Dependencies</title></head><body><p>The Phoronix Test Suite has a feature known as "External Dependencies" where the Phoronix Test Suite can attempt to automatically install some of the test-specific dependencies on supported distributions. If running on a distribution where there is currently no External Dependencies profile, the needed package name(s) are listed for manual installation.</p><p>Below are a list of the operating systems that currently have external dependencies support within the Phoronix Test Suite for the automatic installation of needed test files.<hr><ul></ul><li>Amazon</li><li>Angstrom</li><li>Arch Linux</li><li>CentOS</li><li>ClearOS</li><li>ClearOS Core Server</li><li>Debian</li><li>Dragonfly</li><li>Fedora</li><li>Fluxbuntu</li><li>FreeBSD</li><li>GNU KFreeBSD</li><li>Gentoo</li><li>Goobuntu</li><li>HP</li><li>Joli Cloud</li><li>Linux Mint</li><li>MEPIS</li><li>Mandriva</li><li>MeeGo</li><li>Moblin</li><li>Mythbuntu</li><li>NetBSD</li><li>Nexenta Core</li><li>OLPC</li><li>OpenIndiana</li><li>OpenSolaris</li><li>OpenSuSE</li><li>Optware</li><li>Oracle Server</li><li>PCLinuxOS</li><li>PTS Desktop Live</li><li>PTS Linux Live</li><li>Palm</li><li>Pardus Linux</li><li>Red Hat Enterprise</li><li>Red Hat Enterprise Server</li><li>SUSE</li><li>SUSE Linux</li><li>Scientific</li><li>ScientificSL</li><li>Ubuntu</li><li>Zenwalk</li><li>gNewSense</li></p></body></html>
diff --git a/pts-core/pts-core.php b/pts-core/pts-core.php
index f91eaf4..928a59f 100644
--- a/pts-core/pts-core.php
+++ b/pts-core/pts-core.php
@@ -21,8 +21,8 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-define('PTS_VERSION', '4.0.0m4');
-define('PTS_CORE_VERSION', 3940);
+define('PTS_VERSION', '4.0.0');
+define('PTS_CORE_VERSION', 4000);
define('PTS_CODENAME', 'SULDAL');
define('PTS_IS_CLIENT', (defined('PTS_MODE') && PTS_MODE == 'CLIENT'));
define('PTS_IS_DEV_BUILD', (substr(PTS_VERSION, -2, 1) == 'm'));
@@ -105,7 +105,8 @@ function pts_version_codenames()
'3.4' => 'Lillesand',
'3.6' => 'Arendal',
'3.8' => 'Bygland',
- '4.0' => 'Suldal'
+ '4.0' => 'Suldal',
+ '4.2' => 'Randaberg',
Copyright © 2013 by Phoronix Media