.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" ======================================================================== .\" .IX Title "SPECRB 1" .TH SPECRB 1 "2012-06-26" "" "" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" specrb \- standalone test runner for test/spec and Test::Unit test suites .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBspecrb\fR [\fI\s-1OPTIONS\s0\fR] [\fI\s-1FILES\s0\fR | \-a ] [\-\- untouched arguments] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Ruby script \fBspecrb\fR allows you to run tests written with test/spec from the command line. It can also be used for plain Test::Unit test suites. You can either specify the names of the test files you want to run, or let \fBspecrb\fR find automatically all the tests in your project, by using the \fB\-a\fR switch (see \s-1TEST/SPEC\s0 \s-1OPTIONS\s0 below). .PP You can also use various options on the command line to pass parameters to the Ruby interpreterm or to modify the behavior of test/spec and/or test/unit. .SH "RUBY OPTIONS" .IX Header "RUBY OPTIONS" .IP "\fB\-e\fR, \fB\-\-eval\fR \s-1LINE\s0" 4 .IX Item "-e, --eval LINE" evaluate a \s-1LINE\s0 of code .IP "\fB\-d\fR, \fB\-\-debug\fR" 4 .IX Item "-d, --debug" set debugging flags (set \f(CW$DEBUG\fR to true) .IP "\fB\-w\fR, \fB\-\-warn\fR" 4 .IX Item "-w, --warn" turn warnings on for your script .IP "\fB\-I\fR, \fB\-\-include\fR \s-1PATH\s0" 4 .IX Item "-I, --include PATH" specify \f(CW$LOAD_PATH\fR (may be used more than once) .IP "\fB\-r\fR, \fB\-\-require\fR \s-1LIBRARY\s0" 4 .IX Item "-r, --require LIBRARY" require the \s-1LIBRARY\s0, before executing your script .SH "TEST/SPEC OPTIONS:" .IX Header "TEST/SPEC OPTIONS:" .IP "\fB\-s\fR, \fB\-\-specdox\fR" 4 .IX Item "-s, --specdox" do AgileDox-like output .IP "\fB\-\-rdox\fR" 4 .IX Item "--rdox" do AgileDox-like output with RDoc formatting .IP "\fB\-a\fR, \fB\-\-automatic\fR" 4 .IX Item "-a, --automatic" gather tests from ./test/, include ./lib/ .SH "TEST::UNIT OPTIONS:" .IX Header "TEST::UNIT OPTIONS:" .IP "\fB\-n\fR, \fB\-\-name\fR \s-1NAME\s0" 4 .IX Item "-n, --name NAME" runs tests matching regexp \s-1NAME\s0 .IP "\fB\-t\fR, \fB\-\-testcase\fR \s-1TESTCASE\s0" 4 .IX Item "-t, --testcase TESTCASE" runs tests in TestCases matching regexp \s-1TESTCASE\s0 .SH "COMMON OPTIONS:" .IX Header "COMMON OPTIONS:" .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" show a message similar to this manpage .IP "\fB\-\-version\fR" 4 .IX Item "--version" show version .SH "AUTHORS" .IX Header "AUTHORS" The test/spec library has been written by Christian Neukirchen . .PP This manual page, inspired by the help message of \fBspecrb\fR, has been written for the Debian Project by Cédric Boutillier (but may used by others).