NAME
phoronix-test-suite - The Phoronix Test Suite is an extensible open-
source platform for performing testing and performance evaluation. It
supports benchmarking on Linux, OpenSolaris, BSD, and Mac OS X
operating systems.
SYNOPSIS
phoronix-test-suite [options]
phoronix-test-suite install [test | suite]
phoronix-test-suite benchmark [test | suite]
DESCRIPTION
The Phoronix Test Suite is the most comprehensive testing and
benchmarking platform available that provides an extensible framework
for which new tests can be easily added. The software is designed to
effectively carry out both qualitative and quantitative benchmarks in a
clean, reproducible, and easy-to-use manner.
The Phoronix Test Suite can be used for simply comparing your
computer's performance with your friends and co-workers or can also be
used at your company for internal quality assurance purposes under
Linux. Results from the Phoronix Test Suite are displayed in a results
viewer with optional support for uploading them to Phoronix Global.
Phoronix Global allows you to browse all uploaded results, search these
results, and compare other results against your own system.
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 ran by the latest
version of the installation process, no action will be taken.
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.
batch-benchmark <To Run>
This option and its arguments are equivalent to the benchmark
option, but the process will be ran in the Phoronix Test Suite
batch mode.
batch-setup
This option will prompt the user through the process of
configuring the Phoronix Test Suite batch mode.
list-tests
This option will list all available tests. 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.
merge-results <To Merge> <To Merge>
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.
info <To Show> This option will show details about the test or
suite 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.
login This option allows you to log-in to your Phoronix Global account
and will store this information automatically. A new Phoronix
Global account can be created (for free) at
http://global.phoronix-test-suite.com/.
OTHER OPTIONS
gui <To Install> This option will launch the GTK user interface for the
Phoronix Test Suite. The PHP GTK module is required for this interface.
EXAMPLES
$ phoronix-test-suite benchmark universe
This command will install (if needed) and then proceed to run
all tests within the universe suite.
$ phoronix-test-suite install openssl
This command will install (if needed) the OpenSSL test.
$ phoronix-test-suite benchmark build-linux-kernel
This command will install (if needed) and then proceed to run
the build-linux-kernel test.
$ MONITOR=all phoronix-test-suite benchmark universe
This command will install (if needed) and then proceed to run
all tests within the universe suite, while recording/monitoring
available system sensors. The sensor results are then shown at
the end of the test.
OTHER OPTIONS
install-dependencies <To Install>
force-install <To Install>
batch-install <To Install>
list-possible-dependencies
list-installed-dependencies
list-missing-dependencies
run <To Run>
batch-run <To Run>
default-run <To Run>
finish-run <Saved Name>
recover-run <Saved Name>
analyze-image-delta <Saved Name>
analyze-batch <Saved Name>
analyze-all-runs <Saved Name>
list-installed-tests
list-installed-suites
list-test-usage
list-results
show-result <To Show>
remove-result <To Remove>
remove-all-results
upload-results <To Upload>
list-modules
module-info <Module Name>
test-module <Module Name>
debug-module <Module Name>
make-download-cache
edit-result-file <Saved Name>
extract-from-result-file <Saved Name>
reorder-result-file <Saved Name>
remove-from-result-file <Saved Name>
rename-identifier-in-result-file <Saved Name>
clone <Phoronix Global ID>
system-info
diagnostics
build-suite
result-file-to-suite
validate-test-profile <To Run>
debug-run <To Run>
validate-test-suite <To Run>
result-file-to-pdf
version
refresh-graphs <Saved Name>
network-setup
user-config-reset
user-config-set
user-config-get
FILES
~/.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.
~/.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.
~/.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.
~/.phoronix-test-suite/test-results/
This directory is where tests results are saved by default.
LICENSE
The Phoronix Test Suite is licensed under the GNU GPLv3, however some
of the test profiles may link to software distribubted under other
licenses.
SEE ALSO
To find out more information on the Phoronix Test Suite, detailed
descriptions of all available options, and other features, view the
included documentation or online documentation at:
http://www.phoronix-test-suite.com/documentation/1.2/index.html
Websites:
http://www.phoronix.com/
http://www.phoronix.com/forums/
http://www.phoronix-test-suite.com/
http://global.phoronix-test-suite.com/
SUPPORT
Free support for the Phoronix Test Suite is available through the
Phoronix Forums (see http://www.phoronix.com/forums/) or the Phoronix
Test Suite Mailing List. Professional support and other services can
also be made available to enterprise customers on an individual basis
by contacting Phoronix Media at http://www.phoronix-media.com/.
AUTHORS
Copyright 2008 - 2010 by Phoronix Media
Lead Developers:
Michael Larabel
Wuppermann