path: root/documentation/man-pages/phoronix-test-suite.1

.TH phoronix-test-suite 1  "www.phoronix-test-suite.com" "PTS"
.SH 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.
.SH SYNOPSIS
.B phoronix-test-suite [options]
.br
.B phoronix-test-suite install [test | suite]
.br
.B phoronix-test-suite benchmark [test | suite]
.SH DESCRIPTION
The Phoronix Test Suite is the most comprehensive testing and benchmarking platform available for the Linux operating system. This software is designed to effectively carry out both qualitative and quantitative benchmarks in a clean, reproducible, and easy-to-use manner. This software is based upon the extensive Linux benchmarking work and internal tools developed by Phoronix.com since 2004 along with input from leading tier-one computer hardware vendors. This software is open-source and licensed under the GNU GPLv3. The Phoronix Test Suite consists of a lightweight processing core (pts-core) with each benchmark consisting of an XML-based profile with related resource scripts. The process from the benchmark installation, to the actual benchmarking, to the parsing of important hardware and software components is heavily automated and completely repeatable, asking users only for confirmation of actions.
.PP
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.
.SH OPTIONS
.TP
.B 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.
.TP
.B 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.
.TP
.B 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.
.TP
.B batch-setup
This option will prompt the user through the process of configuring the Phoronix Test Suite batch mode.
.TP
.B list-tests
This option will list all available tests. The name, title, status, and license are displayed for each test.
.TP
.B list-suites
This option will list all available test suites. The name, title, and type are displayed for each suite.
.TP
.B merge-results <To Merge> <To Merge> <To Save As>
This option will manually merge two sets of test results generated by the Phoronix Test Suite. The merged results will then be saved to a new file if the targeted save name is specified as the third argument otherwise the results will be re-saved to first file. For the first two arguments, the name of the test or suite must be supplied or the Phoronix Global ID or saved local file name.
.B 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.
.TP
.B 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/.
.SH EXAMPLES
.TP
.B $ phoronix-test-suite benchmark universe
This command will install (if needed) and then proceed to run all tests within the universe suite.
.TP
.B $ phoronix-test-suite install openssl
This command will install (if needed) the OpenSSL test.
.TP
.B $ phoronix-test-suite benchmark build-linux-kernel
This command will install (if needed) and then proceed to run the build-linux-kernel test.
.TP
.B $ 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.
.SH OTHER OPTIONS
.B install-dependencies <To Install>
.TP
.B install-all
.TP
.B force-install <To Install>
.TP
.B force-install-all
.TP
.B list-possible-dependencies
.TP
.B run <To Run>
.TP
.B batch-run <To Run>
.TP
.B analyze-batch <Saved Name>
.TP
.B analyze-all-runs <Saved Name>
.TP
.B list-installed-tests
.TP
.B list-test-usage
.TP
.B list-results
.TP
.B result-info <To Show>
.TP
.B show-result <To Show>
.TP
.B remove-result <To Remove>
.TP
.B remove-all-results
.TP
.B upload-results <To Upload>
.TP
.B list-modules
.TP
.B module-info <Module Name>
.TP
.B test-module <Module Name>
.TP
.B debug-module <Module Name>
.TP
.B make-download-cache
.TP
.B clone <Phoronix Global ID>
.TP
.B download-test-files <To Download>
.TP
.B system-info
.TP
.B diagnostics
.TP
.B build-suite
.TP
.B result-file-to-suite
.TP
.B version
.TP
.B refresh-graphs <Saved Name>
.TP
.B initial-config
.PP
.SH FILES
.I ~/.phoronix-test-suite/user-config.xml
.RS
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.
.RE
.I ~/.phoronix-test-suite/graph-config.xml
.RS
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.
.RE
.I ~/.phoronix-test-suite/download-cache/
.RS
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.
.RE
.I ~/.phoronix-test-suite/installed-tests/
.RS
This directory is where tests are installed by default.
.RE
.I ~/.phoronix-test-suite/test-results/
.RS
This directory is where tests results are saved by default.
.RE
.SH 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.
.SH 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:
.PP
.B http://www.phoronix-test-suite.com/documentation/1.2/index.html
.PP
.B Websites:
.br
http://www.phoronix.com/
.br
http://www.phoronix.com/forums/
.br
http://www.phoronix-test-suite.com/
.br
http://global.phoronix-test-suite.com/
.SH 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/.
.SH AUTHORS
Copyright 2008 - 2009 by Phoronix Media
.TP
.B Lead Developers:
Michael Larabel (Michael [at] phoronix.com)
.br
Wuppermann