Phoronix Test Suite - Phoronix Test Suite Options

<< Documentation Home
Phoronix Test Suite Options

# Phoronix Test Suite Options

## 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 PTS 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.

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. The distributions supported at this time are CentOS, Fedora, Mandriva Linux, and Ubuntu. 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 PTS 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.

install-all

This option will install all available 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.

list-installed-tests

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

list-possible-dependencies

List all possible external dependencies used by tests within the Phoronix Test Suite.

## Testing 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 PTS Global ID or saved local file name.

run <To Run>

This option will run the selected test(s). The name of the test or suite must be supplied or the PTS Global ID or saved local file name.

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.

## Batch Testing 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 PTS 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 ran 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 ran in the Phoronix Test Suite batch mode.

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

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 PTS Global ID or saved local file name.

upload <To Upload>

This option allows you to upload a saved result to PTS Global.

login

This option allows you to log-in to your PTS Global account and will store this information automatically. A new PTS Global account can be created (for free) at http://global.phoronix-test-suite.com/.

## 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, the download cache location can be adjusted. The Phoronix Test Suite supports reading from download caches over the network and on remote file-systems.

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.

system-info

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

sensor-options

This option will show system sensors that can be monitored through 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.

## Other Options

force-install <To Install>

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 should only be used when debugging a test installation problem.

force-install-all

This option will force the installation (or re-installation) of all tests. The process is similar to the install-all option but even if a test is installed, the entire installation process will automatically be executed. This option should only be used when debugging a test installation problem.

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.

initial-config

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

sensors

Show sensors detected by the Phoronix Test Suite and read their current values.

Phoronix-Test-Suite.com
Copyright © 2008 by Phoronix Media.