Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball.

1 files changed, 166 insertions, 0 deletions

diff --git a/man/mysql_client_test.1 b/man/mysql_client_test.1
new file mode 100644
index 00000000000..ce125cb22eb
--- /dev/null
+++ b/man/mysql_client_test.1
@@ -0,0 +1,166 @@
+.\"     Title: \fBmysql_client_test\fR
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\"      Date: 03/27/2009
+.\"    Manual: MySQL Database System
+.\"    Source: MySQL
+.\"
+.TH "\fBMYSQL_CLIENT_TEST" "1" "03/27/2009" "MySQL" "MySQL Database System"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+mysql_client_test \- test client API
+.br
+mysql_client_test_embedded \- test client API for embedded server
+.SH "SYNOPSIS"
+.HP 44
+\fBmysql_client_test [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] ...\fR
+.HP 53
+\fBmysql_client_test_embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] ...\fR
+.SH "DESCRIPTION"
+.PP
+The
+\fBmysql_client_test\fR
+program is used for testing aspects of the MySQL client API that cannot be tested using
+\fBmysqltest\fR
+and its test language.
+\fBmysql_client_test_embedded\fR
+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
+\fItest/mysql_client_test.c\fR
+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
+supports the following options:
+.TP 3n
+\(bu
+\fB\-\-help\fR,
+\fB\-?\fR
+.sp
+Display a help message and exit.
+.TP 3n
+\(bu
+\fB\-b \fR\fB\fIdir_name\fR\fR,
+\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR
+.sp
+The base directory for the tests.
+.TP 3n
+\(bu
+\fB\-t \fR\fB\fIcount\fR\fR,
+\fB\-\-count=\fR\fB\fIcount\fR\fR
+.sp
+The number of times to execute the tests.
+.TP 3n
+\(bu
+\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
+\fB\-D \fR\fB\fIdb_name\fR\fR
+.sp
+The database to use.
+.TP 3n
+\(bu
+\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
+\fB\-#[\fR\fB\fIdebug_options\fR\fR\fB]\fR
+.sp
+Write a debugging log if MySQL is built with debugging support. The default
+\fIdebug_options\fR
+value is
+\'d:t:o,/tmp/mysql_client_test.trace'.
+.TP 3n
+\(bu
+\fB\-g \fR\fB\fIoption\fR\fR,
+\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR
+.sp
+Option to use for testing bugs in the
+getopt
+library.
+.TP 3n
+\(bu
+\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
+\fB\-h \fR\fB\fIhost_name\fR\fR
+.sp
+Connect to the MySQL server on the given host.
+.TP 3n
+\(bu
+\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
+\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
+.sp
+The password to use when connecting to the server. If you use the short option form (\fB\-p\fR), you
+\fIcannot\fR
+have a space between the option and the password. If you omit the
+\fIpassword\fR
+value following the
+\fB\-\-password\fR
+or
+\fB\-p\fR
+option on the command line, you are prompted for one.
+.TP 3n
+\(bu
+\fB\-\-port=\fR\fB\fIport_num\fR\fR,
+\fB\-P \fR\fB\fIport_num\fR\fR
+.sp
+The TCP/IP port number to use for the connection.
+.TP 3n
+\(bu
+\fB\-A \fR\fB\fIarg\fR\fR,
+\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR
+.sp
+Argument to send to the embedded server.
+.TP 3n
+\(bu
+\fB\-T\fR,
+\fB\-\-show\-tests\fR
+.sp
+Show all test names.
+.TP 3n
+\(bu
+\fB\-\-silent\fR,
+\fB\-s\fR
+.sp
+Be more silent.
+.TP 3n
+\(bu
+\fB\-\-socket=\fR\fB\fIpath\fR\fR,
+\fB\-S \fR\fB\fIpath\fR\fR
+.sp
+The socket file to use when connecting to
+localhost
+(which is the default host).
+.TP 3n
+\(bu
+\fB\-c\fR,
+\fB\-\-testcase\fR
+.sp
+The option may disable some code when run as a
+\fBmysql\-test\-run.pl\fR
+test case.
+.TP 3n
+\(bu
+\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
+\fB\-u \fR\fB\fIuser_name\fR\fR
+.sp
+The MySQL user name to use when connecting to the server.
+.TP 3n
+\(bu
+\fB\-v \fR\fB\fIdir_name\fR\fR,
+\fB\-\-vardir=\fR\fB\fIdir_name\fR\fR
+.sp
+The data directory for tests. The default is
+\fImysql\-test/var\fR.
+.SH "COPYRIGHT"
+.PP
+Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc.
+.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
+This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+.PP
+You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/.
+.SH "SEE ALSO"
+For more information, please refer to the MySQL Reference Manual,
+which may already be installed locally and which is also available
+online at http://dev.mysql.com/doc/.
+.SH AUTHOR
+MySQL AB (http://www.mysql.com/).