| List: | Internals | « Previous MessageNext Message » | |
| From: | paul | Date: | July 16 2005 8:17pm |
| Subject: | bk commit - mysqldoc@docsrva tree (paul:1.3039) | ||
| 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.3039 05/07/16 13:17:18 paul@stripped +13 -0 Changes for manpage generation. xsl.d/dbk-prep.xsl 1.7 05/07/16 13:17:16 paul@stripped +63 -0 Preprocess differently for manpages. tools/xmlformat.conf 1.8 05/07/16 13:17:15 paul@stripped +9 -1 Add rules for manpage elements. refman/titles.ent 1.26 05/07/16 13:17:15 paul@stripped +0 -2 Remove unused entities. refman/mysql-apis.xml 1.9 05/07/16 13:17:15 paul@stripped +163 -126 Use manpage markup for msql2mysql, mysql_config. refman/Makefile 1.8 05/07/16 13:17:15 paul@stripped +7 -0 Manpage targets. refman-5.0/titles.ent 1.23 05/07/16 13:17:15 paul@stripped +0 -2 Sync. refman-5.0/mysql-apis.xml 1.9 05/07/16 13:17:15 paul@stripped +163 -126 Sync. refman-5.0/Makefile 1.4 05/07/16 13:17:15 paul@stripped +7 -0 Sync. refman-4.1/titles.ent 1.19 05/07/16 13:17:14 paul@stripped +0 -2 Sync. refman-4.1/mysql-apis.xml 1.9 05/07/16 13:17:14 paul@stripped +163 -126 Sync. refman-4.1/Makefile 1.4 05/07/16 13:17:14 paul@stripped +7 -0 Sync. make.d/xml-prep 1.4 05/07/16 13:17:14 paul@stripped +9 -2 Prep differently for manpages. make.d/xml-man 1.2 05/07/16 13:17:14 paul@stripped +1 -1 Prep differently for manpages. # 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/tools/xmlformat.conf 2005-03-28 14:08:34 -06:00 +++ 1.8/tools/xmlformat.conf 2005-07-16 13:17:15 -05:00 @@ -80,7 +80,8 @@ literal replaceable userinput command option emphasis xref link ulink email \ filename citetitle keycap \ guibutton guilabel guimenu \ -quote superscript +quote superscript \ +refpurpose refmiscinfo format inline # Begin each element on new line, indenting sub elements two spaces. @@ -92,3 +93,10 @@ element-break 1 exit-break 1 subindent 2 + +refmeta refnamediv refsynopsisdiv cmdsynopsis arg + format block + entry-break 1 + exit-break 1 + element-break 1 + normalize yes --- 1.1/make.d/xml-man 2005-07-14 00:48:05 -05:00 +++ 1.2/make.d/xml-man 2005-07-16 13:17:14 -05:00 @@ -4,7 +4,7 @@ MYSQL_MAN_XSL = $(XSL_DIR)/mysql-man.xsl MYSQL_MAN_XSL_DEPS = $(MYSQL_MAN_XSL) -%.man: %-prepped.xml $(MYSQL_MAN_XSL_DEPS) +%.man: %-manprepped.xml $(MYSQL_MAN_XSL_DEPS) $(XSLTPROC) \ --stringparam l10n.gentext.default.language `$(STEM_LANG_CODE) $*` \ --output $*.html \ --- 1.3/make.d/xml-prep 2005-07-13 11:26:18 -05:00 +++ 1.4/make.d/xml-prep 2005-07-16 13:17:14 -05:00 @@ -8,12 +8,19 @@ # for a final target. They are deleted by "make clean". .PRECIOUS: %-prepped.xml +.PRECIOUS: %-manprepped.xml # BUG_PREP fixes up "Bug #xxxx" bug references into <ulink> elements # that point to htto://bugs.mysql.com bug reports. %-prepped.xml: %.xml $(DBK_PREP_XSL_DEPS) $(BUG_PREP) - $(XSLTPROC) $(DBK_PREP_XSL) $< | $(BUG_PREP) > $@ + $(XSLTPROC) \ + $(DBK_PREP_XSL) $< | $(BUG_PREP) > $@ + +%-manprepped.xml: %.xml $(DBK_PREP_XSL_DEPS) $(BUG_PREP) + $(XSLTPROC) \ + --param map.refentry.to.section 0 \ + $(DBK_PREP_XSL) $< | $(BUG_PREP) > $@ clean:: - $(RM) *-prepped.xml + $(RM) *-prepped.xml *-manprepped.xml --- 1.7/refman/Makefile 2005-07-14 00:52:34 -05:00 +++ 1.8/refman/Makefile 2005-07-16 13:17:15 -05:00 @@ -203,6 +203,13 @@ $(RM) $(HTML_FRAGMENT_FILES) $(RM) manual.txt +# Manual page generation + +manpages: manual.man + +clean:: + $(RM) *.man + # Import standard variables and target rules # Need xml-html-dir for formatting the manual itself into a subdir, --- 1.6/xsl.d/dbk-prep.xsl 2005-07-06 13:41:57 -05:00 +++ 1.7/xsl.d/dbk-prep.xsl 2005-07-16 13:17:16 -05:00 @@ -39,6 +39,69 @@ <xsl:preserve-space elements="*"/> <!-- +Whether to map <refentry> (manpage) elements to <section> elements. +The default is 1 (true), which allows subsequently invoked stylesheets that +use this preprocessor not to have to know about <refentry> structure. +Set to 0 (false) for generating manpages, which need to see <refentry> +elements. +--> + +<xsl:param name="map.refentry.to.section" select="1"/> + +<!-- +Handle <refentry> by either passing it through unchanged, or mapping +it to a <section> +--> + +<xsl:template match="refentry"> + <xsl:choose> + <xsl:when test="$map.refentry.to.section = 0"> + <!-- pass refentry through unchanged --> + <refentry> + <xsl:copy-of select="@*"/> + <xsl:copy-of select="node()"/> + </refentry> + </xsl:when> + <xsl:otherwise> + <!-- map refentry to section --> + <!-- use refmeta and refnamediv elements for title --> + <section> + <xsl:copy-of select="@*"/> + <title> + <xsl:apply-templates select="refnamediv/refname/node()"/> + <!-- — --> + <xsl:text> — </xsl:text> + <xsl:apply-templates select="refmeta/refmiscinfo/node()"/> + </title> + <xsl:text>
</xsl:text> + <xsl:apply-templates select="refsection"/> + </section> + </xsl:otherwise> + </xsl:choose> + <xsl:text>
</xsl:text> +</xsl:template> + +<xsl:template match="refsection"> + <xsl:choose> + <xsl:when test="$map.refentry.to.section = 0"> + <!-- pass refsection through unchanged --> + <refentry> + <xsl:copy-of select="@*"/> + <xsl:copy-of select="node()"/> + </refentry> + </xsl:when> + <xsl:otherwise> + <!-- map refsection to section --> + <section> + <xsl:copy-of select="@*"/> + <xsl:apply-templates/> + </section> + </xsl:otherwise> + </xsl:choose> + <xsl:text>
</xsl:text> +</xsl:template> + +<!-- Match text elements that are the first child of <programlisting> and chop any leading newline. --> --- 1.3/refman-4.1/Makefile 2005-07-12 18:33:22 -05:00 +++ 1.4/refman-4.1/Makefile 2005-07-16 13:17:14 -05:00 @@ -205,6 +205,13 @@ $(RM) $(HTML_FRAGMENT_FILES) $(RM) manual.txt +# Manual page generation + +manpages: manual.man + +clean:: + $(RM) *.man + # Import standard variables and target rules # Need xml-html-dir for formatting the manual itself into a subdir, --- 1.8/refman-4.1/mysql-apis.xml 2005-07-15 10:41:20 -05:00 +++ 1.9/refman-4.1/mysql-apis.xml 2005-07-16 13:17:14 -05:00 @@ -62,10 +62,6 @@ <itemizedlist> - <indexterm type="concept"> - <primary><command>msql2mysql</command></primary> - </indexterm> - <listitem><para> <literal>msql2mysql</literal> </para> @@ -74,12 +70,6 @@ A shell script that converts <literal>mSQL</literal> programs to MySQL. It doesn't handle every case, but it gives a good start when converting. - </para> - - <para> - <indexterm type="concept"> - <primary><command>mysql_config</command></primary> - </indexterm> </para></listitem> <listitem><para> @@ -93,142 +83,187 @@ </itemizedlist> - <section id="msql2mysql"> + <refentry id="msql2mysql"> - <title id='title-msql2mysql'>&title-msql2mysql;</title> + <indexterm type="concept"> + <primary><command>msql2mysql</command></primary> + </indexterm> - <para> - Initially, the MySQL C API was developed to be very similar to that - for the mSQL database system. Because of this, mSQL programs often - can be converted relatively easily for use with MySQL by changing - the names of the C API functions. - </para> + <refmeta> + <refentrytitle>msql2mysql</refentrytitle> + <manvolnum>man</manvolnum> + <refmiscinfo>Convert MySQL Programs for Use with MySQL</refmiscinfo> + </refmeta> - <para> - The <command>msql2mysql</command> utility performs the conversion of - mSQL C API function calls to their MySQL equivalents. - <command>msql2mysql</command> converts the input file in place, so - make a copy of the original before converting it. For example, use - <command>msql2mysql</command> like this: - </para> + <refnamediv> + <refname>msql2mysql</refname> + <refpurpose>convert MySQL programs for use with MySQL</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>msql2mysql<replaceable>C-source-file</replaceable> …</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="msql2mysql-description"> + + <title>Description</title> + + <para> + Initially, the MySQL C API was developed to be very similar to that + for the mSQL database system. Because of this, mSQL programs often + can be converted relatively easily for use with MySQL by changing + the names of the C API functions. + </para> + + <para> + The <command>msql2mysql</command> utility performs the conversion + of mSQL C API function calls to their MySQL equivalents. + <command>msql2mysql</command> converts the input file in place, so + make a copy of the original before converting it. For example, use + <command>msql2mysql</command> like this: + </para> <programlisting> -shell> cp client-prog.c client-prog.c.orig -shell> msql2mysql client-prog.c +shell> <userinput>cp client-prog.c client-prog.c.orig</userinput> +shell> <userinput>msql2mysql client-prog.c</userinput> client-prog.c converted </programlisting> - <para> - Then examine <filename>client-prog.c</filename> and make any - post-conversion revisions that may be necessary. - </para> - - <para> - <command>msql2mysql</command> uses the <command>replace</command> - utility to make the function name substitutions. See - <xref linkend="replace-utility"/>. - </para> + <para> + Then examine <filename>client-prog.c</filename> and make any + post-conversion revisions that may be necessary. + </para> - </section> + <para> + <command>msql2mysql</command> uses the <command>replace</command> + utility to make the function name substitutions. See + <xref linkend="replace-utility"/>. + </para> - <section id="mysql-config"> + </refsection> - <title id='title-mysql-config'>&title-mysql-config;</title> + </refentry> -<!-- TODO: move this to C API section (along with msql2mysql)? They're both --> + <refentry id="mysql-config"> -<!-- of more interest to developers, not to end users. --> + <indexterm type="concept"> + <primary><command>mysql_config</command></primary> + </indexterm> - <para> - <command>mysql_config</command> provides you with useful information - for compiling your MySQL client and connecting it to MySQL. - </para> + <refmeta> + <refentrytitle>mysql_config</refentrytitle> + <manvolnum>man</manvolnum> + <refmiscinfo>Get Compile Options for Compiling Clients</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>mysql_config</refname> + <refpurpose>get compile options for compiling clients</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>mysql_config <replaceable>options</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> - <para> - <command>mysql_config</command> supports the following options: - </para> + <refsection id="mysql-config-description"> - <itemizedlist> + <title>Description</title> - <listitem><para> - <literal>--cflags</literal> + <para> + <command>mysql_config</command> provides you with useful + information for compiling your MySQL client and connecting it to + MySQL. </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> - <literal>--include</literal> + <command>mysql_config</command> supports the following options: </para> - <para> - Compiler options to find MySQL include files. (Note that normally - you would use <literal>--cflags</literal> instead of this option.) - </para></listitem> + <itemizedlist> - <listitem><para> - <literal>--libmysqld-libs, --embedded</literal> - </para> + <listitem><para> + <option>--cflags</option> + </para> - <para> - Libraries and options required to link with the MySQL embedded - server. - </para></listitem> + <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> - <literal>--libs</literal> - </para> + <listitem><para> + <option>--include</option> + </para> - <para> - Libraries and options required to link with the MySQL client - library. - </para></listitem> + <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> - <literal>--libs_r</literal> - </para> + <listitem><para> + <option>--libmysqld-libs</option>, <option>---embedded</option> + </para> - <para> - Libraries and options required to link with the thread-safe MySQL - client library. - </para></listitem> + <para> + Libraries and options required to link with the MySQL embedded + server. + </para></listitem> - <listitem><para> - <literal>--port</literal> - </para> + <listitem><para> + <option>--libs</option> + </para> - <para> - The default TCP/IP port number, defined when configuring MySQL. - </para></listitem> + <para> + Libraries and options required to link with the MySQL client + library. + </para></listitem> - <listitem><para> - <literal>--socket</literal> - </para> + <listitem><para> + <option>--libs_r</option> + </para> - <para> - The default Unix socket file, defined when configuring MySQL. - </para></listitem> + <para> + Libraries and options required to link with the thread-safe MySQL + client library. + </para></listitem> - <listitem><para> - <literal>--version</literal> - </para> + <listitem><para> + <option>--port</option> + </para> - <para> - Version number and version for the MySQL distribution. - </para></listitem> + <para> + The default TCP/IP port number, defined when configuring MySQL. + </para></listitem> - </itemizedlist> + <listitem><para> + <option>--socket</option> + </para> - <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> + <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> mysql_config +shell> <userinput>mysql_config</userinput> Usage: /usr/local/mysql/bin/mysql_config [options] Options: --cflags [-I/usr/local/mysql/include/mysql -mcpu=pentiumpro] @@ -244,26 +279,28 @@ -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> -CFG=/usr/local/mysql/bin/mysql_config -sh -c "gcc -o progname `$CFG --cflags` progname.c `$CFG --libs`" +shell> <userinput>CFG=/usr/local/mysql/bin/mysql_config</userinput> +shell> <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> - </section> + </refsection> + + </refentry> </section> @@ -5787,7 +5824,7 @@ server with a client library that uses a different protocol version. This can happen if you use a very old client library to connect to a new server that wasn't started with the - <literal>--old-protocol</literal> option. + <option>--old-protocol</option> option. </para></listitem> <listitem><para> @@ -12540,7 +12577,7 @@ <para> To get a <literal>libmysqld</literal> library you should configure - MySQL with the <literal>--with-embedded-server</literal> option. + MySQL with the <option>--with-embedded-server</option> option. </para> <para> @@ -13062,7 +13099,7 @@ and later. Possible solutions are: downgrade to MySQL 4.0; switch to PHP 5 and the newer <emphasis role="bold">mysqli</emphasis> extension; or configure the MySQL server with - <literal>--old-passwords</literal>. (See + <option>--old-passwords</option>. (See <xref linkend="old-client"/>, for more information.) </para></listitem> --- 1.18/refman-4.1/titles.ent 2005-07-14 14:33:55 -05:00 +++ 1.19/refman-4.1/titles.ent 2005-07-16 13:17:14 -05:00 @@ -1074,7 +1074,6 @@ <!ENTITY title-myisam-storage-engine "The <literal>MyISAM</literal> Storage Engine"><!-- "The <literal>MyISAM</literal> Storage Engine" --> <!ENTITY title-development-source "Installing MyODBC from the BitKeeper Development Source Tree"><!-- "Installing MyODBC from the BitKeeper Development Source Tree" --> <!ENTITY title-ansi-diff-subqueries "Subqueries"><!-- "Subqueries" --> -<!ENTITY title-msql2mysql "<command>msql2mysql</command>, Convert mSQL Programs for Use with MySQL"><!-- "<command>msql2mysql</command>, Convert mSQL Programs for Use with MySQL" --> <!ENTITY title-news-3-21-33 "Changes in release 3.21.33 (08 Jul 1998)"><!-- "Changes in release 3.21.33 (08 Jul 1998)" --> <!ENTITY title-show-create-procedure "<literal>SHOW CREATE PROCEDURE</literal> and <literal>SHOW CREATE FUNCTION</literal>"><!-- "<literal>SHOW CREATE PROCEDURE</literal> and <literal>SHOW CREATE FUNCTION</literal>" --> <!ENTITY title-sco-unixware "SCO UnixWare 7.1.x and OpenUNIX 8.0.0 Notes"><!-- "SCO UnixWare 7.1.x and OpenUNIX 8.0.0 Notes" --> @@ -1155,7 +1154,6 @@ <!ENTITY title-news-3-22-7 "Changes in release 3.22.7 (21 Sep 1998: Beta)"><!-- "Changes in release 3.22.7 (21 Sep 1998: Beta)" --> <!ENTITY title-no-matching-rows "Solving Problems with No Matching Rows"><!-- "Solving Problems with No Matching Rows" --> <!ENTITY title-legal-names "Database, Table, Index, Column, and Alias Names"><!-- "Database, Table, Index, Column, and Alias Names" --> -<!ENTITY title-mysql-config "<command>mysql_config</command>, Get compile options for compiling clients"><!-- "<command>mysql_config</command>, Get compile options for compiling clients" --> <!ENTITY title-innodb-news-3-23-58 "MySQL/InnoDB-3.23.58, September 15, 2003"><!-- "MySQL/InnoDB-3.23.58, September 15, 2003" --> <!ENTITY title-credits "Credits"><!-- "Credits" --> <!ENTITY title-other-functions "Other Functions"><!-- "Other Functions" --> --- 1.3/refman-5.0/Makefile 2005-07-13 09:08:17 -05:00 +++ 1.4/refman-5.0/Makefile 2005-07-16 13:17:15 -05:00 @@ -202,6 +202,13 @@ $(RM) $(HTML_FRAGMENT_FILES) $(RM) manual.txt +# Manual page generation + +manpages: manual.man + +clean:: + $(RM) *.man + # Import standard variables and target rules # Need xml-html-dir for formatting the manual itself into a subdir, --- 1.8/refman-5.0/mysql-apis.xml 2005-07-15 10:41:20 -05:00 +++ 1.9/refman-5.0/mysql-apis.xml 2005-07-16 13:17:15 -05:00 @@ -62,10 +62,6 @@ <itemizedlist> - <indexterm type="concept"> - <primary><command>msql2mysql</command></primary> - </indexterm> - <listitem><para> <literal>msql2mysql</literal> </para> @@ -74,12 +70,6 @@ A shell script that converts <literal>mSQL</literal> programs to MySQL. It doesn't handle every case, but it gives a good start when converting. - </para> - - <para> - <indexterm type="concept"> - <primary><command>mysql_config</command></primary> - </indexterm> </para></listitem> <listitem><para> @@ -93,142 +83,187 @@ </itemizedlist> - <section id="msql2mysql"> + <refentry id="msql2mysql"> - <title id='title-msql2mysql'>&title-msql2mysql;</title> + <indexterm type="concept"> + <primary><command>msql2mysql</command></primary> + </indexterm> - <para> - Initially, the MySQL C API was developed to be very similar to that - for the mSQL database system. Because of this, mSQL programs often - can be converted relatively easily for use with MySQL by changing - the names of the C API functions. - </para> + <refmeta> + <refentrytitle>msql2mysql</refentrytitle> + <manvolnum>man</manvolnum> + <refmiscinfo>Convert MySQL Programs for Use with MySQL</refmiscinfo> + </refmeta> - <para> - The <command>msql2mysql</command> utility performs the conversion of - mSQL C API function calls to their MySQL equivalents. - <command>msql2mysql</command> converts the input file in place, so - make a copy of the original before converting it. For example, use - <command>msql2mysql</command> like this: - </para> + <refnamediv> + <refname>msql2mysql</refname> + <refpurpose>convert MySQL programs for use with MySQL</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>msql2mysql<replaceable>C-source-file</replaceable> …</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="msql2mysql-description"> + + <title>Description</title> + + <para> + Initially, the MySQL C API was developed to be very similar to that + for the mSQL database system. Because of this, mSQL programs often + can be converted relatively easily for use with MySQL by changing + the names of the C API functions. + </para> + + <para> + The <command>msql2mysql</command> utility performs the conversion + of mSQL C API function calls to their MySQL equivalents. + <command>msql2mysql</command> converts the input file in place, so + make a copy of the original before converting it. For example, use + <command>msql2mysql</command> like this: + </para> <programlisting> -shell> cp client-prog.c client-prog.c.orig -shell> msql2mysql client-prog.c +shell> <userinput>cp client-prog.c client-prog.c.orig</userinput> +shell> <userinput>msql2mysql client-prog.c</userinput> client-prog.c converted </programlisting> - <para> - Then examine <filename>client-prog.c</filename> and make any - post-conversion revisions that may be necessary. - </para> - - <para> - <command>msql2mysql</command> uses the <command>replace</command> - utility to make the function name substitutions. See - <xref linkend="replace-utility"/>. - </para> + <para> + Then examine <filename>client-prog.c</filename> and make any + post-conversion revisions that may be necessary. + </para> - </section> + <para> + <command>msql2mysql</command> uses the <command>replace</command> + utility to make the function name substitutions. See + <xref linkend="replace-utility"/>. + </para> - <section id="mysql-config"> + </refsection> - <title id='title-mysql-config'>&title-mysql-config;</title> + </refentry> -<!-- TODO: move this to C API section (along with msql2mysql)? They're both --> + <refentry id="mysql-config"> -<!-- of more interest to developers, not to end users. --> + <indexterm type="concept"> + <primary><command>mysql_config</command></primary> + </indexterm> - <para> - <command>mysql_config</command> provides you with useful information - for compiling your MySQL client and connecting it to MySQL. - </para> + <refmeta> + <refentrytitle>mysql_config</refentrytitle> + <manvolnum>man</manvolnum> + <refmiscinfo>Get Compile Options for Compiling Clients</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>mysql_config</refname> + <refpurpose>get compile options for compiling clients</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>mysql_config <replaceable>options</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> - <para> - <command>mysql_config</command> supports the following options: - </para> + <refsection id="mysql-config-description"> - <itemizedlist> + <title>Description</title> - <listitem><para> - <literal>--cflags</literal> + <para> + <command>mysql_config</command> provides you with useful + information for compiling your MySQL client and connecting it to + MySQL. </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> - <literal>--include</literal> + <command>mysql_config</command> supports the following options: </para> - <para> - Compiler options to find MySQL include files. (Note that normally - you would use <literal>--cflags</literal> instead of this option.) - </para></listitem> + <itemizedlist> - <listitem><para> - <literal>--libmysqld-libs, --embedded</literal> - </para> + <listitem><para> + <option>--cflags</option> + </para> - <para> - Libraries and options required to link with the MySQL embedded - server. - </para></listitem> + <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> - <literal>--libs</literal> - </para> + <listitem><para> + <option>--include</option> + </para> - <para> - Libraries and options required to link with the MySQL client - library. - </para></listitem> + <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> - <literal>--libs_r</literal> - </para> + <listitem><para> + <option>--libmysqld-libs</option>, <option>---embedded</option> + </para> - <para> - Libraries and options required to link with the thread-safe MySQL - client library. - </para></listitem> + <para> + Libraries and options required to link with the MySQL embedded + server. + </para></listitem> - <listitem><para> - <literal>--port</literal> - </para> + <listitem><para> + <option>--libs</option> + </para> - <para> - The default TCP/IP port number, defined when configuring MySQL. - </para></listitem> + <para> + Libraries and options required to link with the MySQL client + library. + </para></listitem> - <listitem><para> - <literal>--socket</literal> - </para> + <listitem><para> + <option>--libs_r</option> + </para> - <para> - The default Unix socket file, defined when configuring MySQL. - </para></listitem> + <para> + Libraries and options required to link with the thread-safe MySQL + client library. + </para></listitem> - <listitem><para> - <literal>--version</literal> - </para> + <listitem><para> + <option>--port</option> + </para> - <para> - Version number and version for the MySQL distribution. - </para></listitem> + <para> + The default TCP/IP port number, defined when configuring MySQL. + </para></listitem> - </itemizedlist> + <listitem><para> + <option>--socket</option> + </para> - <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> + <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> mysql_config +shell> <userinput>mysql_config</userinput> Usage: /usr/local/mysql/bin/mysql_config [options] Options: --cflags [-I/usr/local/mysql/include/mysql -mcpu=pentiumpro] @@ -244,26 +279,28 @@ -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> -CFG=/usr/local/mysql/bin/mysql_config -sh -c "gcc -o progname `$CFG --cflags` progname.c `$CFG --libs`" +shell> <userinput>CFG=/usr/local/mysql/bin/mysql_config</userinput> +shell> <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> - </section> + </refsection> + + </refentry> </section> @@ -5787,7 +5824,7 @@ server with a client library that uses a different protocol version. This can happen if you use a very old client library to connect to a new server that wasn't started with the - <literal>--old-protocol</literal> option. + <option>--old-protocol</option> option. </para></listitem> <listitem><para> @@ -12540,7 +12577,7 @@ <para> To get a <literal>libmysqld</literal> library you should configure - MySQL with the <literal>--with-embedded-server</literal> option. + MySQL with the <option>--with-embedded-server</option> option. </para> <para> @@ -13062,7 +13099,7 @@ and later. Possible solutions are: downgrade to MySQL 4.0; switch to PHP 5 and the newer <emphasis role="bold">mysqli</emphasis> extension; or configure the MySQL server with - <literal>--old-passwords</literal>. (See + <option>--old-passwords</option>. (See <xref linkend="old-client"/>, for more information.) </para></listitem> --- 1.22/refman-5.0/titles.ent 2005-07-14 22:40:26 -05:00 +++ 1.23/refman-5.0/titles.ent 2005-07-16 13:17:15 -05:00 @@ -1080,7 +1080,6 @@ <!ENTITY title-myisam-storage-engine "The <literal>MyISAM</literal> Storage Engine"><!-- "The <literal>MyISAM</literal> Storage Engine" --> <!ENTITY title-development-source "Installing MyODBC from the BitKeeper Development Source Tree"><!-- "Installing MyODBC from the BitKeeper Development Source Tree" --> <!ENTITY title-ansi-diff-subqueries "Subqueries"><!-- "Subqueries" --> -<!ENTITY title-msql2mysql "<command>msql2mysql</command>, Convert mSQL Programs for Use with MySQL"><!-- "<command>msql2mysql</command>, Convert mSQL Programs for Use with MySQL" --> <!ENTITY title-news-3-21-33 "Changes in release 3.21.33 (08 Jul 1998)"><!-- "Changes in release 3.21.33 (08 Jul 1998)" --> <!ENTITY title-show-create-procedure "<literal>SHOW CREATE PROCEDURE</literal> and <literal>SHOW CREATE FUNCTION</literal>"><!-- "<literal>SHOW CREATE PROCEDURE</literal> and <literal>SHOW CREATE FUNCTION</literal>" --> <!ENTITY title-sco-unixware "SCO UnixWare 7.1.x and OpenUNIX 8.0.0 Notes"><!-- "SCO UnixWare 7.1.x and OpenUNIX 8.0.0 Notes" --> @@ -1161,7 +1160,6 @@ <!ENTITY title-news-3-22-7 "Changes in release 3.22.7 (21 Sep 1998: Beta)"><!-- "Changes in release 3.22.7 (21 Sep 1998: Beta)" --> <!ENTITY title-no-matching-rows "Solving Problems with No Matching Rows"><!-- "Solving Problems with No Matching Rows" --> <!ENTITY title-legal-names "Database, Table, Index, Column, and Alias Names"><!-- "Database, Table, Index, Column, and Alias Names" --> -<!ENTITY title-mysql-config "<command>mysql_config</command>, Get compile options for compiling clients"><!-- "<command>mysql_config</command>, Get compile options for compiling clients" --> <!ENTITY title-innodb-news-3-23-58 "MySQL/InnoDB-3.23.58, September 15, 2003"><!-- "MySQL/InnoDB-3.23.58, September 15, 2003" --> <!ENTITY title-credits "Credits"><!-- "Credits" --> <!ENTITY title-other-functions "Other Functions"><!-- "Other Functions" --> --- 1.8/refman/mysql-apis.xml 2005-07-15 10:41:21 -05:00 +++ 1.9/refman/mysql-apis.xml 2005-07-16 13:17:15 -05:00 @@ -62,10 +62,6 @@ <itemizedlist> - <indexterm type="concept"> - <primary><command>msql2mysql</command></primary> - </indexterm> - <listitem><para> <literal>msql2mysql</literal> </para> @@ -74,12 +70,6 @@ A shell script that converts <literal>mSQL</literal> programs to MySQL. It doesn't handle every case, but it gives a good start when converting. - </para> - - <para> - <indexterm type="concept"> - <primary><command>mysql_config</command></primary> - </indexterm> </para></listitem> <listitem><para> @@ -93,142 +83,187 @@ </itemizedlist> - <section id="msql2mysql"> + <refentry id="msql2mysql"> - <title id='title-msql2mysql'>&title-msql2mysql;</title> + <indexterm type="concept"> + <primary><command>msql2mysql</command></primary> + </indexterm> - <para> - Initially, the MySQL C API was developed to be very similar to that - for the mSQL database system. Because of this, mSQL programs often - can be converted relatively easily for use with MySQL by changing - the names of the C API functions. - </para> + <refmeta> + <refentrytitle>msql2mysql</refentrytitle> + <manvolnum>man</manvolnum> + <refmiscinfo>Convert MySQL Programs for Use with MySQL</refmiscinfo> + </refmeta> - <para> - The <command>msql2mysql</command> utility performs the conversion of - mSQL C API function calls to their MySQL equivalents. - <command>msql2mysql</command> converts the input file in place, so - make a copy of the original before converting it. For example, use - <command>msql2mysql</command> like this: - </para> + <refnamediv> + <refname>msql2mysql</refname> + <refpurpose>convert MySQL programs for use with MySQL</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>msql2mysql<replaceable>C-source-file</replaceable> …</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="msql2mysql-description"> + + <title>Description</title> + + <para> + Initially, the MySQL C API was developed to be very similar to that + for the mSQL database system. Because of this, mSQL programs often + can be converted relatively easily for use with MySQL by changing + the names of the C API functions. + </para> + + <para> + The <command>msql2mysql</command> utility performs the conversion + of mSQL C API function calls to their MySQL equivalents. + <command>msql2mysql</command> converts the input file in place, so + make a copy of the original before converting it. For example, use + <command>msql2mysql</command> like this: + </para> <programlisting> -shell> cp client-prog.c client-prog.c.orig -shell> msql2mysql client-prog.c +shell> <userinput>cp client-prog.c client-prog.c.orig</userinput> +shell> <userinput>msql2mysql client-prog.c</userinput> client-prog.c converted </programlisting> - <para> - Then examine <filename>client-prog.c</filename> and make any - post-conversion revisions that may be necessary. - </para> - - <para> - <command>msql2mysql</command> uses the <command>replace</command> - utility to make the function name substitutions. See - <xref linkend="replace-utility"/>. - </para> + <para> + Then examine <filename>client-prog.c</filename> and make any + post-conversion revisions that may be necessary. + </para> - </section> + <para> + <command>msql2mysql</command> uses the <command>replace</command> + utility to make the function name substitutions. See + <xref linkend="replace-utility"/>. + </para> - <section id="mysql-config"> + </refsection> - <title id='title-mysql-config'>&title-mysql-config;</title> + </refentry> -<!-- TODO: move this to C API section (along with msql2mysql)? They're both --> + <refentry id="mysql-config"> -<!-- of more interest to developers, not to end users. --> + <indexterm type="concept"> + <primary><command>mysql_config</command></primary> + </indexterm> - <para> - <command>mysql_config</command> provides you with useful information - for compiling your MySQL client and connecting it to MySQL. - </para> + <refmeta> + <refentrytitle>mysql_config</refentrytitle> + <manvolnum>man</manvolnum> + <refmiscinfo>Get Compile Options for Compiling Clients</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>mysql_config</refname> + <refpurpose>get compile options for compiling clients</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>mysql_config <replaceable>options</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> - <para> - <command>mysql_config</command> supports the following options: - </para> + <refsection id="mysql-config-description"> - <itemizedlist> + <title>Description</title> - <listitem><para> - <literal>--cflags</literal> + <para> + <command>mysql_config</command> provides you with useful + information for compiling your MySQL client and connecting it to + MySQL. </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> - <literal>--include</literal> + <command>mysql_config</command> supports the following options: </para> - <para> - Compiler options to find MySQL include files. (Note that normally - you would use <literal>--cflags</literal> instead of this option.) - </para></listitem> + <itemizedlist> - <listitem><para> - <literal>--libmysqld-libs, --embedded</literal> - </para> + <listitem><para> + <option>--cflags</option> + </para> - <para> - Libraries and options required to link with the MySQL embedded - server. - </para></listitem> + <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> - <literal>--libs</literal> - </para> + <listitem><para> + <option>--include</option> + </para> - <para> - Libraries and options required to link with the MySQL client - library. - </para></listitem> + <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> - <literal>--libs_r</literal> - </para> + <listitem><para> + <option>--libmysqld-libs</option>, <option>---embedded</option> + </para> - <para> - Libraries and options required to link with the thread-safe MySQL - client library. - </para></listitem> + <para> + Libraries and options required to link with the MySQL embedded + server. + </para></listitem> - <listitem><para> - <literal>--port</literal> - </para> + <listitem><para> + <option>--libs</option> + </para> - <para> - The default TCP/IP port number, defined when configuring MySQL. - </para></listitem> + <para> + Libraries and options required to link with the MySQL client + library. + </para></listitem> - <listitem><para> - <literal>--socket</literal> - </para> + <listitem><para> + <option>--libs_r</option> + </para> - <para> - The default Unix socket file, defined when configuring MySQL. - </para></listitem> + <para> + Libraries and options required to link with the thread-safe MySQL + client library. + </para></listitem> - <listitem><para> - <literal>--version</literal> - </para> + <listitem><para> + <option>--port</option> + </para> - <para> - Version number and version for the MySQL distribution. - </para></listitem> + <para> + The default TCP/IP port number, defined when configuring MySQL. + </para></listitem> - </itemizedlist> + <listitem><para> + <option>--socket</option> + </para> - <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> + <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> mysql_config +shell> <userinput>mysql_config</userinput> Usage: /usr/local/mysql/bin/mysql_config [options] Options: --cflags [-I/usr/local/mysql/include/mysql -mcpu=pentiumpro] @@ -244,26 +279,28 @@ -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> -CFG=/usr/local/mysql/bin/mysql_config -sh -c "gcc -o progname `$CFG --cflags` progname.c `$CFG --libs`" +shell> <userinput>CFG=/usr/local/mysql/bin/mysql_config</userinput> +shell> <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> - </section> + </refsection> + + </refentry> </section> @@ -5787,7 +5824,7 @@ server with a client library that uses a different protocol version. This can happen if you use a very old client library to connect to a new server that wasn't started with the - <literal>--old-protocol</literal> option. + <option>--old-protocol</option> option. </para></listitem> <listitem><para> @@ -12540,7 +12577,7 @@ <para> To get a <literal>libmysqld</literal> library you should configure - MySQL with the <literal>--with-embedded-server</literal> option. + MySQL with the <option>--with-embedded-server</option> option. </para> <para> @@ -13062,7 +13099,7 @@ and later. Possible solutions are: downgrade to MySQL 4.0; switch to PHP 5 and the newer <emphasis role="bold">mysqli</emphasis> extension; or configure the MySQL server with - <literal>--old-passwords</literal>. (See + <option>--old-passwords</option>. (See <xref linkend="old-client"/>, for more information.) </para></listitem> --- 1.25/refman/titles.ent 2005-07-14 22:40:26 -05:00 +++ 1.26/refman/titles.ent 2005-07-16 13:17:15 -05:00 @@ -1079,7 +1079,6 @@ <!ENTITY title-myisam-storage-engine "The <literal>MyISAM</literal> Storage Engine"><!-- "The <literal>MyISAM</literal> Storage Engine" --> <!ENTITY title-development-source "Installing MyODBC from the BitKeeper Development Source Tree"><!-- "Installing MyODBC from the BitKeeper Development Source Tree" --> <!ENTITY title-ansi-diff-subqueries "Subqueries"><!-- "Subqueries" --> -<!ENTITY title-msql2mysql "<command>msql2mysql</command>, Convert mSQL Programs for Use with MySQL"><!-- "<command>msql2mysql</command>, Convert mSQL Programs for Use with MySQL" --> <!ENTITY title-news-3-21-33 "Changes in release 3.21.33 (08 Jul 1998)"><!-- "Changes in release 3.21.33 (08 Jul 1998)" --> <!ENTITY title-show-create-procedure "<literal>SHOW CREATE PROCEDURE</literal> and <literal>SHOW CREATE FUNCTION</literal>"><!-- "<literal>SHOW CREATE PROCEDURE</literal> and <literal>SHOW CREATE FUNCTION</literal>" --> <!ENTITY title-sco-unixware "SCO UnixWare 7.1.x and OpenUNIX 8.0.0 Notes"><!-- "SCO UnixWare 7.1.x and OpenUNIX 8.0.0 Notes" --> @@ -1160,7 +1159,6 @@ <!ENTITY title-news-3-22-7 "Changes in release 3.22.7 (21 Sep 1998: Beta)"><!-- "Changes in release 3.22.7 (21 Sep 1998: Beta)" --> <!ENTITY title-no-matching-rows "Solving Problems with No Matching Rows"><!-- "Solving Problems with No Matching Rows" --> <!ENTITY title-legal-names "Database, Table, Index, Column, and Alias Names"><!-- "Database, Table, Index, Column, and Alias Names" --> -<!ENTITY title-mysql-config "<command>mysql_config</command>, Get compile options for compiling clients"><!-- "<command>mysql_config</command>, Get compile options for compiling clients" --> <!ENTITY title-innodb-news-3-23-58 "MySQL/InnoDB-3.23.58, September 15, 2003"><!-- "MySQL/InnoDB-3.23.58, September 15, 2003" --> <!ENTITY title-credits "Credits"><!-- "Credits" --> <!ENTITY title-other-functions "Other Functions"><!-- "Other Functions" -->
| Thread | ||
|---|---|---|
| • bk commit - mysqldoc@docsrva tree (paul:1.3039) | paul | 16 Jul |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.885 sec. using MySQL 5.1.14-beta-log