10/12/10

documentation/2.6

PTSuite 2.6.odt 1
documentation/2.6 10/12/10

Table of Contents
documentation/2.6..................................................................................................................1
I - Phoronix Test Suite Installation..........................................................................................4
A - Dependencies...............................................................................................................4
B - File Structure................................................................................................................5
C - Running Locally...........................................................................................................5
D - Generic Installation......................................................................................................5
E - Debian/Ubuntu Installation...........................................................................................5
F - Download Cache For Tests..........................................................................................6
II - Default Files & Folders.....................................................................................................7
III - Phoronix Test Suite Options............................................................................................9
A - Test Installation Options...............................................................................................9
install <To Install>......................................................................................................................9
batch-install <To Install>............................................................................................................9
B - Run Options.................................................................................................................9
benchmark <To Run>..................................................................................................................9
default-benchmark <To Run>.....................................................................................................9
run <To Run>............................................................................................................................10
default-run <To Run>................................................................................................................10
run-tests-in-suite <To Run>......................................................................................................10
estimate-run-time <To Run>.....................................................................................................10
C - Recovery Run Options...............................................................................................10
finish-run <Saved Results File>................................................................................................10
recover-run <Saved Results File>.............................................................................................10
D - Batch Run Options.....................................................................................................11
batch-setup................................................................................................................................11
batch-run <To Run>..................................................................................................................11
batch-benchmark <To Run>......................................................................................................11
E - Test Dependency Options..........................................................................................11
install-dependencies <To Install>..............................................................................................11
list-possible-dependencies.........................................................................................................11
list-installed-dependencies........................................................................................................11
list-missing-dependencies.........................................................................................................11
F - Test Options................................................................................................................12
list-tests.....................................................................................................................................12
list-all-tests................................................................................................................................12
list-suites...................................................................................................................................12
list-installed-tests......................................................................................................................12
list-installed-suites....................................................................................................................12
list-test-usage............................................................................................................................12
info <To Show>........................................................................................................................12
G - Result Viewing Options..............................................................................................13
list-results..................................................................................................................................13
show-result <To Show>............................................................................................................13
remove-result <To Remove>....................................................................................................13
remove-all-results......................................................................................................................13
remove-installed-test <To Remove>.........................................................................................13

PTSuite 2.6.odt 2
documentation/2.6 10/12/10

merge-results <To Merge> <To Merge> <To Save As>...........................................................13

reference-comparison <Saved Result>.....................................................................................13
result-file-to-pdf <Saved Name>..............................................................................................13
result-file-to-text <Saved Name>..............................................................................................13
result-file-to-csv <Saved Name>..............................................................................................14
H - Result Editing Options...............................................................................................14
extract-from-result-file <Saved Result>...................................................................................14
remove-from-result-file <Saved Result>..................................................................................14
reorder-result-file <Saved Result>............................................................................................14
rename-identifier-in-result-file <Saved Result>.......................................................................14
copy-run-in-result-file <Saved Result>....................................................................................14
edit-result-file <Saved Result>.................................................................................................14
J - Analytical Options.......................................................................................................15
analyze-result-file <Saved Name>............................................................................................15
analyze-batch <Saved Name>...................................................................................................15
analyze-image-delta <Saved Name>........................................................................................15
analyze-all-runs <Saved Name>...............................................................................................15
K - Module Options..........................................................................................................15
list-modules...............................................................................................................................15
module-info <Module Name>..................................................................................................15
module-setup <Module Name>................................................................................................15
L - Test/Suite Creation.....................................................................................................16
build-suite..................................................................................................................................16
result-file-to-suite <Saved Name>............................................................................................16
validate-test-profile <Test>.......................................................................................................16
debug-run <To Run>.................................................................................................................16
debug-install <To Install>.........................................................................................................16
validate-test-suite <Suite>.........................................................................................................16
M - Miscellaneous Options..............................................................................................17
make-download-cache...............................................................................................................17
system-info................................................................................................................................17
diagnostics.................................................................................................................................17
version.......................................................................................................................................17
refresh-graphs <Saved Name>..................................................................................................17
rebuild-composite-xml <Saved Name>....................................................................................17
network-setup............................................................................................................................17
user-config-reset........................................................................................................................17
user-config-set...........................................................................................................................17
user-config-get..........................................................................................................................18
IV - Tips & Tricks..................................................................................................................19
A - Running .....................................................................................................................19
Quit / Skip tests.........................................................................................................................19
Boucles d'execution...................................................................................................................19
Test d'execution.........................................................................................................................19

PTSuite 2.6.odt 3
I - Phoronix Test Suite Installation 10/12/10

I - Phoronix Test Suite Installation

The Phoronix Test Suite can run on almost any Linux distribution along with Apple Mac OS
X, FreeBSD, OpenBSD, NetBSD, OpenSolaris, webOS / Optware, and other operating
systems. The only Linux distribution-specific bits deal with the external dependencies
support feature that are set by individual test profiles. If you are not running one of the
supported Linux distributions (Ubuntu, Fedora, Mandriva, Gentoo, PCLinuxOS, Arch Linux,
Pardus, OpenSuSE, Zenwalk, and CentOS), OpenSolaris, FreeBSD, NetBSD, 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.

A - Dependencies

The only required dependencies for the Phoronix Test Suite on Linux systems is PHP 5.x
CLI (packages for it are commonly called php5-cli or php-cli or just php). It's important to
note that only PHP 5 is needed and not a web server (Apache) or other packages
commonly associated with PHP. Additionally, the PHP GD module (commonly called php-
gd or php5-gd) is recommended to render graphs to PNG image files, but other renderers
are available. Likewise, if you wish to use the Adobe SWF renderer, the PHP Ming module
(commonly called php-ming or php5-ming) is required. If you wish to use the result-file-to-
pdf option, the PHP FPDF (commonly called php-fpdf or php5-fpdf) module is needed.

Note #1: Depending upon your distribution's package configuration, you may also need
php-posix package for providing the POSIX functions.

While PHP is the only required dependency, many of the test profiles do require the
standard Linux development tools/libraries (GCC, etc). On a clean Ubuntu installation, it's
as easy as first running sudo apt-get install php5-cli and then running the Phoronix Test
Suite as it will take care of installing additional dependencies. Most Phoronix Test Suite
development is done on Ubuntu and Fedora systems, but the Phoronix Test Suite is
routinely tested against a variety of Linux distributions and other supported operating
systems.

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. To
see all possible External Dependencies, run phoronix-test-suite list-possible-
dependencies. Running phoronix-test-suite list-missing-dependencies will attempt to report
the external dependencies that are not installed on the given system.

PTSuite 2.6.odt 4
I - Phoronix Test Suite Installation 10/12/10

B - File Structure

If manually changing the location of the phoronix-test-suite launcher file, the

PTS_USER_DIR environmental variable must be adjusted inside the file to reflect the
absolute location that leads to the root directory of the pts and pts-core folders.

The pts folder houses the XML test profiles, XML test suites, test resource files, and
other important information. The pts-core directory contains the "engine" of the Phoronix
Test Suite.

C - Running Locally

The Phoronix Test Suite can be simply extracted from the downloaded .tar.gz 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 ./phoronix­test­suite <options> from the
same directory.

D - Generic Installation

Running install­sh from the root directory of the Phoronix Test Suite will install the
software for system-wide access.

• By default the phoronix-test-suite executable is in /usr/bin/,

• the Phoronix Test Suite files in /usr/share/phoronix­test­suite/,
• and the documentation in /usr/share/doc/phoronix­test­suite/.

Root access is required. The default installation prefix is /usr/ but can be adjusted as
the first argument (example: install­sh   /home/user/ to install the Phoronix Test
Suite in your home directory).

E - Debian/Ubuntu Installation

Debian/Ubuntu users are able to follow the Generic Installation instructions or optionally
can generate their own Debian package.

If dpkg-dev is installed, run php   pts­core/static/scripts/build­package­

deb.php.
A Debian package will be generated which can be subsequently installed.

This package contains the phoronix-test-suite executable in /usr/bin/, the Phoronix Test
Suite files in /usr/share/phoronix-test-suite/, and the documentation in
/usr/share/doc/phoronix-test-suite/.

PTSuite 2.6.odt 5
I - Phoronix Test Suite Installation 10/12/10

Phoronix Media maintains a Debian package repository for the Phoronix Test Suite of
all the latest releases.

To use this repository, add the following line :

deb http://www.phoronix­test­suite.com/releases/repo pts.debian/ 

to the end of your /etc/apt/sources.list file. A phoronix-test-suite package can also

be found in the official Ubuntu universe repository beginning with the Ubuntu 9.04 (Jaunty)
release, but it may be out of date compared to our latest version.

F - Download Cache For Tests

If you are a company or simply own multiple computers, the download caching support of
the Phoronix Test Suite can work quite well. This feature allows you to very simply
setup a local (or network-wide) repository for the Phoronix Test Suite of all the files
the different tests use. After you have installed the tests on one system that you normally
use (or have ran phoronix-test-suite install all) running phoronix-test-suite make-download-
cache will cache all of the files that each test downloaded. The location of this cache
is ~/.phoronix-test-suite/download-cache/.
Once the cache has been created, you can copy this folder to other systems and place the
files in the same location. Then when the Phoronix Test Suite needs to download a file for
a test, before downloading it from the Internet it will first check this cache for the file(s). If
the files are there and the MD5 check-sums have been verified, it will simply copy the file
-- thereby saving bandwidth and time. The download cache location can be downloaded
in ~/.phoronix­test­suite/user­config.xml. By adjusting the download cache,
you could setup the cache folder to be on an FTP or NFS share (as an example) on a
server that's accessible via your LAN. Configure your test systems to use this local
repository and you will be saving time and bandwidth.

PTSuite 2.6.odt 6
II - Default Files & Folders 10/12/10

II - Default Files & Folders

~/.phoronix­test­suite/user­config.xml

This is a per-user configuration file. Among the information stored here is the Phoronix
Global account information, test options, locations for storing files, and batch mode
options. This file is formatted in XML.

~/.phoronix­test­suite/graph­config.xml

This is a per-user configuration file for storing graph attributes. The adjustable options
include HTML hex color codes for different areas of the graph, dimensions of the graph,
and font sizes. This file is formatted in XML.

~/.phoronix­test­suite/download­cache/

This directory contains test packages that have been generated when running phoronix-
test-suite make-download-cache. For more information on the download cache, view the
included HTML documentation.

~/.phoronix­test­suite/installed­tests/

This directory is where tests are installed by default. Each test has its own directory
within installed-tests/. In the test's folder is a pts-install.xml file used for managing the
installation.

~/.phoronix­test­suite/test­results/

This directory is where tests results are saved by default. Each saved file has its own
directory. In the saved directory is then a composite.xml file containing the useful results
while in the test-X.xml files are back-ups of the results. In the result-graphs sub-directory
are the rendered graph image files.

~/.phoronix­test­suite/modules­data/

This is the directory where any Phoronix Test Suite modules should save any files to,
within a sub-directory of the module's name. The module configuration settings are also
stored within this directory.

~/.phoronix­test­suite/test­profiles/

PTSuite 2.6.odt 7
II - Default Files & Folders 10/12/10

This is the directory where locally installed test profiles can be stored. This is similar to
the pts/test-profiles/directory within the Phoronix Test Suite package.

~/.phoronix­test­suite/test­resources/

This is the directory where locally installed test profile resources can be stored. This is
similar to the pts/test-resources/ directory within the Phoronix Test Suite package.

~/.phoronix­test­suite/test­suites/

This is the directory where locally installed test suite profiles can be stored. This is similar
to the pts/test-suites/directory within the Phoronix Test Suite package.

PTSuite 2.6.odt 8
III - Phoronix Test Suite Options 10/12/10

III - Phoronix Test Suite Options

A - Test Installation Options

install <To Install>

This option will install the selected test(s) inside the testing environment directory (defaults
to ~/.phoronix-test-suite/installed-tests). 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 Phoronix Global 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.

batch-install <To Install>

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.

B - Run Options

benchmark <To Run>

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. The name of the test or suite must be supplied or the Phoronix Global 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.

default-benchmark <To Run>

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. The name of the test or suite must be supplied or
the Phoronix Global 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.

PTSuite 2.6.odt 9
III - Phoronix Test Suite Options 10/12/10

run <To Run>

This option will run the selected test(s). The name of the test or suite must be supplied or
the Phoronix Global 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.

default-run <To Run>

This option will run the selected test(s). The name of the test or suite must be supplied or
the Phoronix Global 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.

run-tests-in-suite <To Run>

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's options rather than using the defaults
supplied by the suite.

estimate-run-time <To Run>

This option will attempt to estimate how much time is needed to run the specified test,
suite, Phoronix Global test, or saved results file. The estimated time for each individual test
is displayed along with the overall time required. These time estimates are based upon the
average run-time for previous test runs and/or estimates specified within the test profile(s).

C - Recovery Run Options

finish-run <Saved Results File>

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.

recover-run <Saved Results File>

This option is similar to finish-run and can be used to finish running a set of tests that were
started but never finished. 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. Differing from finish-run, recover-run can be used if the system had
crashed during the testing process and the test results from before the crash happened
can generally be recovered.

PTSuite 2.6.odt 10
III - Phoronix Test Suite Options 10/12/10

D - Batch Run Options

batch-setup
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 Phoronix Global and prompting for the saved file
name.

batch-run <To Run>

This option and its arguments are equivalent to the run option, but the process will be run
in the Phoronix Test Suite batch mode.

batch-benchmark <To Run>

This option and its arguments are equivalent to the benchmark option, but the process will
be run in the Phoronix Test Suite batch mode.

E - Test Dependency Options

install-dependencies <To Install>

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're
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. Optionally, a Phoronix
Global ID or the name of a saved results file can be supplied as well and the external
dependencies will automatically be extracted from that information. The install-
dependencies option will only install the dependencies on tests that utilize this feature.
When using the install option, the external dependencies are automatically checked.

list-possible-dependencies
This option will list all possible external dependencies used by tests within the Phoronix
Test Suite.

list-installed-dependencies
This option will list all external dependencies used by tests within the Phoronix Test Suite
that are installed on the system.

list-missing-dependencies
This option will list all external dependencies used by tests within the Phoronix Test Suite
that are not installed or missing from the system.

PTSuite 2.6.odt 11
III - Phoronix Test Suite Options 10/12/10

F - Test Options

list-tests
This option will list all available tests. The name, title, status, and license are displayed for
each test. Tests that aren't supported on the system due to architecture or platform
limitations aren't listed.

list-all-tests
This option is like list-tests but will also lists tests that are marked of an EXPERIMENTAL,
PRIVATE, BROKEN, or UNVERIFIED state. The name, title, status, and license are
displayed for each test.

list-suites
This option will list all available test suites. The name, title, and type are displayed for each
suite.

list-installed-tests
This option will list all tests that have been installed by the Phoronix Test Suite.

list-installed-suites
This option will list all suites where all of the contained tests have been installed by the
Phoronix Test Suite.

list-test-usage
This option is similar to list-installed-tests with showing the tests that are installed, but it
will also show the date/time a test was installed, when the test was last run, and the
number of times the test was run by the Phoronix Test Suite.

info <To Show>

This option will show details about the test, suite, virtual suite, or result file that's supplied
as the first argument to this option. When supplying the name of a test, the version,
maintainer, type, download size, license information, and suites using this test are
displayed. When supplying the name of a suite, the version, maintainer, type, and tests
that make up the suite are displayed.

PTSuite 2.6.odt 12
III - Phoronix Test Suite Options 10/12/10

G - Result Viewing Options

list-results
This option will list all saved results. The file name, title, test(s) performed, and result
identifiers are displayed.

show-result <To Show>

This option will show the test results of the selected file (set as the first argument) in the
default web browser.

remove-result <To Remove>

This option will permanently remove the saved file reset that is set as the first argument.

remove-all-results
This option will permanently remove all saved results.

remove-installed-test <To Remove>

This option will permanently remove a installed test by the Phoronix Test Suite. If all is
passed as an argument, every installed test will be removed.

merge-results <To Merge> <To Merge> <To Save As>

This option will manually merge multiple sets of test results generated by the Phoronix Test
Suite. For the arguments, the name of the test or suite must be supplied or the Phoronix
Global ID or saved local file name. As of Phoronix Test Suite 1.8, more than two
arguments can be specified to merge many sets of test results.

reference-comparison <Saved Result>

This option will allow you to compare your test results to available reference system results
on supported test profiles and suites.

result-file-to-pdf <Saved Name>

This option will read a saved test results file and save a copy of it as an Adobe PDF file for
easy distribution. The system details are written to the PDF file along with JPEG versions
of all graphs and related information.

result-file-to-text <Saved Name>

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 to the screen.

PTSuite 2.6.odt 13
III - Phoronix Test Suite Options 10/12/10

result-file-to-csv <Saved Name>

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.

H - Result Editing Options

extract-from-result-file <Saved Result>

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.

remove-from-result-file <Saved Result>

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.

reorder-result-file <Saved Result>

This option is used if you wish to change the order in which test results are shown in the
PTS 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.

rename-identifier-in-result-file <Saved Result>

This option is used if you wish to change the name of the identifier in a test results file that
is shown in the PTS 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 and then
enter the new name.

copy-run-in-result-file <Saved Result>

This option is used if you wish to change an existing test run within a saved results file.

edit-result-file <Saved Result>

The edit-result-file option is a meta command for accessing the other options within the
result editing section, but without the need to remember each of the different commands.
When running edit-result-file, a menu will be displayed that allows the user to pick
what editing option to use.

PTSuite 2.6.odt 14
III - Phoronix Test Suite Options 10/12/10

J - Analytical Options

analyze-result-file <Saved Name>

This option will output some analytical / statistical information for a given result file, such
as the number of times a given test run performed the best between other test runs,
etc. More in-depth information will be added in a future release. We welcome your
feedback to know the type of information you would like to see in this area.

analyze-batch <Saved Name>

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).

analyze-image-delta <Saved Name>

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.

analyze-all-runs <Saved Name>

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's numerical result data from
all trial runs.
The 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.

K - Module Options

list-modules
This option will list all modules that are installed / present in the pts-
core/modules/ directory. Modules are used for extending the functionality of the Phoronix
Test Suite without over-inflating the pts-core.

module-info <Module Name>

This option will show detailed information on a PTS module such as the version,
developer, and a description of its purpose.

module-setup <Module Name>

This option will allow you to configure all available end-user options for a PTS 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.

PTSuite 2.6.odt 15
III - Phoronix Test Suite Options 10/12/10

L - Test/Suite Creation

build-suite
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.

result-file-to-suite <Saved Name>

This option will guide the user through the process of generating their own test suite, which
they can then run, that's based upon an existing test results file.

validate-test-profile <Test>
This option will run automated checks on a Phoronix Test Suite test profile in an effort to
catch common errors or warnings with the test profile, such as missing XML tags or other
issues.

debug-run <To Run>

This option is intended for use by test profile writers and is identical to the run 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.

debug-install <To Install>

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.

validate-test-suite <Suite>
This option will run automated checks on a Phoronix Test Suite test suite in an effort to
catch common errors or warnings with the test suite, such as missing XML tags or other
issues.

PTSuite 2.6.odt 16
III - Phoronix Test Suite Options 10/12/10

M - Miscellaneous Options

make-download-cache
This option will backup all files that were automatically downloaded by the Phoronix Test
Suite during the installation of tests. These files are automatically backed up by default
to ~/.phoronix-test-suite/download-cache/. By backing up these files, one can easily
transfer these files to another system running the Phoronix Test Suite thereby conserving
bandwidth and reducing time. Through modifying the user configuration file (at ~/.phoronix-
test-suite/user-config.xml), the download cache location can be adjusted. The Phoronix
Test Suite supports reading from download caches over the network and on remote file-
systems.

system-info
This option will show installed system hardware and software that has been detected by
the Phoronix Test Suite.

diagnostics
This option will print information that is useful to developers when debugging problems
with the Phoronix Test Suite.

version
This option will print the Phoronix Test Suite version.

refresh-graphs <Saved Name>

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.

rebuild-composite-xml <Saved Name>

This option will rebuild the composite.xml file for a result file from the test-X.xml data, if the
result's composite XML data was corrupted or otherwise modified.

network-setup
This option allows the user to configure how the Phoronix Test Suite connects to Phoronix
Global and other web-services. Connecting through an HTTP proxy can be configured
through this option.

user-config-reset
This option will generate a new user configuration (user-config.xml) file.

user-config-set
This command will set new option value(s) for user configuration options stored
in ~/.phoronix-test-suite/user-config.xml. The tag name must be specified followed by an

PTSuite 2.6.odt 17
III - Phoronix Test Suite Options 10/12/10

equal sign and then the new value. Example:phoronix-test-suite user-config-set

CacheDirectory=~/cache/ to set a new cache directory for the Phoronix Test Suite.

user-config-get
This command will read option value(s) from the user configuration file stored
in ~/.phoronix-test-suite/user-config.xml. The tag name must be specified or all can be
supplied to read all values. Example: phoronix-test-suite user-config-get CacheDirectory to
read the current cache directory location.

PTSuite 2.6.odt 18
IV - Tips & Tricks 10/12/10

IV - Tips & Tricks

A - Running

Quit / Skip tests

- If while running multiple tests you want to quit the testing prematurely,
In a new terminal window type touch ~/.phoronix­test­suite/halt­testing.

- If you wish to stop the current test run prematurely but continue the testing process,
In a new terminal window type touch ~/.phoronix­test­suite/skip­test.

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.

Boucles d'execution
- If you want the specified test(s) to run in a loop for a set period of time, use
the TOTAL_LOOP_TIMEenvironmental variable. For instance, running

TOTAL_LOOP_TIME=120 phoronix­test­suite benchmark ffmpegwould 

- If you want the specified test(s) to run in a loop for a set number of times, use
the TOTAL_LOOP_COUNTenvironmental variable. For instance, running

TOTAL_LOOP_COUNT=3 phoronix­test­suite benchmark ffmpeg

Test d'execution

- 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 phoronix-test-
suite.active (i.e. /tmp/phoronix­test­suite.active) 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.

PTSuite 2.6.odt 19