.TH eunit 3erl "eunit 2.8.2" "" "Erlang Module Definition"
.SH NAME
eunit \- This module is the main EUnit user interface.
.SH DESCRIPTION
.LP
This module is the main EUnit user interface\&.
.SH EXPORTS
.LP
.B
start() -> term() 
.br
.RS
.LP
Starts the EUnit server\&. Normally, you don\&'t need to call this function; it is started automatically\&.
.RE

.LP
.B
stop() -> term() 
.br
.RS
.LP
Stops the EUnit server\&. Normally, you don\&'t need to call this function\&.
.RE

.LP
.B
test(Tests) -> term() 
.br
.RS
.LP
Equivalent to test(Tests, [])\&.
.RE

.LP
.B
test(Tests::term(), Options::[term()]) -> ok | {error, term()}
.br
.RS
.LP
Runs a set of tests\&. The format of \fITests\fR\& is described in the section EUnit test representation of the overview\&.
.LP
Example:
.LP
.nf
  eunit:test(fred)
.fi
.LP
runs all tests in the module \fIfred\fR\& and also any tests in the module \fIfred_tests\fR\&, if that module exists\&.
.LP
Options:
.RS 2
.TP 2
.B
\fIverbose\fR\&:
Displays more details about the running tests\&.
.TP 2
.B
\fIprint_depth\fR\&:
Maximum depth to which terms are printed in case of error\&.
.TP 2
.B
\fIexact_execution\fR\&:
If this boolean flag is set to \fItrue\fR\& framework will not automatically execute tests found in related module suffixed with "_tests"\&. This behaviour might be unwanted if execution of modules found in a folder is ordered while it contains both source and test modules\&.
.RE
.LP
Options in the environment variable EUNIT are also included last in the option list, i\&.e\&., have lower precedence than those in \fIOptions\fR\&\&.
.LP
\fISee also:\fR\& test/1\&.
.RE

.SH AUTHORS
.LP
Mickaël Rémond
.I
<mickael\&.remond@process-one\&.net>
.LP
Richard Carlsson
.I
<carlsson\&.richard@gmail\&.com>