phoronix-test-suite(1)

1phoronix-test-suite(1)      General Commands Manual     phoronix-test-suite(1)
2
3
4

NAME

6       phoronix-test-suite  -  The  Phoronix Test Suite is an extensible open-
7       source platform for performing testing and performance  evaluation.  It
8       supports  benchmarking on Linux, OpenSolaris, BSD, and Mac OS X operat‐
9       ing systems.
10

SYNOPSIS

12       phoronix-test-suite [options]
13       phoronix-test-suite install [test | suite]
14       phoronix-test-suite benchmark [test | suite]
15

DESCRIPTION

17       The Phoronix Test Suite is the most comprehensive  testing  and  bench‐
18       marking  platform  available for the Linux operating system. This soft‐
19       ware is designed to effectively carry out both qualitative and  quanti‐
20       tative  benchmarks  in  a  clean, reproducible, and easy-to-use manner.
21       This software is based upon the extensive Linux benchmarking  work  and
22       internal  tools  developed  by Phoronix.com since 2004 along with input
23       from leading tier-one computer hardware vendors. This software is open-
24       source  and  licensed under the GNU GPLv3. The Phoronix Test Suite con‐
25       sists of a lightweight processing core (pts-core) with  each  benchmark
26       consisting  of  an XML-based profile with related resource scripts. The
27       process from the benchmark installation, to the actual benchmarking, to
28       the  parsing  of  important hardware and software components is heavily
29       automated and completely repeatable, asking users only for confirmation
30       of actions.
31
32       The  Phoronix  Test  Suite  can  be used for simply comparing your com‐
33       puter's performance with your friends and co-workers  or  can  also  be
34       used  at  your  company  for  internal quality assurance purposes under
35       Linux. Results from the Phoronix Test Suite are displayed in a  results
36       viewer  with  optional  support  for uploading them to Phoronix Global.
37       Phoronix Global allows you to browse all uploaded results, search these
38       results, and compare other results against your own system.
39

OPTIONS

41       install <To Install>
42              This option will install the selected test(s) inside the testing
43              environment    directory    (defaults    to    ~/.phoronix-test-
44              suite/installed-tests).  The install process from downloading of
45              the test files to  the  installation  is  fully  automated.  The
46              install  option needs to be supplied with the test name or suite
47              as an argument. Optionally, a Phoronix Global ID or the name  of
48              a  saved results file can be supplied as well and the test(s) to
49              install will automatically be extracted from  that  information.
50              If  the test is already installed and was ran by the latest ver‐
51              sion of the installation process, no action will be taken.
52
53       benchmark <To Run>
54              This option will install the selected test(s)  (if  needed)  and
55              will  proceed  to  run the test(s). This option is equivalent to
56              running phoronix-test-suite with the install option followed  by
57              the  run  option. The name of the test or suite must be supplied
58              or the Phoronix Global ID or saved local file name.
59
60       batch-benchmark <To Run>
61              This option and its arguments are equivalent  to  the  benchmark
62              option,  but  the process will be ran in the Phoronix Test Suite
63              batch mode.
64
65       batch-setup
66              This option will prompt the user through the process of  config‐
67              uring the Phoronix Test Suite batch mode.
68
69       list-tests
70              This option will list all available tests. The name, title, sta‐
71              tus, and license are displayed for each test.
72
73       list-suites
74              This option will list  all  available  test  suites.  The  name,
75              title, and type are displayed for each suite.
76
77       merge-results <To Merge> <To Merge>
78              This  option  will  manually merge multiple sets of test results
79              generated by the Phoronix Test Suite.  For  the  arguments,  the
80              name  of  the  test  or  suite  must be supplied or the Phoronix
81              Global ID or saved local file name. As of  Phoronix  Test  Suite
82              1.8, more than two arguments can be specified to merge many sets
83              of  test  results.   reference-comparison  <Saved  Result>  This
84              option  will allow you to compare your test results to available
85              reference system results on supported test profiles and  suites.
86              info  <To  Show> This option will show details about the test or
87              suite that's supplied as the first argument to this option. When
88              supplying  the  name  of  a test, the version, maintainer, type,
89              download size, license information, and suites using  this  test
90              are  displayed. When supplying the name of a suite, the version,
91              maintainer, type, and tests that make  up  the  suite  are  dis‐
92              played.
93
94       login  This option allows you to log-in to your Phoronix Global account
95              and will store this information automatically.  A  new  Phoronix
96              Global    account    can    be    created    (for    free)    at
97              http://global.phoronix-test-suite.com/.
98

OTHER OPTIONS

100       gui <To Install> This option will launch the GTK user interface for the
101       Phoronix Test Suite. The PHP GTK module is required for this interface.
102
103
104       EXAMPLES
105
106       $ phoronix-test-suite benchmark universe
107              This  command  will  install (if needed) and then proceed to run
108              all tests within the universe suite.
109
110       $ phoronix-test-suite install openssl
111              This command will install (if needed) the OpenSSL test.
112
113       $ phoronix-test-suite benchmark build-linux-kernel
114              This command will install (if needed) and then  proceed  to  run
115              the build-linux-kernel test.
116
117       $ MONITOR=all phoronix-test-suite benchmark universe
118              This  command  will  install (if needed) and then proceed to run
119              all tests within the universe suite, while  recording/monitoring
120              available  system  sensors. The sensor results are then shown at
121              the end of the test.
122

OTHER OPTIONS

124       install-dependencies <To Install>
125
126       force-install <To Install>
127
128       list-possible-dependencies
129
130       run <To Run>
131
132       batch-run <To Run>
133
134       analyze-batch <Saved Name>
135
136       analyze-all-runs <Saved Name>
137
138       list-installed-tests
139
140       list-test-usage
141
142       list-results
143
144       result-info <To Show>
145
146       show-result <To Show>
147
148       remove-result <To Remove>
149
150       remove-all-results
151
152       upload-results <To Upload>
153
154       list-modules
155
156       module-info <Module Name>
157
158       test-module <Module Name>
159
160       debug-module <Module Name>
161
162       make-download-cache
163
164       clone <Phoronix Global ID>
165
166       download-test-files <To Download>
167
168       system-info
169
170       diagnostics
171
172       build-suite
173
174       result-file-to-suite
175
176       result-file-to-pdf
177
178       version
179
180       refresh-graphs <Saved Name>
181
182       initial-config
183

FILES

185       ~/.phoronix-test-suite/user-config.xml
186              This is a per-user configuration  file.  Among  the  information
187              stored  here  is  the  Phoronix Global account information, test
188              options, locations for storing files, and batch mode options.
189       ~/.phoronix-test-suite/graph-config.xml
190              This  is  a  per-user  configuration  file  for  storing   graph
191              attributes.  The adjustable options include HTML hex color codes
192              for different areas of the graph, dimensions of the  graph,  and
193              font sizes.
194       ~/.phoronix-test-suite/download-cache/
195              This  directory  contains test packages that have been generated
196              when running phoronix-test-suite make-download-cache.  For  more
197              information  on the download cache, view the included HTML docu‐
198              mentation.
199       ~/.phoronix-test-suite/installed-tests/
200              This directory is where tests are installed by default.
201       ~/.phoronix-test-suite/test-results/
202              This directory is where tests results are saved by default.
203

LICENSE

205       The Phoronix Test Suite is licensed under the GNU GPLv3,  however  some
206       of  the  test  profiles  may  link to software distribubted under other
207       licenses.
208

SUPPORT

223       Free support for the Phoronix  Test  Suite  is  available  through  the
224       Phoronix  Forums  (see http://www.phoronix.com/forums/) or the Phoronix
225       Test Suite Mailing List. Professional support and  other  services  can
226       also  be  made available to enterprise customers on an individual basis
227       by contacting Phoronix Media at http://www.phoronix-media.com/.
228

AUTHORS

230       Copyright 2008 - 2009 by Phoronix Media
231
232       Lead Developers:
233              Michael Larabel
234              Wuppermann
235
236
237
238
239PTS                       www.phoronix-test-suite.com   phoronix-test-suite(1)