Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
phoronix-test-suite(1)	    General Commands Manual	phoronix-test-suite(1)

NAME
       phoronix-test-suite  -  The  Phoronix Test Suite	is an extensible open-
       source platform for performing testing and performance evaluation.

SYNOPSIS
       phoronix-test-suite [options]
       phoronix-test-suite benchmark [test | suite]

DESCRIPTION
       The **Phoronix Test Suite**  is	the  most  comprehensive  testing  and
       benchmarking platform available for Linux, Solaris, macOS, Windows, 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.

OPTIONS
       SYSTEM
	      diagnostics 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.

       interactive
	      A	 simple	text-driven interactive	interface to the Phoronix Test
	      Suite.

       php-conf
	      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.

       shell  A	simple text-driven shell interface / helper  to	 the  Phoronix
	      Test Suite. Ideal	for those that may be new to the Phoronix Test
	      Suite

       system-info
	      Display the installed system hardware and	 software  information
	      as detected by the Phoronix Test Suite Phodevi Library.

       system-properties
	      Display  various hardware/software system	properties detected by
	      the Phoronix Device Interface (Phodevi) library.

       system-sensors
	      Display the installed system hardware and	 software  sensors  in
	      real-time	 as  detected  by  the Phoronix	Test Suite Phodevi Li-
	      brary.

       TEST INSTALLATION
	      force-install [Test | Suite | OpenBenchmarking ID	| Test Result]
	      ...   This  option  will force the installation (or re-installa-
	      tion) of a test or suite.	The arguments and process  is  similar
	      to the install option but	even if	the test is installed, the en-
	      tire installation	process	will automatically be  executed.  This
	      option  is  generally  used  when	 debugging a test installation
	      problem or wishing to re-install	test(s)	 due  to  compiler  or
	      other environmental changes.

       install [Test | Suite | OpenBenchmarking	ID | Test Result] ...
	      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 in-
	      stall 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 informa-
	      tion. 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.

       install-dependencies [Test | Suite | OpenBenchmarking ID	| Test Result]
       ...
	      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 pack-
	      age  management system. If you are running this command as a lo-
	      cal user,	you may	be prompted for	the root  password  while  the
	      process  is  running.  For unsupported distributions, the	depen-
	      dency 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  in-
	      stall   option,  the  external  dependencies  are	 automatically
	      checked.

       make-download-cache
	      This option will create a	download cache for use by the Phoronix
	      Test  Suite. The download	cache is created of test files already
	      downloaded to the	local system. If passing any test/suite	 names
	      to make-download-cache, the needed files for those test profiles
	      will first  be  automatically  downloaded	 before	 creating  the
	      cache.

       remove-installed-test [Test]
	      This  option  will  permanently  remove  a installed test	by the
	      Phoronix Test Suite.

       TESTING
	      benchmark	[Test |	Suite |	OpenBenchmarking ID | Test Result] ...
	      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	 addi-
	      tional  tests  at	 the  same  time and save the results into one
	      file.

       estimate-install-time [Test | Suite | OpenBenchmarking ID  |  Test  Re-
       sult]
	      This  option  will provide estimates for test install/setup time
	      length.

       estimate-run-time [Test | Suite | OpenBenchmarking ID | Test Result]
	      This option will provide estimates for test run-time / length.

       finish-run [Test	Result]
	      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.

       run [Test | Suite | OpenBenchmarking ID | Test Result] ...
	      This option will run the selected	test(s).

       run-random-tests
	      This option will query OpenBenchmarking.org to run random	bench-
	      marks  and  result  comparisons  on the system. This test	can be
	      used for simply supplying	interesting results from  your	system
	      onto  OpenBenchmarking.org,  stressing  your  system with	random
	      workloads, seeding new OpenBenchmarking.org results, etc.	 Basic
	      options  are  provided  at start-up for tuning the randomness of
	      the testing when running this command.

       run-subset [Test	| Suite	| OpenBenchmarking ID |	Test Result] ...
	      This option will run the selected	test(s)	but  prompt  the  user
	      when  passing  any  test	suites	or  result files what subset /
	      test(s) contained	within there to	run rather  than  running  all
	      passed tests/suites/results.

       run-tests-in-suite [Suite]
	      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.

       stress-batch-run	[Test |	Suite |	OpenBenchmarking ID | Test Result] ...
	      This option will run  the	 passed	 tests/suites  in  the	multi-
	      process  stress-testing mode while behaving by the Phoronix Test
	      Suite batch testing characteristics. The	stress-batch-run  mode
	      is  similar  to the stress-run command except that for any tests
	      passed to	it will	run all	combinations  of  the  options	rather
	      than prompting the user for the values to	be selected.

       stress-run [Test	| Suite	| OpenBenchmarking ID |	Test Result] ...
	      This  option  will  run  the  passed  tests/suites in the	multi-
	      process stress-testing mode. The stress-run mode will  not  pro-
	      duce  a  result file but is rather intended for running multiple
	      test profiles concurrently to stress / burn-in the  system.  The
	      number  of  tests	 to  run  concurrently	can be toggled via the
	      PTS_CONCURRENT_TEST_RUNS environment variable and	by default  is
	      set to a value of	2.

       strict-benchmark	[Test |	Suite |	OpenBenchmarking ID | Test Result] ...
	      This  option  is	equivalent to the `benchmark` option except it
	      enables various options to run benchmarks	an extended number  of
	      times  for  ensuring  better  statistical	 accuracy if enforcing
	      strict controls over the data quality, in	some cases running the
	      benchmarks for 20+ times.

       strict-run [Test	| Suite	| OpenBenchmarking ID |	Test Result] ...
	      This  option is equivalent to the	`run` option except it enables
	      various options to run benchmarks	an extended  number  of	 times
	      for  ensuring  better  statistical  accuracy if enforcing	strict
	      controls over the	data quality, in some cases running the	bench-
	      marks for	20+ times.

       BATCH TESTING
	      batch-benchmark  [Test  |	Suite |	OpenBenchmarking ID | Test Re-
	      sult] ...	 This option and its arguments are equivalent  to  the
	      benchmark	 option,  but  the process will	be run in the Phoronix
	      Test Suite batch mode.

       batch-install [Test | Suite | OpenBenchmarking ID | Test	Result]	...
	      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  de-
	      fault values and not prompt the user of any possible options, to
	      ensure the process is fully automated.

       batch-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
	      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-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  automati-
	      cally  upload  the  test	results	 to  OpenBenchmarking.org  and
	      prompting	for the	saved file name.

       default-benchmark [Test | Suite | OpenBenchmarking ID  |	 Test  Result]
       ...
	      This  option  will  install the selected test(s) (if needed) and
	      will proceed to run the test(s) in the defaults mode.  This  op-
	      tion  is	equivalent to running phoronix-test-suite with the in-
	      stall option followed by the default-run option.

       default-run [Test | Suite | OpenBenchmarking ID | Test Result] ...
	      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  automati-
	      cally  set by pts-core or	the test profile. Use batch-run	to au-
	      tomatically test all of the available options.

       dry-run [Test | Suite | OpenBenchmarking	ID | Test Result] ...
	      This option and its arguments pre-set the	 Phoronix  Test	 Suite
	      batch  run  mode	with enforcing of defaults to not save any re-
	      sults and	other behavior intended	for a dry/test run.  This  op-
	      tion is primarily	intended for testing/evaluation	purposes.

       internal-run [Test | Suite | OpenBenchmarking ID	| Test Result] ...
	      This  option  and	 its arguments pre-set the Phoronix Test Suite
	      batch run	mode with sane values for carrying out benchmarks in a
	      semi-automated  manner  and  without uploading any of the	result
	      data to the public OpenBenchmarking.org.

       OPENBENCHMARKING.ORG
	      clone-result [OpenBenchmarking ID] ...  This option  will	 down-
	      load  a  local  copy  of a file that was saved to	OpenBenchmark-
	      ing.org, as long as a valid public ID is supplied.

       enable-repo
	      This option is used if wanting to	add a new OpenBenchmarking.org
	      account/repository to your system	for enabling third-party/unof-
	      ficial test profiles and test suites.

       list-recommended-tests
	      This option will list recommended	test profiles for benchmarking
	      sorted  by hardware sub-system. The recommended tests are	deter-
	      mined via	querying OpenBenchmarking.org and determining the most
	      popular  tests  for a given environment based upon the number of
	      times a test profile has been downloaded,	the number of test re-
	      sults  available	on  OpenBenchmarking.org for a given test pro-
	      file, the	age of the test	profile, and other weighted factors.

       make-openbenchmarking-cache
	      This option will attempt to cache	the test  profile/suite	 meta-
	      data from	OpenBenchmarking.org for all linked repositories. This
	      is useful	if you're going	to be running the Phoronix Test	 Suite
	      /	 Phoromatic  behind a firewall or without any Internet connec-
	      tion. Those with unrestricted Internet access or not utilizing a
	      large  local  deployment of the Phoronix Test Suite / Phoromatic
	      shouldn't	need to	run this command.

       openbenchmarking-changes
	      This option will list recent changes to test profiles of enabled
	      OpenBenchmarking.org repositories.

       openbenchmarking-login
	      This  option  is	used  for controlling your Phoronix Test Suite
	      client options for OpenBechmarking.org and syncing the client to
	      your account.

       openbenchmarking-refresh
	      This  option  is	used  for refreshing the stored	OpenBenchmark-
	      ing.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.

       openbenchmarking-repositories
	      This option will list the	OpenBenchmarking.org repositories cur-
	      rently linked to this Phoronix Test Suite	client instance.

       openbenchmarking-uploads
	      This option will list any	recent test result  uploads  from  the
	      system's IP address to OpenBenchmarking.org.

       recently-added-tests
	      This option will list the	most recently added (newest) test pro-
	      files.

       upload-result [Test Result]
	      This option is used for uploading	a test	result	to  OpenBench-
	      marking.org.

       upload-test-profile
	      This option can be used for uploading a test profile to your ac-
	      count 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.

       upload-test-suite [Suite]
	      This  option  can	be used	for uploading a	test suite to your ac-
	      count 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.

       INFORMATION
	      check-tests [Test] This option will perform a check  on  one  or
	      more  test  profiles  to determine if there have been any	vendor
	      changes to the filename, filesize, url location, md5 and	sha256
	      checksums.

       info [Test | Suite | OpenBenchmarking ID	| Test Result]
	      This  option  will  show details about the supplied test,	suite,
	      virtual suite, or	result file.

       intersect [Test | Suite | OpenBenchmarking ID | Test Result] ...
	      This option will print the test profiles present in  all	passed
	      result  files  / test suites. Two	or more	results/suites must be
	      passed and printed will be all of	the common test	profiles.

       list-all-tests
	      This option will list all	test profiles that are available  from
	      the  enabled OpenBenchmarking.org	repositories. Unlike the other
	      test listing options, list-all-tests will	show deprecated	tests,
	      potentially broken tests,	or other tests not recommended for all
	      environments. The	only check in place is ensuring	the test  pro-
	      files are	at least compatible with the operating system in use.

       list-available-suites
	      This  option  will  list all test	suites that are	available from
	      the enabled OpenBenchmarking.org repositories.

       list-available-tests
	      This option will list all	test profiles that are available  from
	      the enabled OpenBenchmarking.org repositories where supported on
	      the system and are of a verified state. If the system has	no In-
	      ternet  access,  it  will	 only list the test profiles where the
	      necesary test assets are available locally on the	system	or  on
	      an available network cache (the same behavior as using the list-
	      cached-tests sub-command), unless	using the  list-all-tests  op-
	      tion to override this behavior.

       list-available-virtual-suites
	      This option will list all	available virtual test suites that can
	      be dynamically created based upon	the available tests  from  en-
	      abled OpenBenchmarking.org repositories.

       list-cached-tests
	      This  option  will  list all test	profiles where any needed test
	      profiles are already cached or available from the	 local	system
	      under  test. This	is primarily useful if testing offline/behind-
	      the-firewall and other use-cases where wanting to	rely only upon
	      local data.

       list-installed-dependencies
	      This option will list all	of the packages	/ external test	depen-
	      dencies that are	already	 installed  on	the  system  that  the
	      Phoronix	Test  Suite  may  potentially depend upon by test pro-
	      files.

       list-installed-suites
	      This option will list all	suites that are	currently installed on
	      the system.

       list-installed-tests
	      This  option  will list all test profiles	that are currently in-
	      stalled on the system.

       list-missing-dependencies
	      This option will list all	of the packages	/ external test	depen-
	      dencies  that are	missing	from the system	that the Phoronix Test
	      Suite may	potentially need by select test	profiles.

       list-not-installed-tests
	      This option will list all	test profiles that are	supported  and
	      available	but presently NOT installed on the system.

       list-possible-dependencies
	      This option will list all	of the packages	/ external test	depen-
	      dencies that are are  potentially	 used  by  the	Phoronix  Test
	      Suite.

       list-saved-results
	      This option will list all	of the saved test results found	on the
	      system.

       list-test-usage
	      This option will list various details about installed tests  and
	      their usage.

       list-unsupported-tests
	      This  option  will  list	all  available	test profiles that are
	      available	from the enabled OpenBenchmarking.org repositories but
	      are  NOT SUPPORTED on the	given hardware/software	platform. This
	      is mainly	a debugging option for those looking for test profiles
	      to potentially port to new platforms, etc.

       search This  option  provides command-line searching abilities for test
	      profiles / test suites / test results. The search	query  can  be
	      passed  as  a  parameter otherwise the user is prompted to input
	      their search query..

       test-to-suite-map
	      This option will list all	test profiles and any test suites each
	      test belongs to.

       ASSET CREATION
	      build-suite  This	option will guide the user through the process
	      of generating their own test suite, which	they can then run. Op-
	      tionally,	 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.

       create-test-profile
	      This  option can be used for creating a Phoronix Test Suite test
	      profile by answering questions about the test  for  constructing
	      the  test	 profile XML meta-data and handling other boiler-plate
	      basics for getting started in developing new tests.

       debug-benchmark [Test | Suite | OpenBenchmarking	ID | Test Result] ...
	      This option is intended for use by test profile writers  and  is
	      identical	 to the	<em>run</em> option but	will yield more	infor-
	      mation 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 [Test | Suite | OpenBenchmarking ID | Test	Result]	...
	      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 func-
	      tioning correctly.

       debug-result-parser [Test | Suite | OpenBenchmarking ID | Test  Result]
       ...
	      This  option  is intended	for use	by test	profile	writers	and is
	      used for debugging a result parser. No test execution  is	 done,
	      but  there  must	already	 be  PTS-generated  .log files present
	      within the test's	installation directory.

       debug-test-download-links [Test | Suite | OpenBenchmarking  ID  |  Test
       Result]
	      This  option  will check all download links within the specified
	      test profile(s) to ensure	there are no broken URLs.

       download-test-files [Test | Suite | OpenBenchmarking ID | Test  Result]
       ...
	      This  will  download  the	 selected test file(s) to the Phoronix
	      Test Suite download cache	but will not install the tests.

       inspect-test-profile [Test]
	      This option can be used for inspecting  a	 Phoronix  Test	 Suite
	      test  profile with providing inside details on test profiles for
	      debugging	/ evaluation / learning	purposes.

       rebuild-test-suite [Suite]
	      This option will	regenerate  the	 local	test  suite  XML  file
	      against the OpenBenchmarking.org specification. This can be used
	      to clean up any existing XML syntax / styling issues, etc.

       result-file-to-suite [Test Result]
	      This option will guide the user through the process of  generat-
	      ing their	own test suite,	which they can then run, that is based
	      upon an existing test results file.

       validate-result-file
	      This option can be used for validating a Phoronix	Test Suite re-
	      sult  file  as  being compliant against the OpenBenchmarking.org
	      specification.

       validate-test-profile [Test]
	      This option can be used for validating  a	 Phoronix  Test	 Suite
	      test profile as being compliant against the OpenBenchmarking.org
	      specification.

       validate-test-suite [Suite]
	      This option can be used for validating  a	 Phoronix  Test	 Suite
	      test  suite  as being compliant against the OpenBenchmarking.org
	      specification.

       RESULT MANAGEMENT
	      analyze-run-times	[Test Result] This option will	read  a	 saved
	      test  results  file  and print the statistics about how long the
	      testing took to complete.

       auto-sort-result-file [Test Result]
	      This option is used if you wish to automatically attempt to sort
	      the results by their result identifier string.

       compare-results-to-baseline [Test Result] [Test Result]
	      This  option  will  allows you to	specify	a result as a baseline
	      (first parameter)	and a second result  file  (second  parameter)
	      that  will offer some analysis for showing how the second	result
	      compares to the first in matching	tests.

       compare-results-two-way [Test Result]
	      This option will allows you to specify a result  file  and  from
	      there to compare two individual runs within that result file for
	      looking at wins/losses and other metrics in a head-to-head  type
	      comparison.

       edit-result-file	[Test Result]
	      This  option  is used if you wish	to edit	the title and descrip-
	      tion of an existing result file.

       extract-from-result-file	[Test 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.

       keep-results-in-result-file [Test Result]
	      This  option  is	the inverse of the remove-results-from-result-
	      file sub-command.	If you wish to remove all  results  but	 those
	      listed  from  a  given result file, this option can be used. The
	      user must	specify	a saved	results	file and  then	they  will  be
	      prompted	to provide a string to search for in keeping those re-
	      sults in that given result file but removing all other data.

       merge-results [Test Result] ...
	      This option will manually	merge multiple sets  of	 test  results
	      generated	by the Phoronix	Test Suite.

       remove-result [Test Result]
	      This  option  will permanently remove the	saved file set that is
	      set as the first argument.

       remove-result-from-result-file [Test Result]
	      This option is used if there are test results (benchmarks) to be
	      dropped  from a given result file. The user must specify a saved
	      results file and then  they  will	 be  prompted  to  select  the
	      tests/benchmarks to remove.

       remove-results-from-result-file [Test Result]
	      This option is used if there are test results (benchmarks) to be
	      dropped from a given result file.	The user must specify a	 saved
	      results  file and	then they will be prompted to provide a	string
	      to search	for in removing	those results from that	 given	result
	      file.

       remove-run-from-result-file [Test 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	 spec-
	      ify  a  saved results file and then they will be prompted	to se-
	      lect the results identifier associated  with  the	 results  they
	      wish to remove.

       rename-identifier-in-result-file	[Test Result]
	      This  option is used if you wish to change the name of the iden-
	      tifier in	a test results file that is shown in the Phoronix Test
	      Suite Results Viewer and the contained graphs.

       rename-result-file [Test	Result]
	      This  option is used if you wish to change the name of the saved
	      name of a	result file.

       reorder-result-file [Test Result]
	      This option is used if you wish to manually 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 re-
	      sults identifiers	one at a time in the  order  they  would  like
	      them to be displayed from	left to	right.

       result-file-raw-to-csv [Test Result]
	      This  option  will read a	saved test results file	and output the
	      raw result file run data to a CSV	file.  This  raw  (individual)
	      result  file output is intended for data analytic	purposes where
	      the result-file-to-csv is	more end-user-ready.

       result-file-to-csv [Test	Result]
	      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.

       result-file-to-json [Test Result]
	      This  option  will read a	saved test results file	and output the
	      basic result information to JSON (JavaScript Object Notation).

       result-file-to-pdf [Test	Result]
	      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.

       result-file-to-text [Test Result]
	      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.

       show-result [Test Result]
	      Open up the test results	in  the	 Phoronix  Test	 Suite	Result
	      Viewer or	on OpenBenchmarking.org.

       workload-topology [Test Result]
	      This  option  will  read a saved test results file and print the
	      test profiles contained within and their arrangement within dif-
	      ferent test suites for getting an	idea as	to the workload	topol-
	      ogy/make-up / logical groupings of the benchmarks	being run.

       OTHER  commands This option will	 display  a  short  list  of  possible
	      Phoronix Test Suite commands.

       debug-dependency-handler
	      This option is used for testing the distribution-specific	depen-
	      dency handler for	external dependencies.

       debug-render-test
	      This option is used during the development of the	Phoronix  Test
	      Suite  software  for  testing  of	the result and graph rendering
	      code-paths This option will download a large number of reference
	      test results from	LinuxBenchmarking.com.

       debug-self-test
	      This  option is used during the development of the Phoronix Test
	      Suite software for testing of internal interfaces, commands, and
	      other  common  code-paths.  The  produced	numbers	should only be
	      comparable for the same version of the Phoronix Test  Suite,  on
	      the  same	hardware/software system, conducted on the same	day of
	      testing. This isn't intended as  any  scientific	benchmark  but
	      simply to	stress common PHP code-paths and looking for hot areas
	      to optimize, etc.

       help   This option will display a list of available Phoronix Test Suite
	      commands and possible parameter types.

       version
	      This option will display the Phoronix Test Suite client version.

       MODULES
	      auto-load-module	This  option  can  be used for easily adding a
	      module to	the AutoLoadModules list in the	 Phoronix  Test	 Suite
	      user configuration file. That list controls what PTS modules are
	      automatically loaded on start-up of the Phoronix Test Suite.

       list-modules
	      This option will list all	of the available Phoronix  Test	 Suite
	      modules on this system.

       module-info [Phoronix Test Suite	Module]
	      This  option  will  show detailed	information on a Phoronix Test
	      Suite module such	as the version,	developer, and	a  description
	      of its purpose.

       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.

       test-module [Phoronix Test Suite	Module]
	      This option can be used for debugging a Phoronix Test Suite mod-
	      ule.

       unload-module
	      This  option  can	 be used for easily removing a module from the
	      AutoLoadModules list in the Phoronix Test	Suite user  configura-
	      tion  file.  That	 list  controls	what modules are automatically
	      loaded on	start-up of the	Phoronix Test Suite.

       USER CONFIGURATION
	      enterprise-setup This option can be run by enterprise users  im-
	      mediately	 after	package	installation or	as part	of an in-house
	      setup script. Running this command  will	ensure	the  phoronix-
	      test-suite  program  is  never interrupted on new	runs to	accept
	      user agreement changes and defaults the anonymous	usage  report-
	      ing to being disabled and	other conservative defaults.

       network-info
	      This option will print information detected by the Phoronix Test
	      Suite around the system's	network	configuration.

       network-setup
	      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.

       user-config-reset
	      This  option  can	 be used for resetting the Phoronix Test Suite
	      user configuration file to its default state.

       user-config-set
	      This option can be used for setting an XML value in the Phoronix
	      Test Suite user configuration file.

       RESULT ANALYSIS
	      executive-summary	 [Test	Result]	 This  option  will attempt to
	      auto-generate a textual executive	summary	for a result  file  to
	      highlight	prominent results / averages.

       result-file-confidence [Test Result]
	      This option will read a saved test results file and display var-
	      ious statistics on the confidence	of the results with the	 stan-
	      dard  deviation,	three-sigma  values,  and  other metrics while
	      color-coding "passing" results in	green.

       result-file-stats [Test Result]
	      This option is used if you wish to analyze a result file by see-
	      ing  various statistics on the result data for result files con-
	      taining at least two sets	of data.

       wins-and-losses [Test Result]
	      This option is used if you wish to analyze a result file to  see
	      which runs produced the most wins/losses of those	result identi-
	      fiers in the saved file.

       PHOROMATIC
	      start-phoromatic-server Start the	Phoromatic web server for con-
	      trolling	local Phoronix Test Suite client systems to facilitate
	      automated	and repeated test orchestration	 and  other  automated
	      features targeted	at the enterprise.

       RESULT VIEWER
	      n	_

       SEE ALSO
	      Websites:
	      https://www.phoronix-test-suite.com/
	      https://commercial.phoronix-test-suite.com/
	      https://www.openbenchmarking.org/
	      https://www.phoronix.com/

AUTHORS
       Copyright 2008 -	2021 by	Phoronix Media,	Michael	Larabel.


NAME | SYNOPSIS | DESCRIPTION | OPTIONS | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=phoronix-test-suite&sektion=1&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help