s4/scripting: in MIT build do not install samba-tool, it is not usable yet
[Samba/vl.git] / selftest / selftest.pl.1
blobf33b81044e9489202d3aa8a5b67ce15d1c659a3c
1 .IX Title "SELFTEST 1"
2 .TH SELFTEST 1 "2012-02-24" "selftest" "Samba"
3 .if n .ad l
4 .nh
5 .SH "NAME"
6 selftest \- Samba test runner
7 .SH "SYNOPSIS"
8 .IX Header "SYNOPSIS"
9 selftest \-\-help
10 .PP
11 selftest [\-\-srcdir=DIR] [\-\-bindir=DIR] [\-\-target=samba|samba3|win] [\-\-socket\-wrapper] [\-\-quick] [\-\-exclude=FILE] [\-\-include=FILE] [\-\-one] [\-\-prefix=prefix] [\-\-testlist=FILE] [\s-1TESTS\s0]
12 .SH "DESCRIPTION"
13 .IX Header "DESCRIPTION"
14 A simple test runner. \s-1TESTS\s0 is a regular expression with tests to run.
15 .SH "OPTIONS"
16 .IX Header "OPTIONS"
17 .IP "\fI\-\-help\fR" 4
18 .IX Item "--help"
19 Show list of available options.
20 .IP "\fI\-\-srcdir=DIR\fR" 4
21 .IX Item "--srcdir=DIR"
22 Source directory.
23 .IP "\fI\-\-bindir=DIR\fR" 4
24 .IX Item "--bindir=DIR"
25 Built binaries directory.
26 .IP "\fI\-\-prefix=DIR\fR" 4
27 .IX Item "--prefix=DIR"
28 Change directory to run tests in. Default is 'st'.
29 .IP "\fI\-\-target samba|samba3|win\fR" 4
30 .IX Item "--target samba|samba3|win"
31 Specify test target against which to run. Default is 'samba4'.
32 .IP "\fI\-\-quick\fR" 4
33 .IX Item "--quick"
34 Run only a limited number of tests. Intended to run in about 30 seconds on 
35 moderately recent systems.
36 .IP "\fI\-\-socket\-wrapper\fR" 4
37 .IX Item "--socket-wrapper"
38 Use socket wrapper library for communication with server. Only works 
39 when the server is running locally.
40 .Sp
41 Will prevent \s-1TCP\s0 and \s-1UDP\s0 ports being opened on the local host but 
42 (transparently) redirects these calls to use unix domain sockets.
43 .IP "\fI\-\-exclude\fR" 4
44 .IX Item "--exclude"
45 Specify a file containing a list of tests that should be skipped. Possible 
46 candidates are tests that segfault the server, flip or don't end.
47 .IP "\fI\-\-include\fR" 4
48 .IX Item "--include"
49 Specify a file containing a list of tests that should be run. Same format 
50 as the \-\-exclude flag.
51 .Sp
52 Not includes specified means all tests will be run.
53 .IP "\fI\-\-one\fR" 4
54 .IX Item "--one"
55 Abort as soon as one test fails.
56 .IP "\fI\-\-testlist\fR" 4
57 .IX Item "--testlist"
58 Load a list of tests from the specified location.
59 .SH "ENVIRONMENT"
60 .IX Header "ENVIRONMENT"
61 .IP "\fI\s-1SMBD_VALGRIND\s0\fR" 4
62 .IX Item "SMBD_VALGRIND"
63 .PD 0
64 .IP "\fI\s-1TORTURE_MAXTIME\s0\fR" 4
65 .IX Item "TORTURE_MAXTIME"
66 .IP "\fI\s-1VALGRIND\s0\fR" 4
67 .IX Item "VALGRIND"
68 .IP "\fI\s-1TLS_ENABLED\s0\fR" 4
69 .IX Item "TLS_ENABLED"
70 .IP "\fIsrcdir\fR" 4
71 .IX Item "srcdir"
72 .PD
73 .SH "LICENSE"
74 .IX Header "LICENSE"
75 selftest is licensed under the \s-1GNU\s0 General Public License <http://www.gnu.org/licenses/gpl.html>.
76 .SH "AUTHOR"
77 .IX Header "AUTHOR"
78 Pidl was written by Jelmer Vernooij.