• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/
2 / Copyright (c) 2013 Boost.Test contributors
3 /
4 / Distributed under the Boost Software License, Version 1.0. (See accompanying
5 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6 /]
7
8[section:summary Summary of run-time parameters]
9
10[table
11  [
12    [Command]
13    [Short description]
14  ]
15
16  [/ ###############################################################################################]
17  [
18    [[link boost_test.utf_reference.rt_param_reference.auto_dbg `auto_start_dbg`]]
19    [Instructs the framework to automatically attach debugger in case of system failure.]
20  ]
21
22  [/ ###############################################################################################]
23  [
24    [[link boost_test.utf_reference.rt_param_reference.build_info `build_info`]]
25    [Instructs the framework to display library build information.]
26  ]
27
28  [/ ###############################################################################################]
29  [
30    [[link boost_test.utf_reference.rt_param_reference.catch_system `catch_system_error`]]
31    [Instructs the framework to catch system errors.]
32  ]
33
34  [/ ###############################################################################################]
35  [
36    [[link boost_test.utf_reference.rt_param_reference.color_output `color_output`]]
37    [Instructs the framework to produce color output]
38  ]
39
40  [/ ###############################################################################################]
41  [
42    [[link boost_test.utf_reference.rt_param_reference.detect_fp_exceptions `detect_fp_exceptions`]]
43    [Instructs the framework to trap floating point exceptions (on supported platforms).]
44  ]
45
46  [/ ###############################################################################################]
47  [
48    [[link boost_test.utf_reference.rt_param_reference.detect_memory_leaks `detect_memory_leaks`]]
49    [Instructs the framework to detect memory leaks (on supported platforms).]
50  ]
51
52  [/ ###############################################################################################]
53  [
54    [[link boost_test.utf_reference.rt_param_reference.help `help`]]
55    [Provides help on the __UTF__ parameters.]
56  ]
57
58  [/ ###############################################################################################]
59  [
60    [[link boost_test.utf_reference.rt_param_reference.list_content `list_content`]]
61    [Lists the tests units, their organization in the test tree, their enabled/disabled state...]
62  ]
63
64  [/ ###############################################################################################]
65  [
66    [[link boost_test.utf_reference.rt_param_reference.list_labels `list_labels`]]
67    [Lists the labels defined in the test module.]
68  ]
69
70  [/ ###############################################################################################]
71  [
72    [[link boost_test.utf_reference.rt_param_reference.log_format `log_format`]]
73    [Specifies the log format]
74  ]
75
76  [/ ###############################################################################################]
77  [
78    [[link boost_test.utf_reference.rt_param_reference.log_level `log_level`]]
79    [Specifies the framework's logging level]
80  ]
81
82  [/ ###############################################################################################]
83  [
84    [[link boost_test.utf_reference.rt_param_reference.log_sink `log_sink`]]
85    [Specifies where to write testing log to.]
86  ]
87
88  [/ ###############################################################################################]
89  [
90    [[link boost_test.utf_reference.rt_param_reference.logger `logger`]]
91    [Specifies the log level, format and sink of one or more loggers.]
92  ]
93
94  [/ ###############################################################################################]
95  [
96    [[link boost_test.utf_reference.rt_param_reference.output_format `output_format`]]
97    [Specifies the log format and the report format.]
98  ]
99
100  [/ ###############################################################################################]
101  [
102    [[link boost_test.utf_reference.rt_param_reference.random `random`]]
103    [Instructs the framework to run the tests in random order]
104  ]
105
106  [/ ###############################################################################################]
107  [
108    [[link boost_test.utf_reference.rt_param_reference.report_format `report_format`]]
109    [Specifies the report format.]
110  ]
111
112  [/ ###############################################################################################]
113  [
114    [[link boost_test.utf_reference.rt_param_reference.report_level `report_level`]]
115    [Specifies the level of details carried by the framework's testing result report.]
116  ]
117
118  [/ ###############################################################################################]
119  [
120    [[link boost_test.utf_reference.rt_param_reference.report_memory_leaks_to `report_memory_leaks_to`]]
121    [Specifies file name where memory leaks report should be re-directed to.]
122  ]
123
124  [/ ###############################################################################################]
125  [
126    [[link boost_test.utf_reference.rt_param_reference.report_sink `report_sink`]]
127    [Specifies where to write the testing result report to.]
128  ]
129
130  [/ ###############################################################################################]
131  [
132    [[link boost_test.utf_reference.rt_param_reference.result_code `result_code`]]
133    [Instructs the framework to return or ignore a result code indicating an error in the tests.]
134  ]
135
136  [/ ###############################################################################################]
137  [
138    [__param_run_test__]
139    [Allows to filter which test units to execute at runtime.]
140  ]
141
142  [/ ###############################################################################################]
143  [
144    [[link boost_test.utf_reference.rt_param_reference.save_pattern `save_pattern`]]
145    [Facilitates mode switching for testing output streams.]
146  ]
147
148  [/ ###############################################################################################]
149  [
150    [[link boost_test.utf_reference.rt_param_reference.show_progress `show_progress`]]
151    [Instructs the framework to print progress information. More details [link boost_test.test_output.test_output_progress here].]
152  ]
153
154  [/ ###############################################################################################]
155  [
156    [[link boost_test.utf_reference.rt_param_reference.use_alt_stack `use_alt_stack`]]
157    [Instructs the framework to use an alternative stack for signal processing (on supported platforms).]
158  ]
159
160  [/ ###############################################################################################]
161  [
162    [[link boost_test.utf_reference.rt_param_reference.usage `usage`]]
163    [Displays short usage message.]
164  ]
165
166  [/ ###############################################################################################]
167  [
168    [[link boost_test.utf_reference.rt_param_reference.wait_for_debugger `wait_for_debugger`]]
169    [Instructs the framework to pause test module before testing is started to allow debugger to attach.]
170  ]
171]
172
173[endsect]
174