Author: paul
Date: 2005-12-07 03:07:23 +0100 (Wed, 07 Dec 2005)
New Revision: 508
Log:
r4559@frost: paul | 2005-12-06 20:06:30 -0600
Start documenting mysqltest.
Added:
trunk/internals/mysqltest.xml
Modified:
trunk/
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:4558
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1505
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:4559
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1505
Added: trunk/internals/mysqltest.xml
===================================================================
--- trunk/internals/mysqltest.xml 2005-12-07 02:06:43 UTC (rev 507)
+++ trunk/internals/mysqltest.xml 2005-12-07 02:07:23 UTC (rev 508)
@@ -0,0 +1,843 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "fixedchars.ent">
+ %fixedchars.entities;
+<!ENTITY current-series "MySQL 5.1">
+<!ENTITY title-mysqltest-for-manpage "MySQL test program">
+<!ENTITY title-mysqltest-for-manual "MySQL Test Program">
+]>
+<section id="fake-id-for-mysqltest-manpage-section-wrapper">
+
+ <title>fake title for mysqltest manpage section wrapper</title>
+
+ <refentry id="mysqltest">
+
+ <indexterm>
+ <primary><command>mysqltest</command></primary>
+ </indexterm>
+
+ <refmeta>
+ <refentrytitle>mysqltest</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">&title-mysqltest-for-manual;</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>mysqltest</refname>
+ <refpurpose>&title-mysqltest-for-manpage;</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>mysqltest [<replaceable>options</replaceable>] [<replaceable>db_name</replaceable>]</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection id="mysqltest-description">
+
+ <title>Description</title>
+
+ <para>
+ <command>mysqltest</command> runs a test case against a MySQL
+ server and compares the output with a result file.
+ </para>
+
+ <para>
+ Invoke <command>mysqltest</command> like this:
+ </para>
+
+<programlisting>
+shell> <userinput>mysqltest [<replaceable>options</replaceable>] [<replaceable>db_name</replaceable>] < <replaceable>test_file</replaceable></userinput>
+</programlisting>
+
+ </refsection>
+
+ <refsection id="mysqltest-options">
+
+ <title>Options</title>
+
+ <remark role="note">
+ Also supports the standard SSL options. (And what else?)
+ </remark>
+
+ <para>
+ Note: These need to be put in proper lexical order in
+ <filename>mysqltest.c</filename>.
+ </para>
+
+ <para>
+ <command>mysqltest</command> supports the following options:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <option>--help</option>, <option>-?</option>
+ </para>
+
+ <para>
+ Display a help message and exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--basedir=<replaceable>dir_name</replaceable></option>,
+ <option>-b <replaceable>dir_name</replaceable></option>
+ </para>
+
+ <para>
+ The base directory for tests.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--big-test</option>, <option>-B</option>
+ </para>
+
+ <para>
+ Define <literal>BIG_TEST</literal> to 1.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--compress</option>, <option>-C</option>
+ </para>
+
+ <para>
+ Compress all information sent between the client and the
+ server if both support compression.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--database=<replaceable>db_name</replaceable></option>,
+ <option>-D <replaceable>db_name</replaceable></option>
+ </para>
+
+ <para>
+ The database to use.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--debug[=<replaceable>debug_options</replaceable>]</option>,
+ <option>-#
+ [<replaceable>debug_options</replaceable>]</option>
+ </para>
+
+ <para>
+ Write a debugging log. The
+ <replaceable>debug_options</replaceable> string often is
+ <literal>'d:t:o,<replaceable>file_name</replaceable>'</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--host=<replaceable>host_name</replaceable></option>,
+ <option>-h <replaceable>host_name</replaceable></option>
+ </para>
+
+ <para>
+ Connect to the MySQL server on the given host.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--manager-host=<replaceable>host_name</replaceable></option>
+ </para>
+
+ <para>
+ Undocumented: Used for debugging.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--manager-password=<replaceable>password</replaceable></option>
+ </para>
+
+ <para>
+ Undocumented: Used for debugging.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--manager-port=<replaceable>port_num</replaceable></option>
+ </para>
+
+ <para>
+ Undocumented: Used for debugging.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--manager-user=<replaceable>user_name</replaceable></option>
+ </para>
+
+ <para>
+ Undocumented: Used for debugging.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--no-defaults</option>
+ </para>
+
+ <para>
+ Don't read default options from any option files.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--password[=<replaceable>password</replaceable>]</option>,
+ <option>-p[<replaceable>password</replaceable>]</option>
+ </para>
+
+ <para>
+ The password to use when connecting to the server. If you
+ use the short option form (<option>-p</option>), you
+ <emphasis>cannot</emphasis> have a space between the option
+ and the password. If you omit the
+ <replaceable>password</replaceable> value following the
+ <option>--password</option> or <option>-p</option> option on
+ the command line, you are prompted for one.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--port=<replaceable>port_num</replaceable></option>,
+ <option>-P <replaceable>port_num</replaceable></option>
+ </para>
+
+ <para>
+ The TCP/IP port number to use for the connection.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--ps-protocol</option>
+ </para>
+
+ <para>
+ Use the prepared-statement protocol for communication.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--quiet</option>
+ </para>
+
+ <para>
+ Suppress all normal output. This is a synonym for
+ <option>--silent</option>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--record</option>, <option>-r</option>
+ </para>
+
+ <para>
+ Record the output from running the test file into the file
+ named by the <option>--result-file</option> option.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--result-file=<replaceable>file_name</replaceable></option>,
+ <option>-R <replaceable>file_name</replaceable></option>
+ </para>
+
+ <remark role="todo">
+ Determine if my interpretation of this option's meaning is
+ incorrect.
+ </remark>
+
+ <para>
+ Read results from this file. In addition, if the
+ <option>--record</option> option is given, write results to
+ this file.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--server-arg=<replaceable>value</replaceable></option>,
+ <option>-A <replaceable>value</replaceable></option>
+ </para>
+
+ <para>
+ Pass the argument as an argument to the embedded server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--server-file=<replaceable>file_name</replaceable></option>,
+ <option>-F <replaceable>file_name</replaceable></option>
+ </para>
+
+ <para>
+ Read arguments for the embedded server from the given file.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--silent</option>, <option>-s</option>
+ </para>
+
+ <para>
+ Suppress all normal output.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--skip-safemalloc</option>
+ </para>
+
+ <para>
+ Don't use memory allocation checking.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--sleep=<replaceable>num</replaceable></option>,
+ <option>-T <replaceable>num</replaceable></option>
+ </para>
+
+ <para>
+ The <literal>sleep</literal> command always sleeps
+ <replaceable>num</replaceable> seconds.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--socket=<replaceable>path</replaceable></option>,
+ <option>-S <replaceable>path</replaceable></option>
+ </para>
+
+ <para>
+ The socket file to use when connecting to
+ <literal>localhost</literal> (which is the default host).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--test-file=<replaceable>file_name</replaceable></option>,
+ <option>-x <replaceable>file_name</replaceable></option>
+ </para>
+
+ <para>
+ Read the test from this file. The default is to read from
+ the standard input.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--timer-file=<replaceable>file_name</replaceable></option>,
+ <option>-m <replaceable>file_name</replaceable></option>
+ </para>
+
+ <para>
+ The file where the timing in microseconds is stored.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--tmpdir=<replaceable>dir_name</replaceable></option>,
+ <option>-t <replaceable>dir_name</replaceable></option>
+ </para>
+
+ <para>
+ The temporary directory where sockets are put.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--user=<replaceable>user_name</replaceable></option>,
+ <option>-u <replaceable>user_name</replaceable></option>
+ </para>
+
+ <para>
+ The MySQL username to use when connecting to the server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--verbose</option>, <option>-v</option>
+ </para>
+
+ <para>
+ Verbose mode. Print out more information what the program
+ does.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <option>--version</option>, <option>-V</option>
+ </para>
+
+ <para>
+ Display version information and exit.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </refsection>
+
+ <refsection id="mysqltest-commands">
+
+ <title>Command Language</title>
+
+ <para>
+ This section describes the test language implemented by
+ <command>mysqltest</command>.
+ </para>
+
+ <para>
+ Note: For now, the commands are in a single lexical list.
+ Eventually, they need to be categorized.
+ </para>
+
+ <para>
+ <command>mysqltest</command> supports the following commands:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>character_set</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>connect</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>connection</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>dec</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>delimiter</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>dirty_close</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_abort_on_error</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_info</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_metadata</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_parsing</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_ps_protocol</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_ps_warnings</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_query_log</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_reconnect</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_result_log</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_rpl_parse</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disable_warnings</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>disconnect</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>echo</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_abort_on_error</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_info</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_metadata</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_parsing</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_ps_protocol</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_ps_warnings</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_query_log</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_reconnect</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_result_log</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_rpl_parse</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enable_warnings</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>end</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>end_timer</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>error</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>eval</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>eval_result</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>exec</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>exit</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>horizontal_results</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>if</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>inc</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>let</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>ping</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>query</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>query_horizontal</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>query_vertical</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>real_sleep</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>reap</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>replace_column</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>replace_result</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>require</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>require_manager</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>result</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>rpl_probe</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>save_master_pos</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>send</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>server_start</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>server_stop</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>sleep</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>source</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>start_timer</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>sync_slave_with_master</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>sync_with_master</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>system</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>vertical_results</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>wait_for_slave_to_stop</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>while</literal>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </refsection>
+
+ </refentry>
+
+</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r508 - in trunk: . internals | paul | 7 Dec |
