summaryrefslogtreecommitdiff
path: root/man/mysql_client_test.1
diff options
context:
space:
mode:
authorunknown <knielsen@knielsen-hq.org>2010-04-28 15:06:11 +0200
committerunknown <knielsen@knielsen-hq.org>2010-04-28 15:06:11 +0200
commitf7f922774451a1c0017122f11ed9f08734b61e4b (patch)
tree89b471ab671572efad273241330a33d95a3d050f /man/mysql_client_test.1
parent4b69d0ee5245b26a3bd7bd5dfd3bd066cd38ea4c (diff)
downloadmariadb-git-f7f922774451a1c0017122f11ed9f08734b61e4b.tar.gz
Imported MySQL documentation files from ../mysql-5.1.46
Diffstat (limited to 'man/mysql_client_test.1')
-rw-r--r--man/mysql_client_test.144
1 files changed, 25 insertions, 19 deletions
diff --git a/man/mysql_client_test.1 b/man/mysql_client_test.1
index 3116a0aa037..836670b7d8e 100644
--- a/man/mysql_client_test.1
+++ b/man/mysql_client_test.1
@@ -2,12 +2,12 @@
.\" Title: \fBmysql_client_test\fR
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 10/29/2009
+.\" Date: 03/31/2010
.\" Manual: MySQL Database System
.\" Source: MySQL
.\" Language: English
.\"
-.TH "\FBMYSQL_CLIENT_TEST" "1" "10/29/2009" "MySQL" "MySQL Database System"
+.TH "\FBMYSQL_CLIENT_TEST" "1" "03/31/2010" "MySQL" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -40,10 +40,15 @@ and its test language\&.
is similar but used for testing the embedded server\&. Both programs are run as part of the test suite\&.
.PP
The source code for the programs can be found in in
-test/mysql_client_test\&.c
+tests/mysql_client_test\&.c
in a source distribution\&. The program serves as a good source of examples illustrating how to use various features of the client API\&.
.PP
\fBmysql_client_test\fR
+is used in a test by the same name in the main tests suite of
+\fBmysql\-test\-run\&.pl\fR
+but may also be run directly\&. Unlike the other programs listed here, it does not read an external description of what tests to run\&. Instead, all tests are coded into the program, which is written to cover all aspects of the C language API\&.
+.PP
+\fBmysql_client_test\fR
supports the following options:
.sp
.RS 4
@@ -70,10 +75,10 @@ Display a help message and exit\&.
.sp -1
.IP \(bu 2.3
.\}
-\fB\-b \fR\fB\fIdir_name\fR\fR,
+\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR,
.\" mysql_client_test: basedir option
.\" basedir option: mysql_client_test
-\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR
+\fB\-b \fR\fB\fIdir_name\fR\fR
.sp
The base directory for the tests\&.
.RE
@@ -86,10 +91,10 @@ The base directory for the tests\&.
.sp -1
.IP \(bu 2.3
.\}
-\fB\-t \fR\fB\fIcount\fR\fR,
+\fB\-\-count=\fR\fB\fIcount\fR\fR,
.\" mysql_client_test: count option
.\" count option: mysql_client_test
-\fB\-\-count=\fR\fB\fIcount\fR\fR
+\fB\-t \fR\fB\fIcount\fR\fR
.sp
The number of times to execute the tests\&.
.RE
@@ -137,10 +142,10 @@ value is
.sp -1
.IP \(bu 2.3
.\}
-\fB\-g \fR\fB\fIoption\fR\fR,
+\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR,
.\" mysql_client_test: getopt-ll-test option
.\" getopt-ll-test option: mysql_client_test
-\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR
+\fB\-g \fR\fB\fIoption\fR\fR
.sp
Option to use for testing bugs in the
getopt
@@ -213,10 +218,10 @@ The TCP/IP port number to use for the connection\&.
.sp -1
.IP \(bu 2.3
.\}
-\fB\-A \fR\fB\fIarg\fR\fR,
+\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR,
.\" mysql_client_test: server-arg option
.\" server-arg option: mysql_client_test
-\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR
+\fB\-A \fR\fB\fIarg\fR\fR
.sp
Argument to send to the embedded server\&.
.RE
@@ -229,8 +234,8 @@ Argument to send to the embedded server\&.
.sp -1
.IP \(bu 2.3
.\}
-\fB\-T\fR,
-\fB\-\-show\-tests\fR
+\fB\-\-show\-tests\fR,
+\fB\-T\fR
.sp
Show all test names\&.
.RE
@@ -277,12 +282,13 @@ localhost
.sp -1
.IP \(bu 2.3
.\}
-\fB\-c\fR,
-\fB\-\-testcase\fR
+\fB\-\-testcase\fR,
+\fB\-c\fR
.sp
-The option may disable some code when run as a
-\fBmysql\-test\-run\&.pl\fR
-test case\&.
+The option is used when called from
+\fBmysql\-test\-run\&.pl\fR, so that
+\fBmysql_client_test\fR
+may optionally behave in a different way than if called manually, for example by skipping some tests\&. Currently, there is no difference in behavior but the option is included in order to make this possible\&.
.RE
.sp
.RS 4
@@ -320,7 +326,7 @@ mysql\-test/var\&.
.SH "COPYRIGHT"
.br
.PP
-Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
+Copyright \(co 2007, 2010, Oracle and/or its affiliates. All rights reserved.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP