Tizen 2.1 base
[platform/upstream/glib2.0.git] / docs / reference / glib / gtester.1
1 '\" t
2 .\"     Title: gtester
3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 05/14/2012
6 .\"    Manual: User Commands
7 .\"    Source: User Commands
8 .\"  Language: English
9 .\"
10 .TH "GTESTER" "1" "05/14/2012" "User Commands" "User Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 gtester \- test running utility
32 .SH "SYNOPSIS"
33 .HP \w'\fBgtester\fR\ 'u
34 \fBgtester\fR [option...] [testprogram]
35 .SH "DESCRIPTION"
36 .PP
37 \fBgtester\fR
38 is a utility to run unit tests that have been written using the GLib test framework\&.
39 .PP
40 When called with the
41 \fB\-o\fR
42 option,
43 \fBgtester\fR
44 writes an XML report of the test results, which can be converted into HTML using the
45 \fBgtester\-report\fR
46 utility\&.
47 .SS "Options"
48 .PP
49 \fB\-h\fR, \fB\-\-help\fR
50 .RS 4
51 print help and exit
52 .RE
53 .PP
54 \fB\-v\fR, \fB\-\-version\fR
55 .RS 4
56 print version information and exit
57 .RE
58 .PP
59 \fB\-\-g\-fatal\-warnings\fR
60 .RS 4
61 make warnings fatal
62 .RE
63 .PP
64 \fB\-k\fR, \fB\-\-keep\-going\fR
65 .RS 4
66 continue running after tests failed
67 .RE
68 .PP
69 \fB\-l\fR
70 .RS 4
71 list paths of available test cases
72 .RE
73 .PP
74 \fB\-m=\fR\fB\fIMODE\fR\fR
75 .RS 4
76 run test cases in
77 \fIMODE\fR, which can be one of:
78 <term>\fBperf\fR</term><listitem>run performance tests
79 </listitem><term>\fBslow\fR, \fBthorough\fR</term><listitem>run slow tests, or repeat non\-deterministic tests more often
80 </listitem><term>\fBquick\fR</term><listitem>do not run slow or performance tests, or do extra repeats of non\-deterministic tests (default)
81 </listitem><term>\fBundefined\fR</term><listitem>run test cases that deliberately provoke checks or assertion failures, if implemented (default)
82 </listitem><term>\fBno\-undefined\fR</term><listitem>do not run test cases that deliberately provoke checks or assertion failures
83 </listitem>.sp
84 .RE
85 .PP
86 \fB\-p=\fR\fB\fITESTPATH\fR\fR
87 .RS 4
88 only run test cases matching
89 \fITESTPATH\fR
90 .RE
91 .PP
92 \fB\-s=\fR\fB\fITESTPATH\fR\fR
93 .RS 4
94 skip test cases matching
95 \fITESTPATH\fR
96 .RE
97 .PP
98 \fB\-\-seed=\fR\fB\fISEEDSTRING\fR\fR
99 .RS 4
100 run all test cases with random number seed
101 \fISEEDSTRING\fR
102 .RE
103 .PP
104 \fB\-o=\fR\fB\fILOGFILE\fR\fR
105 .RS 4
106 write the test log to
107 \fILOGFILE\fR
108 .RE
109 .PP
110 \fB\-q\fR, \fB\-\-quiet\fR
111 .RS 4
112 suppress per test binary output
113 .RE
114 .PP
115 \fB\-\-verbose\fR
116 .RS 4
117 report success per testcase
118 .RE
119 .SH "SEE ALSO"
120 .PP
121
122 \fBgtester-report\fR(1)