Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "PROVE 1" | |
132 | .TH PROVE 1 "2007-06-19" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | prove \-\- A command\-line tool for running tests against Test::Harness | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | prove [options] [files/directories] | |
138 | .PP | |
139 | Options: | |
140 | .PP | |
141 | .Vb 15 | |
142 | \& -b, --blib Adds blib/lib to the path for your tests, a la "use blib". | |
143 | \& -d, --debug Includes extra debugging information. | |
144 | \& -D, --dry Dry run: Show the tests to run, but don't run them. | |
145 | \& --ext=x Extensions (defaults to .t) | |
146 | \& -h, --help Display this help | |
147 | \& -H, --man Longer manpage for prove | |
148 | \& -I Add libraries to @INC, as Perl's -I | |
149 | \& -l, --lib Add lib to the path for your tests. | |
150 | \& -r, --recurse Recursively descend into directories. | |
151 | \& -s, --shuffle Run the tests in a random order. | |
152 | \& -T Enable tainting checks | |
153 | \& -t Enable tainting warnings | |
154 | \& --timer Print elapsed time after each test file | |
155 | \& -v, --verbose Display standard output of test scripts while running them. | |
156 | \& -V, --version Display version info | |
157 | .Ve | |
158 | .PP | |
159 | Single-character options may be stacked. Default options may be set by | |
160 | specifying the \s-1PROVE_SWITCHES\s0 environment variable. | |
161 | .SH "OVERVIEW" | |
162 | .IX Header "OVERVIEW" | |
163 | \&\fIprove\fR is a command-line interface to the test-running functionality | |
164 | of \f(CW\*(C`Test::Harness\*(C'\fR. With no arguments, it will run all tests in the | |
165 | current directory. | |
166 | .PP | |
167 | Shell metacharacters may be used with command lines options and will be exanded | |
168 | via \f(CW\*(C`glob\*(C'\fR. | |
169 | .ie n .SH "PROVE VS. ""MAKE TEST""" | |
170 | .el .SH "PROVE VS. ``MAKE TEST''" | |
171 | .IX Header "PROVE VS. MAKE TEST" | |
172 | \&\fIprove\fR has a number of advantages over \f(CW\*(C`make test\*(C'\fR when doing development. | |
173 | .IP "* \fIprove\fR is designed as a development tool" 4 | |
174 | .IX Item "prove is designed as a development tool" | |
175 | Perl users typically run the test harness through a makefile via | |
176 | \&\f(CW\*(C`make test\*(C'\fR. That's fine for module distributions, but it's | |
177 | suboptimal for a test/code/debug development cycle. | |
178 | .IP "* \fIprove\fR is granular" 4 | |
179 | .IX Item "prove is granular" | |
180 | \&\fIprove\fR lets your run against only the files you want to check. | |
181 | Running \f(CW\*(C`prove t/live/ t/master.t\*(C'\fR checks every \fI*.t\fR in \fIt/live\fR, | |
182 | plus \fIt/master.t\fR. | |
183 | .IP "* \fIprove\fR has an easy verbose mode" 4 | |
184 | .IX Item "prove has an easy verbose mode" | |
185 | \&\fIprove\fR has a \f(CW\*(C`\-v\*(C'\fR option to see the raw output from the tests. | |
186 | To do this with \f(CW\*(C`make test\*(C'\fR, you must set \f(CW\*(C`HARNESS_VERBOSE=1\*(C'\fR in | |
187 | the environment. | |
188 | .IP "* \fIprove\fR can run under taint mode" 4 | |
189 | .IX Item "prove can run under taint mode" | |
190 | \&\fIprove\fR's \f(CW\*(C`\-T\*(C'\fR runs your tests under \f(CW\*(C`perl \-T\*(C'\fR, and \f(CW\*(C`\-t\*(C'\fR runs them | |
191 | under \f(CW\*(C`perl \-t\*(C'\fR. | |
192 | .IP "* \fIprove\fR can shuffle tests" 4 | |
193 | .IX Item "prove can shuffle tests" | |
194 | You can use \fIprove\fR's \f(CW\*(C`\-\-shuffle\*(C'\fR option to try to excite problems | |
195 | that don't show up when tests are run in the same order every time. | |
196 | .IP "* \fIprove\fR doesn't rely on a make tool" 4 | |
197 | .IX Item "prove doesn't rely on a make tool" | |
198 | Not everyone wants to write a makefile, or use ExtUtils::MakeMaker | |
199 | to do so. \fIprove\fR has no external dependencies. | |
200 | .IP "* Not everything is a module" 4 | |
201 | .IX Item "Not everything is a module" | |
202 | More and more users are using Perl's testing tools outside the | |
203 | context of a module distribution, and may not even use a makefile | |
204 | at all. | |
205 | .SH "COMMAND LINE OPTIONS" | |
206 | .IX Header "COMMAND LINE OPTIONS" | |
207 | .Sh "\-b, \-\-blib" | |
208 | .IX Subsection "-b, --blib" | |
209 | Adds blib/lib to the path for your tests, a la \*(L"use blib\*(R". | |
210 | .Sh "\-d, \-\-debug" | |
211 | .IX Subsection "-d, --debug" | |
212 | Include debug information about how \fIprove\fR is being run. This | |
213 | option doesn't show the output from the test scripts. That's handled | |
214 | by \-v,\-\-verbose. | |
215 | .Sh "\-D, \-\-dry" | |
216 | .IX Subsection "-D, --dry" | |
217 | Dry run: Show the tests to run, but don't run them. | |
218 | .Sh "\-\-ext=extension" | |
219 | .IX Subsection "--ext=extension" | |
220 | Specify extensions of the test files to run. By default, these are .t, | |
221 | but you may have other non\-.t test files, most likely .sh shell scripts. | |
222 | The \-\-ext is repeatable. | |
223 | .Sh "\-I" | |
224 | .IX Subsection "-I" | |
225 | Add libraries to \f(CW@INC\fR, as Perl's \-I. | |
226 | .Sh "\-l, \-\-lib" | |
227 | .IX Subsection "-l, --lib" | |
228 | Add \f(CW\*(C`lib\*(C'\fR to \f(CW@INC\fR. Equivalent to \f(CW\*(C`\-Ilib\*(C'\fR. | |
229 | .Sh "\-r, \-\-recurse" | |
230 | .IX Subsection "-r, --recurse" | |
231 | Descends into subdirectories of any directories specified, looking for tests. | |
232 | .Sh "\-s, \-\-shuffle" | |
233 | .IX Subsection "-s, --shuffle" | |
234 | Sometimes tests are accidentally dependent on tests that have been | |
235 | run before. This switch will shuffle the tests to be run prior to | |
236 | running them, thus ensuring that hidden dependencies in the test | |
237 | order are likely to be revealed. The author hopes the run the | |
238 | algorithm on the preceding sentence to see if he can produce something | |
239 | slightly less awkward. | |
240 | .Sh "\-t" | |
241 | .IX Subsection "-t" | |
242 | Runs test programs under perl's \-t taint warning mode. | |
243 | .Sh "\-T" | |
244 | .IX Subsection "-T" | |
245 | Runs test programs under perl's \-T taint mode. | |
246 | .Sh "\-\-timer" | |
247 | .IX Subsection "--timer" | |
248 | Print elapsed time after each test file | |
249 | .Sh "\-v, \-\-verbose" | |
250 | .IX Subsection "-v, --verbose" | |
251 | Display standard output of test scripts while running them. Also sets | |
252 | \&\s-1TEST_VERBOSE\s0 in case your tests rely on them. | |
253 | .Sh "\-V, \-\-version" | |
254 | .IX Subsection "-V, --version" | |
255 | Display version info. | |
256 | .SH "BUGS" | |
257 | .IX Header "BUGS" | |
258 | Please use the \s-1CPAN\s0 bug ticketing system at <http://rt.cpan.org/>. | |
259 | You can also mail bugs, fixes and enhancements to | |
260 | \&\f(CW\*(C`<bug\-test\-harness@rt.cpan.org>\*(C'\fR. | |
261 | .SH "TODO" | |
262 | .IX Header "TODO" | |
263 | .IP "\(bu" 4 | |
264 | Shuffled tests must be recreatable | |
265 | .SH "AUTHORS" | |
266 | .IX Header "AUTHORS" | |
267 | Andy Lester \f(CW\*(C`<andy@petdance.com>\*(C'\fR | |
268 | .SH "COPYRIGHT" | |
269 | .IX Header "COPYRIGHT" | |
270 | Copyright 2005 by Andy Lester \f(CW\*(C`<andy@petdance.com>\*(C'\fR. | |
271 | .PP | |
272 | This program is free software; you can redistribute it and/or | |
273 | modify it under the same terms as Perl itself. | |
274 | .PP | |
275 | See <http://www.perl.com/perl/misc/Artistic.html>. |