diff options
author | Jelmer Vernooij <jelmer@samba.org> | 2012-03-02 03:30:51 +0100 |
---|---|---|
committer | Jelmer Vernooij <jelmer@samba.org> | 2012-03-02 03:49:09 +0100 |
commit | fd7ba79abac41eee221c6e24c2a762e651a41d65 (patch) | |
tree | df9cdf9e8a136dedfb757204064623ec656255ba /selftest | |
parent | 10700f69b2ec552939471fb43f0913511860af6f (diff) | |
download | samba-fd7ba79abac41eee221c6e24c2a762e651a41d65.tar.gz samba-fd7ba79abac41eee221c6e24c2a762e651a41d65.tar.bz2 samba-fd7ba79abac41eee221c6e24c2a762e651a41d65.zip |
selftest: Move manual page into a separate file.
(Generated using pod2man from selftest.pl itself)
Diffstat (limited to 'selftest')
-rwxr-xr-x | selftest/selftest.pl | 101 | ||||
-rw-r--r-- | selftest/selftest.pl.1 | 78 |
2 files changed, 78 insertions, 101 deletions
diff --git a/selftest/selftest.pl b/selftest/selftest.pl index 72e9ddf020..a6d4e14095 100755 --- a/selftest/selftest.pl +++ b/selftest/selftest.pl @@ -16,107 +16,6 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. -=pod - -=head1 NAME - -selftest - Samba test runner - -=head1 SYNOPSIS - -selftest --help - -selftest [--srcdir=DIR] [--bindir=DIR] [--target=samba|samba3|win] [--socket-wrapper] [--quick] [--exclude=FILE] [--include=FILE] [--one] [--prefix=prefix] [--testlist=FILE] [TESTS] - -=head1 DESCRIPTION - -A simple test runner. TESTS is a regular expression with tests to run. - -=head1 OPTIONS - -=over 4 - -=item I<--help> - -Show list of available options. - -=item I<--srcdir=DIR> - -Source directory. - -=item I<--bindir=DIR> - -Built binaries directory. - -=item I<--prefix=DIR> - -Change directory to run tests in. Default is 'st'. - -=item I<--target samba|samba3|win> - -Specify test target against which to run. Default is 'samba4'. - -=item I<--quick> - -Run only a limited number of tests. Intended to run in about 30 seconds on -moderately recent systems. - -=item I<--socket-wrapper> - -Use socket wrapper library for communication with server. Only works -when the server is running locally. - -Will prevent TCP and UDP ports being opened on the local host but -(transparently) redirects these calls to use unix domain sockets. - -=item I<--exclude> - -Specify a file containing a list of tests that should be skipped. Possible -candidates are tests that segfault the server, flip or don't end. - -=item I<--include> - -Specify a file containing a list of tests that should be run. Same format -as the --exclude flag. - -Not includes specified means all tests will be run. - -=item I<--one> - -Abort as soon as one test fails. - -=item I<--testlist> - -Load a list of tests from the specified location. - -=back - -=head1 ENVIRONMENT - -=over 4 - -=item I<SMBD_VALGRIND> - -=item I<TORTURE_MAXTIME> - -=item I<VALGRIND> - -=item I<TLS_ENABLED> - -=item I<srcdir> - -=back - -=head1 LICENSE - -selftest is licensed under the GNU General Public License L<http://www.gnu.org/licenses/gpl.html>. - -=head1 AUTHOR - -Jelmer Vernooij - -=cut - use strict; use FindBin qw($RealBin $Script); diff --git a/selftest/selftest.pl.1 b/selftest/selftest.pl.1 new file mode 100644 index 0000000000..f33b81044e --- /dev/null +++ b/selftest/selftest.pl.1 @@ -0,0 +1,78 @@ +.IX Title "SELFTEST 1" +.TH SELFTEST 1 "2012-02-24" "selftest" "Samba" +.if n .ad l +.nh +.SH "NAME" +selftest \- Samba test runner +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +selftest \-\-help +.PP +selftest [\-\-srcdir=DIR] [\-\-bindir=DIR] [\-\-target=samba|samba3|win] [\-\-socket\-wrapper] [\-\-quick] [\-\-exclude=FILE] [\-\-include=FILE] [\-\-one] [\-\-prefix=prefix] [\-\-testlist=FILE] [\s-1TESTS\s0] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +A simple test runner. \s-1TESTS\s0 is a regular expression with tests to run. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fI\-\-help\fR" 4 +.IX Item "--help" +Show list of available options. +.IP "\fI\-\-srcdir=DIR\fR" 4 +.IX Item "--srcdir=DIR" +Source directory. +.IP "\fI\-\-bindir=DIR\fR" 4 +.IX Item "--bindir=DIR" +Built binaries directory. +.IP "\fI\-\-prefix=DIR\fR" 4 +.IX Item "--prefix=DIR" +Change directory to run tests in. Default is 'st'. +.IP "\fI\-\-target samba|samba3|win\fR" 4 +.IX Item "--target samba|samba3|win" +Specify test target against which to run. Default is 'samba4'. +.IP "\fI\-\-quick\fR" 4 +.IX Item "--quick" +Run only a limited number of tests. Intended to run in about 30 seconds on +moderately recent systems. +.IP "\fI\-\-socket\-wrapper\fR" 4 +.IX Item "--socket-wrapper" +Use socket wrapper library for communication with server. Only works +when the server is running locally. +.Sp +Will prevent \s-1TCP\s0 and \s-1UDP\s0 ports being opened on the local host but +(transparently) redirects these calls to use unix domain sockets. +.IP "\fI\-\-exclude\fR" 4 +.IX Item "--exclude" +Specify a file containing a list of tests that should be skipped. Possible +candidates are tests that segfault the server, flip or don't end. +.IP "\fI\-\-include\fR" 4 +.IX Item "--include" +Specify a file containing a list of tests that should be run. Same format +as the \-\-exclude flag. +.Sp +Not includes specified means all tests will be run. +.IP "\fI\-\-one\fR" 4 +.IX Item "--one" +Abort as soon as one test fails. +.IP "\fI\-\-testlist\fR" 4 +.IX Item "--testlist" +Load a list of tests from the specified location. +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +.IP "\fI\s-1SMBD_VALGRIND\s0\fR" 4 +.IX Item "SMBD_VALGRIND" +.PD 0 +.IP "\fI\s-1TORTURE_MAXTIME\s0\fR" 4 +.IX Item "TORTURE_MAXTIME" +.IP "\fI\s-1VALGRIND\s0\fR" 4 +.IX Item "VALGRIND" +.IP "\fI\s-1TLS_ENABLED\s0\fR" 4 +.IX Item "TLS_ENABLED" +.IP "\fIsrcdir\fR" 4 +.IX Item "srcdir" +.PD +.SH "LICENSE" +.IX Header "LICENSE" +selftest is licensed under the \s-1GNU\s0 General Public License <http://www.gnu.org/licenses/gpl.html>. +.SH "AUTHOR" +.IX Header "AUTHOR" +Pidl was written by Jelmer Vernooij. |