Author: paul
Date: 2009-06-04 18:21:28 +0200 (Thu, 04 Jun 2009)
New Revision: 15192
Log:
r41884@frost: paul | 2009-06-04 11:20:38 -0500
Promote a section, add indexterms
Modified:
trunk/refman-4.1/programs-using.xml
trunk/refman-5.0/programs-using.xml
trunk/refman-5.1/programs-using.xml
trunk/refman-5.4/programs-using.xml
trunk/refman-6.0/programs-using.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:41865
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:38756
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:41884
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:38756
Modified: trunk/refman-4.1/programs-using.xml
===================================================================
--- trunk/refman-4.1/programs-using.xml 2009-06-04 15:26:19 UTC (rev 15191)
+++ trunk/refman-4.1/programs-using.xml 2009-06-04 16:21:28 UTC (rev 15192)
Changed blocks: 2, Lines Added: 86, Lines Deleted: 76; 8255 bytes
@@ -967,65 +967,77 @@
+---------------------+
</programlisting>
- <para>
- The <option>--execute</option> or <option>-e</option> option may
- also be used to pass commands in an analogous fashion to the
- <command>ndb_mgm</command> management client for MySQL Cluster.
- See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for
- an example.
- </para>
+ </section>
- <section id="option-modifiers">
+ <para>
+ The <option>--execute</option> or <option>-e</option> option may
+ also be used to pass commands in an analogous fashion to the
+ <command>ndb_mgm</command> management client for MySQL Cluster.
+ See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for an
+ example.
+ </para>
- <title>Program Option Modifiers</title>
+ <section id="option-modifiers">
- <indexterm>
- <primary>option modifiers</primary>
- </indexterm>
+ <title>Program Option Modifiers</title>
- <para>
- MySQL 4.0.2 introduced some additional flexibility in the way
- you specify options. SQL 4.0.2. Some of these changes relate
- to the way you specify options that have
- <quote>enabled</quote> and <quote>disabled</quote> states, and
- to the use of options that might be present in one version of
- MySQL but not another. Those capabilities are discussed in
- this section.
- </para>
+ <indexterm>
+ <primary>option modifiers</primary>
+ </indexterm>
- <para>
- Some options control behavior that can be turned on or off.
- For example, the <command>mysql</command> client supports a
- <option role="mysql">--column-names</option> option that
- determines whether or not to display a row of column names at
- the beginning of query results. By default, this option is
- enabled. However, you may want to disable it in some
- instances, such as when sending the output of
- <command>mysql</command> into another program that expects to
- see only data and not an initial header line.
- </para>
+ <indexterm>
+ <primary>options</primary>
+ <secondary>boolean</secondary>
+ </indexterm>
- <para>
- To disable column names, you can specify the option using any
- of these forms:
- </para>
+ <indexterm>
+ <primary>boolean options</primary>
+ </indexterm>
+ <para>
+ MySQL 4.0.2 introduced some additional flexibility in the way
+ you specify options. SQL 4.0.2. Some of these changes relate to
+ the way you specify options that have <quote>enabled</quote> and
+ <quote>disabled</quote> states, and to the use of options that
+ might be present in one version of MySQL but not another. Those
+ capabilities are discussed in this section.
+ </para>
+
+ <para>
+ Some options are <quote>boolean</quote> and control behavior
+ that can be turned on or off. Some options control behavior that
+ can be turned on or off. For example, the
+ <command>mysql</command> client supports a
+ <option role="mysql">--column-names</option> option that
+ determines whether or not to display a row of column names at
+ the beginning of query results. By default, this option is
+ enabled. However, you may want to disable it in some instances,
+ such as when sending the output of <command>mysql</command> into
+ another program that expects to see only data and not an initial
+ header line.
+ </para>
+
+ <para>
+ To disable column names, you can specify the option using any of
+ these forms:
+ </para>
+
<programlisting>
--disable-column-names
--skip-column-names
--column-names=0
</programlisting>
- <para>
- The <option>--disable</option> and <option>--skip</option>
- prefixes and the <literal>=0</literal> suffix all have the
- same effect: They turn the option off.
- </para>
+ <para>
+ The <option>--disable</option> and <option>--skip</option>
+ prefixes and the <literal>=0</literal> suffix all have the same
+ effect: They turn the option off.
+ </para>
- <para>
- The <quote>enabled</quote> form of the option may be specified
- in any of these ways:
- </para>
+ <para>
+ The <quote>enabled</quote> form of the option may be specified
+ in any of these ways:
+ </para>
<programlisting>
--column-names
@@ -1033,45 +1045,43 @@
--column-names=1
</programlisting>
- <para>
- Another change to option processing introduced in MySQL 4.0.2
- is that you can use the <option>--loose</option> prefix for
- command-line options. If an option is prefixed by
- <option>--loose</option>, a program does not exit with an
- error if it does not recognize the option, but instead issues
- only a warning:
- </para>
+ <para>
+ Another change to option processing introduced in MySQL 4.0.2 is
+ that you can use the <option>--loose</option> prefix for
+ command-line options. If an option is prefixed by
+ <option>--loose</option>, a program does not exit with an error
+ if it does not recognize the option, but instead issues only a
+ warning:
+ </para>
<programlisting>
shell> <userinput>mysql --loose-no-such-option</userinput>
mysql: WARNING: unknown option '--no-such-option'
</programlisting>
- <para>
- The <option>--loose</option> prefix can be useful when you run
- programs from multiple installations of MySQL on the same
- machine and list options in an option file, An option that may
- not be recognized by all versions of a program can be given
- using the <option>--loose</option> prefix (or
- <literal>loose</literal> in an option file). Versions of the
- program that recognize the option process it normally, and
- versions that do not recognize it issue a warning and ignore
- it. This strategy requires that all versions involved be 4.0.2
- or later, because earlier versions know nothing of the
- <option>--loose</option> convention.
- </para>
+ <para>
+ The <option>--loose</option> prefix can be useful when you run
+ programs from multiple installations of MySQL on the same
+ machine and list options in an option file, An option that may
+ not be recognized by all versions of a program can be given
+ using the <option>--loose</option> prefix (or
+ <literal>loose</literal> in an option file). Versions of the
+ program that recognize the option process it normally, and
+ versions that do not recognize it issue a warning and ignore it.
+ This strategy requires that all versions involved be 4.0.2 or
+ later, because earlier versions know nothing of the
+ <option>--loose</option> convention.
+ </para>
- <para>
- As of MySQL 4.0.2, <command>mysqld</command> enables a limit
- to be placed on how large client programs can set dynamic
- system variables. To do this, use a <option>--maximum</option>
- prefix with the variable name. For example,
- <option>--maximum-query_cache_size=4M</option> prevents any
- client from making the query cache size larger than 4MB.
- </para>
+ <para>
+ As of MySQL 4.0.2, <command>mysqld</command> enables a limit to
+ be placed on how large client programs can set dynamic system
+ variables. To do this, use a <option>--maximum</option> prefix
+ with the variable name. For example,
+ <option>--maximum-query_cache_size=4M</option> prevents any
+ client from making the query cache size larger than 4MB.
+ </para>
- </section>
-
</section>
<section id="option-files">
Modified: trunk/refman-5.0/programs-using.xml
===================================================================
--- trunk/refman-5.0/programs-using.xml 2009-06-04 15:26:19 UTC (rev 15191)
+++ trunk/refman-5.0/programs-using.xml 2009-06-04 16:21:28 UTC (rev 15192)
Changed blocks: 2, Lines Added: 71, Lines Deleted: 62; 6560 bytes
@@ -962,55 +962,67 @@
+---------------------+
</programlisting>
- <para>
- The <option>--execute</option> or <option>-e</option> option may
- also be used to pass commands in an analogous fashion to the
- <command>ndb_mgm</command> management client for MySQL Cluster.
- See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for
- an example.
- </para>
+ </section>
- <section id="option-modifiers">
+ <para>
+ The <option>--execute</option> or <option>-e</option> option may
+ also be used to pass commands in an analogous fashion to the
+ <command>ndb_mgm</command> management client for MySQL Cluster.
+ See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for an
+ example.
+ </para>
- <title>Program Option Modifiers</title>
+ <section id="option-modifiers">
- <indexterm>
- <primary>option modifiers</primary>
- </indexterm>
+ <title>Program Option Modifiers</title>
- <para>
- Some options control behavior that can be turned on or off.
- For example, the <command>mysql</command> client supports a
- <option role="mysql">--column-names</option> option that
- determines whether or not to display a row of column names at
- the beginning of query results. By default, this option is
- enabled. However, you may want to disable it in some
- instances, such as when sending the output of
- <command>mysql</command> into another program that expects to
- see only data and not an initial header line.
- </para>
+ <indexterm>
+ <primary>option modifiers</primary>
+ </indexterm>
- <para>
- To disable column names, you can specify the option using any
- of these forms:
- </para>
+ <indexterm>
+ <primary>options</primary>
+ <secondary>boolean</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>boolean options</primary>
+ </indexterm>
+
+ <para>
+ Some options are <quote>boolean</quote> and control behavior
+ that can be turned on or off. For example, the
+ <command>mysql</command> client supports a
+ <option role="mysql">--column-names</option> option that
+ determines whether or not to display a row of column names at
+ the beginning of query results. By default, this option is
+ enabled. However, you may want to disable it in some instances,
+ such as when sending the output of <command>mysql</command> into
+ another program that expects to see only data and not an initial
+ header line.
+ </para>
+
+ <para>
+ To disable column names, you can specify the option using any of
+ these forms:
+ </para>
+
<programlisting>
--disable-column-names
--skip-column-names
--column-names=0
</programlisting>
- <para>
- The <option>--disable</option> and <option>--skip</option>
- prefixes and the <literal>=0</literal> suffix all have the
- same effect: They turn the option off.
- </para>
+ <para>
+ The <option>--disable</option> and <option>--skip</option>
+ prefixes and the <literal>=0</literal> suffix all have the same
+ effect: They turn the option off.
+ </para>
- <para>
- The <quote>enabled</quote> form of the option may be specified
- in any of these ways:
- </para>
+ <para>
+ The <quote>enabled</quote> form of the option may be specified
+ in any of these ways:
+ </para>
<programlisting>
--column-names
@@ -1018,40 +1030,37 @@
--column-names=1
</programlisting>
- <para>
- If an option is prefixed by <option>--loose</option>, a
- program does not exit with an error if it does not recognize
- the option, but instead issues only a warning:
- </para>
+ <para>
+ If an option is prefixed by <option>--loose</option>, a program
+ does not exit with an error if it does not recognize the option,
+ but instead issues only a warning:
+ </para>
<programlisting>
shell> <userinput>mysql --loose-no-such-option</userinput>
mysql: WARNING: unknown option '--no-such-option'
</programlisting>
- <para>
- The <option>--loose</option> prefix can be useful when you run
- programs from multiple installations of MySQL on the same
- machine and list options in an option file, An option that may
- not be recognized by all versions of a program can be given
- using the <option>--loose</option> prefix (or
- <literal>loose</literal> in an option file). Versions of the
- program that recognize the option process it normally, and
- versions that do not recognize it issue a warning and ignore
- it.
- </para>
+ <para>
+ The <option>--loose</option> prefix can be useful when you run
+ programs from multiple installations of MySQL on the same
+ machine and list options in an option file, An option that may
+ not be recognized by all versions of a program can be given
+ using the <option>--loose</option> prefix (or
+ <literal>loose</literal> in an option file). Versions of the
+ program that recognize the option process it normally, and
+ versions that do not recognize it issue a warning and ignore it.
+ </para>
- <para>
- <command>mysqld</command> enables a limit to be placed on how
- large client programs can set dynamic system variables. To do
- this, use a <option>--maximum</option> prefix with the
- variable name. For example,
- <option>--maximum-query_cache_size=4M</option> prevents any
- client from making the query cache size larger than 4MB.
- </para>
+ <para>
+ <command>mysqld</command> enables a limit to be placed on how
+ large client programs can set dynamic system variables. To do
+ this, use a <option>--maximum</option> prefix with the variable
+ name. For example,
+ <option>--maximum-query_cache_size=4M</option> prevents any
+ client from making the query cache size larger than 4MB.
+ </para>
- </section>
-
</section>
<section id="option-files">
Modified: trunk/refman-5.1/programs-using.xml
===================================================================
--- trunk/refman-5.1/programs-using.xml 2009-06-04 15:26:19 UTC (rev 15191)
+++ trunk/refman-5.1/programs-using.xml 2009-06-04 16:21:28 UTC (rev 15192)
Changed blocks: 2, Lines Added: 71, Lines Deleted: 62; 6560 bytes
@@ -962,55 +962,67 @@
+---------------------+
</programlisting>
- <para>
- The <option>--execute</option> or <option>-e</option> option may
- also be used to pass commands in an analogous fashion to the
- <command>ndb_mgm</command> management client for MySQL Cluster.
- See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for
- an example.
- </para>
+ </section>
- <section id="option-modifiers">
+ <para>
+ The <option>--execute</option> or <option>-e</option> option may
+ also be used to pass commands in an analogous fashion to the
+ <command>ndb_mgm</command> management client for MySQL Cluster.
+ See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for an
+ example.
+ </para>
- <title>Program Option Modifiers</title>
+ <section id="option-modifiers">
- <indexterm>
- <primary>option modifiers</primary>
- </indexterm>
+ <title>Program Option Modifiers</title>
- <para>
- Some options control behavior that can be turned on or off.
- For example, the <command>mysql</command> client supports a
- <option role="mysql">--column-names</option> option that
- determines whether or not to display a row of column names at
- the beginning of query results. By default, this option is
- enabled. However, you may want to disable it in some
- instances, such as when sending the output of
- <command>mysql</command> into another program that expects to
- see only data and not an initial header line.
- </para>
+ <indexterm>
+ <primary>option modifiers</primary>
+ </indexterm>
- <para>
- To disable column names, you can specify the option using any
- of these forms:
- </para>
+ <indexterm>
+ <primary>options</primary>
+ <secondary>boolean</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>boolean options</primary>
+ </indexterm>
+
+ <para>
+ Some options are <quote>boolean</quote> and control behavior
+ that can be turned on or off. For example, the
+ <command>mysql</command> client supports a
+ <option role="mysql">--column-names</option> option that
+ determines whether or not to display a row of column names at
+ the beginning of query results. By default, this option is
+ enabled. However, you may want to disable it in some instances,
+ such as when sending the output of <command>mysql</command> into
+ another program that expects to see only data and not an initial
+ header line.
+ </para>
+
+ <para>
+ To disable column names, you can specify the option using any of
+ these forms:
+ </para>
+
<programlisting>
--disable-column-names
--skip-column-names
--column-names=0
</programlisting>
- <para>
- The <option>--disable</option> and <option>--skip</option>
- prefixes and the <literal>=0</literal> suffix all have the
- same effect: They turn the option off.
- </para>
+ <para>
+ The <option>--disable</option> and <option>--skip</option>
+ prefixes and the <literal>=0</literal> suffix all have the same
+ effect: They turn the option off.
+ </para>
- <para>
- The <quote>enabled</quote> form of the option may be specified
- in any of these ways:
- </para>
+ <para>
+ The <quote>enabled</quote> form of the option may be specified
+ in any of these ways:
+ </para>
<programlisting>
--column-names
@@ -1018,40 +1030,37 @@
--column-names=1
</programlisting>
- <para>
- If an option is prefixed by <option>--loose</option>, a
- program does not exit with an error if it does not recognize
- the option, but instead issues only a warning:
- </para>
+ <para>
+ If an option is prefixed by <option>--loose</option>, a program
+ does not exit with an error if it does not recognize the option,
+ but instead issues only a warning:
+ </para>
<programlisting>
shell> <userinput>mysql --loose-no-such-option</userinput>
mysql: WARNING: unknown option '--no-such-option'
</programlisting>
- <para>
- The <option>--loose</option> prefix can be useful when you run
- programs from multiple installations of MySQL on the same
- machine and list options in an option file, An option that may
- not be recognized by all versions of a program can be given
- using the <option>--loose</option> prefix (or
- <literal>loose</literal> in an option file). Versions of the
- program that recognize the option process it normally, and
- versions that do not recognize it issue a warning and ignore
- it.
- </para>
+ <para>
+ The <option>--loose</option> prefix can be useful when you run
+ programs from multiple installations of MySQL on the same
+ machine and list options in an option file, An option that may
+ not be recognized by all versions of a program can be given
+ using the <option>--loose</option> prefix (or
+ <literal>loose</literal> in an option file). Versions of the
+ program that recognize the option process it normally, and
+ versions that do not recognize it issue a warning and ignore it.
+ </para>
- <para>
- <command>mysqld</command> enables a limit to be placed on how
- large client programs can set dynamic system variables. To do
- this, use a <option>--maximum</option> prefix with the
- variable name. For example,
- <option>--maximum-query_cache_size=4M</option> prevents any
- client from making the query cache size larger than 4MB.
- </para>
+ <para>
+ <command>mysqld</command> enables a limit to be placed on how
+ large client programs can set dynamic system variables. To do
+ this, use a <option>--maximum</option> prefix with the variable
+ name. For example,
+ <option>--maximum-query_cache_size=4M</option> prevents any
+ client from making the query cache size larger than 4MB.
+ </para>
- </section>
-
</section>
<section id="option-files">
Modified: trunk/refman-5.4/programs-using.xml
===================================================================
--- trunk/refman-5.4/programs-using.xml 2009-06-04 15:26:19 UTC (rev 15191)
+++ trunk/refman-5.4/programs-using.xml 2009-06-04 16:21:28 UTC (rev 15192)
Changed blocks: 2, Lines Added: 71, Lines Deleted: 62; 6560 bytes
@@ -962,55 +962,67 @@
+---------------------+
</programlisting>
- <para>
- The <option>--execute</option> or <option>-e</option> option may
- also be used to pass commands in an analogous fashion to the
- <command>ndb_mgm</command> management client for MySQL Cluster.
- See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for
- an example.
- </para>
+ </section>
- <section id="option-modifiers">
+ <para>
+ The <option>--execute</option> or <option>-e</option> option may
+ also be used to pass commands in an analogous fashion to the
+ <command>ndb_mgm</command> management client for MySQL Cluster.
+ See <xref linkend="mysql-cluster-multi-shutdown-restart"/>, for an
+ example.
+ </para>
- <title>Program Option Modifiers</title>
+ <section id="option-modifiers">
- <indexterm>
- <primary>option modifiers</primary>
- </indexterm>
+ <title>Program Option Modifiers</title>
- <para>
- Some options control behavior that can be turned on or off.
- For example, the <command>mysql</command> client supports a
- <option role="mysql">--column-names</option> option that
- determines whether or not to display a row of column names at
- the beginning of query results. By default, this option is
- enabled. However, you may want to disable it in some
- instances, such as when sending the output of
- <command>mysql</command> into another program that expects to
- see only data and not an initial header line.
- </para>
+ <indexterm>
+ <primary>option modifiers</primary>
+ </indexterm>
- <para>
- To disable column names, you can specify the option using any
- of these forms:
- </para>
+ <indexterm>
+ <primary>options</primary>
+ <secondary>boolean</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>boolean options</primary>
+ </indexterm>
+
+ <para>
+ Some options are <quote>boolean</quote> and control behavior
+ that can be turned on or off. For example, the
+ <command>mysql</command> client supports a
+ <option role="mysql">--column-names</option> option that
+ determines whether or not to display a row of column names at
+ the beginning of query results. By default, this option is
+ enabled. However, you may want to disable it in some instances,
+ such as when sending the output of <command>mysql</command> into
+ another program that expects to see only data and not an initial
+ header line.
+ </para>
+
+ <para>
+ To disable column names, you can specify the option using any of
+ these forms:
+ </para>
+
<programlisting>
--disable-column-names
--skip-column-names
--column-names=0
</programlisting>
- <para>
- The <option>--disable</option> and <option>--skip</option>
- prefixes and the <literal>=0</literal> suffix all have the
- same effect: They turn the option off.
- </para>
+ <para>
+ The <option>--disable</option> and <option>--skip</option>
+ prefixes and the <literal>=0</literal> suffix all have the same
+ effect: They turn the option off.
+ </para>
- <para>
- The <quote>enabled</quote> form of the option may be specified
- in any of these ways:
- </para>
+ <para>
+ The <quote>enabled</quote> form of the option may be specified
+ in any of these ways:
+ </para>
<programlisting>
--column-names
@@ -1018,40 +1030,37 @@
--column-names=1
</programlisting>
- <para>
- If an option is prefixed by <option>--loose</option>, a
- program does not exit with an error if it does not recognize
- the option, but instead issues only a warning:
- </para>
+ <para>
+ If an option is prefixed by <option>--loose</option>, a program
+ does not exit with an error if it does not recognize the option,
+ but instead issues only a warning:
+ </para>
<programlisting>
shell> <userinput>mysql --loose-no-such-option</userinput>
mysql: WARNING: unknown option '--no-such-option'
</programlisting>
- <para>
- The <option>--loose</option> prefix can be useful when you run
- programs from multiple installations of MySQL on the same
- machine and list options in an option file, An option that may
- not be recognized by all versions of a program can be given
- using the <option>--loose</option> prefix (or
- <literal>loose</literal> in an option file). Versions of the
- program that recognize the option process it normally, and
- versions that do not recognize it issue a warning and ignore
- it.
- </para>
+ <para>
+ The <option>--loose</option> prefix can be useful when you run
+ programs from multiple installations of MySQL on the same
+ machine and list options in an option file, An option that may
+ not be recognized by all versions of a program can be given
+ using the <option>--loose</option> prefix (or
+ <literal>loose</literal> in an option file). Versions of the
+ program that recognize the option process it normally, and
+ versions that do not recognize it issue a warning and ignore it.
+ </para>
- <para>
- <command>mysqld</command> enables a limit to be placed on how
- large client programs can set dynamic system variables. To do
- this, use a <option>--maximum</option> prefix with the
- variable name. For example,
- <option>--maximum-query_cache_size=4M</option> prevents any
- client from making the query cache size larger than 4MB.
- </para>
+ <para>
+ <command>mysqld</command> enables a limit to be placed on how
+ large client programs can set dynamic system variables. To do
+ this, use a <option>--maximum</option> prefix with the variable
+ name. For example,
+ <option>--maximum-query_cache_size=4M</option> prevents any
+ client from making the query cache size larger than 4MB.
+ </para>
- </section>
-
</section>
<section id="option-files">
Modified: trunk/refman-6.0/programs-using.xml
===================================================================
--- trunk/refman-6.0/programs-using.xml 2009-06-04 15:26:19 UTC (rev 15191)
+++ trunk/refman-6.0/programs-using.xml 2009-06-04 16:21:28 UTC (rev 15192)
Changed blocks: 2, Lines Added: 64, Lines Deleted: 55; 5907 bytes
@@ -962,47 +962,59 @@
+---------------------+
</programlisting>
- <section id="option-modifiers">
+ </section>
- <title>Program Option Modifiers</title>
+ <section id="option-modifiers">
- <indexterm>
- <primary>option modifiers</primary>
- </indexterm>
+ <title>Program Option Modifiers</title>
- <para>
- Some options control behavior that can be turned on or off.
- For example, the <command>mysql</command> client supports a
- <option role="mysql">--column-names</option> option that
- determines whether or not to display a row of column names at
- the beginning of query results. By default, this option is
- enabled. However, you may want to disable it in some
- instances, such as when sending the output of
- <command>mysql</command> into another program that expects to
- see only data and not an initial header line.
- </para>
+ <indexterm>
+ <primary>option modifiers</primary>
+ </indexterm>
- <para>
- To disable column names, you can specify the option using any
- of these forms:
- </para>
+ <indexterm>
+ <primary>options</primary>
+ <secondary>boolean</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>boolean options</primary>
+ </indexterm>
+
+ <para>
+ Some options are <quote>boolean</quote> and control behavior
+ that can be turned on or off. For example, the
+ <command>mysql</command> client supports a
+ <option role="mysql">--column-names</option> option that
+ determines whether or not to display a row of column names at
+ the beginning of query results. By default, this option is
+ enabled. However, you may want to disable it in some instances,
+ such as when sending the output of <command>mysql</command> into
+ another program that expects to see only data and not an initial
+ header line.
+ </para>
+
+ <para>
+ To disable column names, you can specify the option using any of
+ these forms:
+ </para>
+
<programlisting>
--disable-column-names
--skip-column-names
--column-names=0
</programlisting>
- <para>
- The <option>--disable</option> and <option>--skip</option>
- prefixes and the <literal>=0</literal> suffix all have the
- same effect: They turn the option off.
- </para>
+ <para>
+ The <option>--disable</option> and <option>--skip</option>
+ prefixes and the <literal>=0</literal> suffix all have the same
+ effect: They turn the option off.
+ </para>
- <para>
- The <quote>enabled</quote> form of the option may be specified
- in any of these ways:
- </para>
+ <para>
+ The <quote>enabled</quote> form of the option may be specified
+ in any of these ways:
+ </para>
<programlisting>
--column-names
@@ -1010,40 +1022,37 @@
--column-names=1
</programlisting>
- <para>
- If an option is prefixed by <option>--loose</option>, a
- program does not exit with an error if it does not recognize
- the option, but instead issues only a warning:
- </para>
+ <para>
+ If an option is prefixed by <option>--loose</option>, a program
+ does not exit with an error if it does not recognize the option,
+ but instead issues only a warning:
+ </para>
<programlisting>
shell> <userinput>mysql --loose-no-such-option</userinput>
mysql: WARNING: unknown option '--no-such-option'
</programlisting>
- <para>
- The <option>--loose</option> prefix can be useful when you run
- programs from multiple installations of MySQL on the same
- machine and list options in an option file, An option that may
- not be recognized by all versions of a program can be given
- using the <option>--loose</option> prefix (or
- <literal>loose</literal> in an option file). Versions of the
- program that recognize the option process it normally, and
- versions that do not recognize it issue a warning and ignore
- it.
- </para>
+ <para>
+ The <option>--loose</option> prefix can be useful when you run
+ programs from multiple installations of MySQL on the same
+ machine and list options in an option file, An option that may
+ not be recognized by all versions of a program can be given
+ using the <option>--loose</option> prefix (or
+ <literal>loose</literal> in an option file). Versions of the
+ program that recognize the option process it normally, and
+ versions that do not recognize it issue a warning and ignore it.
+ </para>
- <para>
- <command>mysqld</command> enables a limit to be placed on how
- large client programs can set dynamic system variables. To do
- this, use a <option>--maximum</option> prefix with the
- variable name. For example,
- <option>--maximum-query_cache_size=4M</option> prevents any
- client from making the query cache size larger than 4MB.
- </para>
+ <para>
+ <command>mysqld</command> enables a limit to be placed on how
+ large client programs can set dynamic system variables. To do
+ this, use a <option>--maximum</option> prefix with the variable
+ name. For example,
+ <option>--maximum-query_cache_size=4M</option> prevents any
+ client from making the query cache size larger than 4MB.
+ </para>
- </section>
-
</section>
<section id="option-files">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r15192 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-5.4 refman-6.0 | paul.dubois | 5 Jun |
