List:Internals« Previous MessageNext Message »
From:paul Date:August 10 2005 5:42pm
Subject:bk commit - mysqldoc@docsrva tree (paul:1.3229)
View as plain text  
Below is the list of changes that have just been committed into a local
mysqldoc repository of paul. When paul does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html

ChangeSet
  1.3229 05/08/10 10:42:45 paul@stripped +4 -0
  manpage markup

  refman/mysql-apis.xml
    1.29 05/08/10 10:42:41 paul@stripped +130 -124
    manpage markup

  refman-5.1/mysql-apis.xml
    1.8 05/08/10 10:42:41 paul@stripped +130 -124
    Sync.

  refman-5.0/mysql-apis.xml
    1.8 05/08/10 10:42:41 paul@stripped +130 -124
    Sync.

  refman-4.1/mysql-apis.xml
    1.25 05/08/10 10:42:41 paul@stripped +130 -124
    Sync.

# This is a BitKeeper patch.  What follows are the unified diffs for the
# set of deltas contained in the patch.  The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User:	paul
# Host:	frost.snake.net
# Root:	/Volumes/frost2/MySQL/bk/mysqldoc

--- 1.7/refman-5.1/mysql-apis.xml	2005-08-10 10:11:56 -05:00
+++ 1.8/refman-5.1/mysql-apis.xml	2005-08-10 10:42:41 -05:00
@@ -99,8 +99,8 @@
 
         <refmeta>
           <refentrytitle>msql2mysql</refentrytitle>
-          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -169,8 +169,8 @@
 
         <refmeta>
           <refentrytitle>mysql_config</refentrytitle>
-          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -184,116 +184,120 @@
           </cmdsynopsis>
         </refsynopsisdiv>
 
-        <para>
-          <command>mysql_config</command> provides you with useful
-          information for compiling your MySQL client and connecting it
-          to MySQL.
-        </para>
-
-        <para>
-          <command>mysql_config</command> supports the following
-          options:
-        </para>
-
-        <itemizedlist>
-
-          <listitem>
-            <para>
-              <option>--cflags</option>
-            </para>
-
-            <para>
-              Compiler flags to find include files and critical compiler
-              flags and defines used when compiling the
-              <literal>libmysqlclient</literal> library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--include</option>
-            </para>
-
-            <para>
-              Compiler options to find MySQL include files. (Note that
-              normally you would use <option>--cflags</option> instead
-              of this option.)
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libmysqld-libs</option>,
-              <option>---embedded</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              embedded server.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs_r</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the
-              thread-safe MySQL client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--port</option>
-            </para>
-
-            <para>
-              The default TCP/IP port number, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--socket</option>
-            </para>
-
-            <para>
-              The default Unix socket file, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--version</option>
-            </para>
-
-            <para>
-              Version number and version for the MySQL distribution.
-            </para>
-          </listitem>
-
-        </itemizedlist>
-
-        <para>
-          If you invoke <command>mysql_config</command> with no options,
-          it displays a list of all options that it supports, and their
-          values:
-        </para>
+        <refsection id="mysql-config-description">
+
+          <title>Description</title>
+
+          <para>
+            <command>mysql_config</command> provides you with useful
+            information for compiling your MySQL client and connecting
+            it to MySQL.
+          </para>
+
+          <para>
+            <command>mysql_config</command> supports the following
+            options:
+          </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <option>--cflags</option>
+              </para>
+
+              <para>
+                Compiler flags to find include files and critical
+                compiler flags and defines used when compiling the
+                <literal>libmysqlclient</literal> library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--include</option>
+              </para>
+
+              <para>
+                Compiler options to find MySQL include files. (Note that
+                normally you would use <option>--cflags</option> instead
+                of this option.)
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libmysqld-libs</option>,
+                <option>---embedded</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                embedded server.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs_r</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the
+                thread-safe MySQL client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--port</option>
+              </para>
+
+              <para>
+                The default TCP/IP port number, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--socket</option>
+              </para>
+
+              <para>
+                The default Unix socket file, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--version</option>
+              </para>
+
+              <para>
+                Version number and version for the MySQL distribution.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            If you invoke <command>mysql_config</command> with no
+            options, it displays a list of all options that it supports,
+            and their values:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>mysql_config</userinput>
@@ -312,24 +316,26 @@
                     -lcrypt -lnsl -lm -lpthread -lrt]
 </programlisting>
 
-        <para>
-          You can use <command>mysql_config</command> within a command
-          line to include the value that it displays for a particular
-          option. For example, to compile a MySQL client program, use
-          <command>mysql_config</command> as follows:
-        </para>
+          <para>
+            You can use <command>mysql_config</command> within a command
+            line to include the value that it displays for a particular
+            option. For example, to compile a MySQL client program, use
+            <command>mysql_config</command> as follows:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>CFG=/usr/local/mysql/bin/mysql_config</userinput>
 shell&gt; <userinput>sh -c "gcc -o progname `$CFG --cflags` progname.c `$CFG
--libs`"</userinput>
 </programlisting>
 
-        <para>
-          When you use <command>mysql_config</command> this way, be sure
-          to invoke it within backtick ('<literal>`</literal>')
-          characters. That tells the shell to execute it and substitute
-          its output into the surrounding command.
-        </para>
+          <para>
+            When you use <command>mysql_config</command> this way, be
+            sure to invoke it within backtick ('<literal>`</literal>')
+            characters. That tells the shell to execute it and
+            substitute its output into the surrounding command.
+          </para>
+
+        </refsection>
 
       </refentry>
 

--- 1.24/refman-4.1/mysql-apis.xml	2005-08-10 10:11:55 -05:00
+++ 1.25/refman-4.1/mysql-apis.xml	2005-08-10 10:42:41 -05:00
@@ -99,8 +99,8 @@
 
         <refmeta>
           <refentrytitle>msql2mysql</refentrytitle>
-          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -169,8 +169,8 @@
 
         <refmeta>
           <refentrytitle>mysql_config</refentrytitle>
-          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -184,116 +184,120 @@
           </cmdsynopsis>
         </refsynopsisdiv>
 
-        <para>
-          <command>mysql_config</command> provides you with useful
-          information for compiling your MySQL client and connecting it
-          to MySQL.
-        </para>
-
-        <para>
-          <command>mysql_config</command> supports the following
-          options:
-        </para>
-
-        <itemizedlist>
-
-          <listitem>
-            <para>
-              <option>--cflags</option>
-            </para>
-
-            <para>
-              Compiler flags to find include files and critical compiler
-              flags and defines used when compiling the
-              <literal>libmysqlclient</literal> library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--include</option>
-            </para>
-
-            <para>
-              Compiler options to find MySQL include files. (Note that
-              normally you would use <option>--cflags</option> instead
-              of this option.)
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libmysqld-libs</option>,
-              <option>---embedded</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              embedded server.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs_r</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the
-              thread-safe MySQL client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--port</option>
-            </para>
-
-            <para>
-              The default TCP/IP port number, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--socket</option>
-            </para>
-
-            <para>
-              The default Unix socket file, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--version</option>
-            </para>
-
-            <para>
-              Version number and version for the MySQL distribution.
-            </para>
-          </listitem>
-
-        </itemizedlist>
-
-        <para>
-          If you invoke <command>mysql_config</command> with no options,
-          it displays a list of all options that it supports, and their
-          values:
-        </para>
+        <refsection id="mysql-config-description">
+
+          <title>Description</title>
+
+          <para>
+            <command>mysql_config</command> provides you with useful
+            information for compiling your MySQL client and connecting
+            it to MySQL.
+          </para>
+
+          <para>
+            <command>mysql_config</command> supports the following
+            options:
+          </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <option>--cflags</option>
+              </para>
+
+              <para>
+                Compiler flags to find include files and critical
+                compiler flags and defines used when compiling the
+                <literal>libmysqlclient</literal> library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--include</option>
+              </para>
+
+              <para>
+                Compiler options to find MySQL include files. (Note that
+                normally you would use <option>--cflags</option> instead
+                of this option.)
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libmysqld-libs</option>,
+                <option>---embedded</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                embedded server.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs_r</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the
+                thread-safe MySQL client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--port</option>
+              </para>
+
+              <para>
+                The default TCP/IP port number, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--socket</option>
+              </para>
+
+              <para>
+                The default Unix socket file, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--version</option>
+              </para>
+
+              <para>
+                Version number and version for the MySQL distribution.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            If you invoke <command>mysql_config</command> with no
+            options, it displays a list of all options that it supports,
+            and their values:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>mysql_config</userinput>
@@ -312,24 +316,26 @@
                     -lcrypt -lnsl -lm -lpthread -lrt]
 </programlisting>
 
-        <para>
-          You can use <command>mysql_config</command> within a command
-          line to include the value that it displays for a particular
-          option. For example, to compile a MySQL client program, use
-          <command>mysql_config</command> as follows:
-        </para>
+          <para>
+            You can use <command>mysql_config</command> within a command
+            line to include the value that it displays for a particular
+            option. For example, to compile a MySQL client program, use
+            <command>mysql_config</command> as follows:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>CFG=/usr/local/mysql/bin/mysql_config</userinput>
 shell&gt; <userinput>sh -c "gcc -o progname `$CFG --cflags` progname.c `$CFG
--libs`"</userinput>
 </programlisting>
 
-        <para>
-          When you use <command>mysql_config</command> this way, be sure
-          to invoke it within backtick ('<literal>`</literal>')
-          characters. That tells the shell to execute it and substitute
-          its output into the surrounding command.
-        </para>
+          <para>
+            When you use <command>mysql_config</command> this way, be
+            sure to invoke it within backtick ('<literal>`</literal>')
+            characters. That tells the shell to execute it and
+            substitute its output into the surrounding command.
+          </para>
+
+        </refsection>
 
       </refentry>
 

--- 1.28/refman/mysql-apis.xml	2005-08-10 10:11:57 -05:00
+++ 1.29/refman/mysql-apis.xml	2005-08-10 10:42:41 -05:00
@@ -99,8 +99,8 @@
 
         <refmeta>
           <refentrytitle>msql2mysql</refentrytitle>
-          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -169,8 +169,8 @@
 
         <refmeta>
           <refentrytitle>mysql_config</refentrytitle>
-          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -184,116 +184,120 @@
           </cmdsynopsis>
         </refsynopsisdiv>
 
-        <para>
-          <command>mysql_config</command> provides you with useful
-          information for compiling your MySQL client and connecting it
-          to MySQL.
-        </para>
-
-        <para>
-          <command>mysql_config</command> supports the following
-          options:
-        </para>
-
-        <itemizedlist>
-
-          <listitem>
-            <para>
-              <option>--cflags</option>
-            </para>
-
-            <para>
-              Compiler flags to find include files and critical compiler
-              flags and defines used when compiling the
-              <literal>libmysqlclient</literal> library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--include</option>
-            </para>
-
-            <para>
-              Compiler options to find MySQL include files. (Note that
-              normally you would use <option>--cflags</option> instead
-              of this option.)
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libmysqld-libs</option>,
-              <option>---embedded</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              embedded server.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs_r</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the
-              thread-safe MySQL client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--port</option>
-            </para>
-
-            <para>
-              The default TCP/IP port number, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--socket</option>
-            </para>
-
-            <para>
-              The default Unix socket file, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--version</option>
-            </para>
-
-            <para>
-              Version number and version for the MySQL distribution.
-            </para>
-          </listitem>
-
-        </itemizedlist>
-
-        <para>
-          If you invoke <command>mysql_config</command> with no options,
-          it displays a list of all options that it supports, and their
-          values:
-        </para>
+        <refsection id="mysql-config-description">
+
+          <title>Description</title>
+
+          <para>
+            <command>mysql_config</command> provides you with useful
+            information for compiling your MySQL client and connecting
+            it to MySQL.
+          </para>
+
+          <para>
+            <command>mysql_config</command> supports the following
+            options:
+          </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <option>--cflags</option>
+              </para>
+
+              <para>
+                Compiler flags to find include files and critical
+                compiler flags and defines used when compiling the
+                <literal>libmysqlclient</literal> library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--include</option>
+              </para>
+
+              <para>
+                Compiler options to find MySQL include files. (Note that
+                normally you would use <option>--cflags</option> instead
+                of this option.)
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libmysqld-libs</option>,
+                <option>---embedded</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                embedded server.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs_r</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the
+                thread-safe MySQL client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--port</option>
+              </para>
+
+              <para>
+                The default TCP/IP port number, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--socket</option>
+              </para>
+
+              <para>
+                The default Unix socket file, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--version</option>
+              </para>
+
+              <para>
+                Version number and version for the MySQL distribution.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            If you invoke <command>mysql_config</command> with no
+            options, it displays a list of all options that it supports,
+            and their values:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>mysql_config</userinput>
@@ -312,24 +316,26 @@
                     -lcrypt -lnsl -lm -lpthread -lrt]
 </programlisting>
 
-        <para>
-          You can use <command>mysql_config</command> within a command
-          line to include the value that it displays for a particular
-          option. For example, to compile a MySQL client program, use
-          <command>mysql_config</command> as follows:
-        </para>
+          <para>
+            You can use <command>mysql_config</command> within a command
+            line to include the value that it displays for a particular
+            option. For example, to compile a MySQL client program, use
+            <command>mysql_config</command> as follows:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>CFG=/usr/local/mysql/bin/mysql_config</userinput>
 shell&gt; <userinput>sh -c "gcc -o progname `$CFG --cflags` progname.c `$CFG
--libs`"</userinput>
 </programlisting>
 
-        <para>
-          When you use <command>mysql_config</command> this way, be sure
-          to invoke it within backtick ('<literal>`</literal>')
-          characters. That tells the shell to execute it and substitute
-          its output into the surrounding command.
-        </para>
+          <para>
+            When you use <command>mysql_config</command> this way, be
+            sure to invoke it within backtick ('<literal>`</literal>')
+            characters. That tells the shell to execute it and
+            substitute its output into the surrounding command.
+          </para>
+
+        </refsection>
 
       </refentry>
 

--- 1.7/refman-5.0/mysql-apis.xml	2005-08-10 10:11:55 -05:00
+++ 1.8/refman-5.0/mysql-apis.xml	2005-08-10 10:42:41 -05:00
@@ -99,8 +99,8 @@
 
         <refmeta>
           <refentrytitle>msql2mysql</refentrytitle>
-          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Convert mSQL Programs for Use with MySQL</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -169,8 +169,8 @@
 
         <refmeta>
           <refentrytitle>mysql_config</refentrytitle>
-          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
           <manvolnum>man</manvolnum>
+          <refmiscinfo>Get Compile Options for Compiling
Clients</refmiscinfo>
         </refmeta>
 
         <refnamediv>
@@ -184,116 +184,120 @@
           </cmdsynopsis>
         </refsynopsisdiv>
 
-        <para>
-          <command>mysql_config</command> provides you with useful
-          information for compiling your MySQL client and connecting it
-          to MySQL.
-        </para>
-
-        <para>
-          <command>mysql_config</command> supports the following
-          options:
-        </para>
-
-        <itemizedlist>
-
-          <listitem>
-            <para>
-              <option>--cflags</option>
-            </para>
-
-            <para>
-              Compiler flags to find include files and critical compiler
-              flags and defines used when compiling the
-              <literal>libmysqlclient</literal> library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--include</option>
-            </para>
-
-            <para>
-              Compiler options to find MySQL include files. (Note that
-              normally you would use <option>--cflags</option> instead
-              of this option.)
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libmysqld-libs</option>,
-              <option>---embedded</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              embedded server.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the MySQL
-              client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--libs_r</option>
-            </para>
-
-            <para>
-              Libraries and options required to link with the
-              thread-safe MySQL client library.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--port</option>
-            </para>
-
-            <para>
-              The default TCP/IP port number, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--socket</option>
-            </para>
-
-            <para>
-              The default Unix socket file, defined when configuring
-              MySQL.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
-              <option>--version</option>
-            </para>
-
-            <para>
-              Version number and version for the MySQL distribution.
-            </para>
-          </listitem>
-
-        </itemizedlist>
-
-        <para>
-          If you invoke <command>mysql_config</command> with no options,
-          it displays a list of all options that it supports, and their
-          values:
-        </para>
+        <refsection id="mysql-config-description">
+
+          <title>Description</title>
+
+          <para>
+            <command>mysql_config</command> provides you with useful
+            information for compiling your MySQL client and connecting
+            it to MySQL.
+          </para>
+
+          <para>
+            <command>mysql_config</command> supports the following
+            options:
+          </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <option>--cflags</option>
+              </para>
+
+              <para>
+                Compiler flags to find include files and critical
+                compiler flags and defines used when compiling the
+                <literal>libmysqlclient</literal> library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--include</option>
+              </para>
+
+              <para>
+                Compiler options to find MySQL include files. (Note that
+                normally you would use <option>--cflags</option> instead
+                of this option.)
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libmysqld-libs</option>,
+                <option>---embedded</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                embedded server.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the MySQL
+                client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--libs_r</option>
+              </para>
+
+              <para>
+                Libraries and options required to link with the
+                thread-safe MySQL client library.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--port</option>
+              </para>
+
+              <para>
+                The default TCP/IP port number, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--socket</option>
+              </para>
+
+              <para>
+                The default Unix socket file, defined when configuring
+                MySQL.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <option>--version</option>
+              </para>
+
+              <para>
+                Version number and version for the MySQL distribution.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            If you invoke <command>mysql_config</command> with no
+            options, it displays a list of all options that it supports,
+            and their values:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>mysql_config</userinput>
@@ -312,24 +316,26 @@
                     -lcrypt -lnsl -lm -lpthread -lrt]
 </programlisting>
 
-        <para>
-          You can use <command>mysql_config</command> within a command
-          line to include the value that it displays for a particular
-          option. For example, to compile a MySQL client program, use
-          <command>mysql_config</command> as follows:
-        </para>
+          <para>
+            You can use <command>mysql_config</command> within a command
+            line to include the value that it displays for a particular
+            option. For example, to compile a MySQL client program, use
+            <command>mysql_config</command> as follows:
+          </para>
 
 <programlisting>
 shell&gt; <userinput>CFG=/usr/local/mysql/bin/mysql_config</userinput>
 shell&gt; <userinput>sh -c "gcc -o progname `$CFG --cflags` progname.c `$CFG
--libs`"</userinput>
 </programlisting>
 
-        <para>
-          When you use <command>mysql_config</command> this way, be sure
-          to invoke it within backtick ('<literal>`</literal>')
-          characters. That tells the shell to execute it and substitute
-          its output into the surrounding command.
-        </para>
+          <para>
+            When you use <command>mysql_config</command> this way, be
+            sure to invoke it within backtick ('<literal>`</literal>')
+            characters. That tells the shell to execute it and
+            substitute its output into the surrounding command.
+          </para>
+
+        </refsection>
 
       </refentry>
 
Thread
bk commit - mysqldoc@docsrva tree (paul:1.3229)paul10 Aug