Author: paul
Date: 2006-01-06 05:02:38 +0100 (Fri, 06 Jan 2006)
New Revision: 703
Log:
r5905@frost: paul | 2006-01-05 22:01:17 -0600
General revisions.
Modified:
trunk/
trunk/refman-4.1/using-mysql-programs.xml
trunk/refman-5.0/using-mysql-programs.xml
trunk/refman-5.1/using-mysql-programs.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:5904
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1933
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:5905
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1933
Modified: trunk/refman-4.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-4.1/using-mysql-programs.xml 2006-01-06 04:02:23 UTC (rev 702)
+++ trunk/refman-4.1/using-mysql-programs.xml 2006-01-06 04:02:38 UTC (rev 703)
@@ -569,25 +569,24 @@
</para>
<para>
- Another option which may be occasionally useful with
- <command>mysql</command> is the <option>-e</option> or
- <option>--execute</option> option, which can be used to pass SQL
- statements to the server. The statements must be surrounded by
- (single or double) quotation marks. (However, if you wish to use
- quoted values within the query, you should use double quotes for
- the query, and single quotes for any quoted values within the
- query.) When this option is used, the statements are executed,
- and then <command>mysql</command> exits to the command shell
- immediately thereafter.
+ Another option that may occasionally be useful with
+ <command>mysql</command> is the <option>--execute</option> or
+ <option>-e</option> option, which can be used to pass SQL
+ statements to the server. The statements must be enclosed by
+ single or double quotation marks. If you wish to use quoted
+ values within a statement, you should use double quotes for the
+ statement, and single quotes for any quoted values within the
+ statement. When this option is used, <command>mysql</command>
+ executes the statements and exits.
</para>
<para>
- For example, you can use the following to obtain a list of user
- accounts:
+ For example, you can use the following command to obtain a list
+ of user accounts:
</para>
<programlisting>
-shell> <userinput>mysql -u root -p -e "SELECT User, Host FROM user" mysql</userinput>
+shell> <userinput>mysql -u root -p --execute="SELECT User, Host FROM user" mysql</userinput>
Enter password: <userinput>******</userinput>
+------+-----------+
| User | Host |
@@ -602,43 +601,46 @@
</programlisting>
<para>
- Note that the name of the <literal>mysql</literal> database was
- passed as a separate argument. However, the same query could
- have been executed using <command>mysql -u root -p -e "SELECT
- User, Host FROM mysql.user"</command> from the shell prompt.
+ Note that the long form (<option>--execute</option>) must be
+ followed by an equals sign (<literal>=</literal>).
</para>
<para>
- Multiple SQL statements may be passed in this way, separated by
- semicolons:
+ In the preceding example, the name of the
+ <literal>mysql</literal> database was passed as a separate
+ argument. However, the same statement could have been executed
+ using this command, which specifies no default database:
</para>
<programlisting>
-shell> <userinput>mysql -u root -p --execute="SELECT Name FROM Country WHERE Name LIKE 'AU%';SELECT COUNT(*) FROM City" world</userinput>
-Enter password: <userinput>******</userinput>
-+-----------+
-| Name |
-+-----------+
-| Australia |
-| Austria |
-+-----------+
-+----------+
-| COUNT(*) |
-+----------+
-| 4079 |
-+----------+
+mysql> <userinput>mysql -u root -p --execute="SELECT User, Host FROM mysql.user"</userinput>
</programlisting>
<para>
- Note that the long form (<option>--execute</option>) must be
- followed by an equals sign (<literal>=</literal>).
+ Multiple SQL statements may be passed on the command line,
+ separated by semicolons:
</para>
+<programlisting>
+shell> <userinput>mysql -u root -p -e "SELECT VERSION();SELECT NOW()"</userinput>
+Enter password: <userinput>******</userinput>
++------------+
+| VERSION() |
++------------+
+| 4.1.17-log |
++------------+
++---------------------+
+| NOW() |
++---------------------+
+| 2006-01-05 21:19:04 |
++---------------------+
+</programlisting>
+
<para>
- The <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="multi-shutdown-restart"/>, for an example.
+ 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="multi-shutdown-restart"/>, for an example.
</para>
</section>
@@ -666,23 +668,21 @@
</indexterm>
<para>
- MySQL programs can read startup options from option files (also
- sometimes called configuration files). Option files provide a
- convenient way to specify commonly used options so that they
- need not be entered on the command line each time you run a
- program. Option file capability is available from MySQL 3.22 on.
+ Most MySQL programs can read startup options from option files
+ (also sometimes called configuration files). Option files
+ provide a convenient way to specify commonly used options so
+ that they need not be entered on the command line each time you
+ run a program. Option file capability is available from MySQL
+ 3.22 on.
</para>
<para>
- The following programs support option files:
- <command>myisamchk</command>, <command>myisampack</command>,
- <command>mysql</command>, <command>mysql.server</command>,
- <command>mysqladmin</command>, <command>mysqlbinlog</command>,
- <command>mysqlcc</command>, <command>mysqlcheck</command>,
- <command>mysqld_safe</command>, <command>mysqldump</command>,
- <command>mysqld</command>, <command>mysqlhotcopy</command>,
- <command>mysqlimport</command>, and
- <command>mysqlshow</command>.
+ To determine whether a program reads option files, invoke it
+ with the <option>--help</option> option
+ (<option>--verbose</option> and <option>--help</option> for
+ <command>mysqld</command> as of MySQL 4.1.1). If the program
+ reads option files, the help message indicates which files it
+ looks for and which option groups it recognizes.
</para>
<para>
@@ -1219,7 +1219,8 @@
<para>
In shell scripts, you can use the
<command>my_print_defaults</command> program to parse option
- files. The following example shows the output that
+ files and see what options would be used by a given program. The
+ following example shows the output that
<command>my_print_defaults</command> might produce when asked to
show the options found in the <literal>[client]</literal> and
<literal>[mysql]</literal> groups:
@@ -1235,21 +1236,21 @@
<para>
<emphasis role="bold">Note for developers</emphasis>: Option
file handling is implemented in the C client library simply by
- processing all matching options (that is, options in the
- appropriate group) before any command-line arguments. This works
- well for programs that use the last instance of an option that
- is specified multiple times. If you have a C or C++ program that
- handles multiply-specified options this way but that doesn't
- read option files, you need add only two lines to give it that
- capability. Check the source code of any of the standard MySQL
- clients to see how to do this.
+ processing all options in the appropriate group or groups before
+ any command-line arguments. This works well for programs that
+ use the last instance of an option that is specified multiple
+ times. If you have a C or C++ program that handles
+ multiply-specified options this way but that doesn't read option
+ files, you need add only two lines to give it that capability.
+ Check the source code of any of the standard MySQL clients to
+ see how to do this.
</para>
<para>
Several other language interfaces to MySQL are based on the C
client library, and some of them provide a way to access option
- file contents. These include Perl and Python. See the
- documentation for your preferred interface for details.
+ file contents. These include Perl and Python. For details, see
+ the documentation for your preferred interface.
</para>
</section>
@@ -1264,7 +1265,7 @@
<para>
To specify an option using an environment variable, set the
- variable using the syntax appropriate for your comment
+ variable using the syntax appropriate for your command
processor. For example, on Windows or NetWare, you can set the
<literal>USER</literal> variable to specify your MySQL account
name. To do so, use this syntax:
@@ -1295,8 +1296,7 @@
</para>
<para>
- For <command>csh</command> and <command>tcsh</command> there are
- similar issues. When running these shells, use
+ For <command>csh</command> and <command>tcsh</command>, use
<command>setenv</command> to make the shell variable available
to the environment:
</para>
@@ -1307,11 +1307,11 @@
<para>
The commands to set environment variables can be executed at
- your command prompt to take effect immediately. These settings
- persist until you log out. To have the settings take effect each
- time you log in, place the appropriate command or commands in a
- startup file that your command interpreter reads each time it
- starts. Typical startup files are
+ your command prompt to take effect immediately, but the settings
+ persist only until you log out. To have the settings take effect
+ each time you log in, place the appropriate command or commands
+ in a startup file that your command interpreter reads each time
+ it starts. Typical startup files are
<filename>AUTOEXEC.BAT</filename> for Windows,
<filename>.bash_profile</filename> for <command>bash</command>,
or <filename>.tcshrc</filename> for <command>tcsh</command>.
@@ -1373,7 +1373,7 @@
</para>
<para>
- In an option file, the variable setting is given without the
+ In an option file, variable settings are given without the
leading dashes:
</para>
@@ -1393,9 +1393,18 @@
<para>
If you like, underscores in a variable name can be specified as
- dashes.
+ dashes. The following option groups are equivalent. Both set the
+ size of the server's key buffer to 512MB:
</para>
+<programlisting>
+[mysqld]
+key_buffer_size=512M
+
+[mysqld]
+key-buffer-size=512M
+</programlisting>
+
<para>
Prior to MySQL 4.0.2, program variable names are not recognized
as option names. Instead, use the
@@ -1438,8 +1447,8 @@
</para>
<para>
- Some server variables can be set at runtime. For details, see
- <xref linkend="dynamic-system-variables"/>.
+ Many server system variables can also be set at runtime. For
+ details, see <xref linkend="dynamic-system-variables"/>.
</para>
</section>
Modified: trunk/refman-5.0/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.0/using-mysql-programs.xml 2006-01-06 04:02:23 UTC (rev 702)
+++ trunk/refman-5.0/using-mysql-programs.xml 2006-01-06 04:02:38 UTC (rev 703)
@@ -554,9 +554,9 @@
</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:
+ 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>
@@ -576,25 +576,24 @@
</para>
<para>
- Another option which may be occasionally useful with
- <command>mysql</command> is the <option>-e</option> or
- <option>--execute</option> option, which can be used to pass SQL
- statements to the server. The statements must be surrounded by
- (single or double) quotation marks. (However, if you wish to use
- quoted values within the query, you should use double quotes for
- the query, and single quotes for any quoted values within the
- query.) When this option is used, the statements are executed,
- and then <command>mysql</command> exits to the command shell
- immediately thereafter.
+ Another option that may occasionally be useful with
+ <command>mysql</command> is the <option>--execute</option> or
+ <option>-e</option> option, which can be used to pass SQL
+ statements to the server. The statements must be enclosed by
+ single or double quotation marks. If you wish to use quoted
+ values within a statement, you should use double quotes for the
+ statement, and single quotes for any quoted values within the
+ statement. When this option is used, <command>mysql</command>
+ executes the statements and exits.
</para>
<para>
- For example, you can use the following to obtain a list of user
- accounts:
+ For example, you can use the following command to obtain a list
+ of user accounts:
</para>
<programlisting>
-shell> <userinput>mysql -u root -p -e "SELECT User, Host FROM user" mysql</userinput>
+shell> <userinput>mysql -u root -p --execute="SELECT User, Host FROM user" mysql</userinput>
Enter password: <userinput>******</userinput>
+------+-----------+
| User | Host |
@@ -609,43 +608,46 @@
</programlisting>
<para>
- Note that the name of the <literal>mysql</literal> database was
- passed as a separate argument. However, the same query could
- have been executed using <command>mysql -u root -p -e "SELECT
- User, Host FROM mysql.user"</command> from the shell prompt.
+ Note that the long form (<option>--execute</option>) must be
+ followed by an equals sign (<literal>=</literal>).
</para>
<para>
- Multiple SQL statements may be passed in this way, separated by
- semicolons:
+ In the preceding example, the name of the
+ <literal>mysql</literal> database was passed as a separate
+ argument. However, the same statement could have been executed
+ using this command, which specifies no default database:
</para>
<programlisting>
-shell> <userinput>mysql -u root -p --execute="SELECT Name FROM Country WHERE Name LIKE 'AU%';SELECT COUNT(*) FROM City" world</userinput>
-Enter password: <userinput>******</userinput>
-+-----------+
-| Name |
-+-----------+
-| Australia |
-| Austria |
-+-----------+
-+----------+
-| COUNT(*) |
-+----------+
-| 4079 |
-+----------+
+mysql> <userinput>mysql -u root -p --execute="SELECT User, Host FROM mysql.user"</userinput>
</programlisting>
<para>
- Note that the long form (<option>--execute</option>) must be
- followed by an equals sign (<literal>=</literal>).
+ Multiple SQL statements may be passed on the command line,
+ separated by semicolons:
</para>
+<programlisting>
+shell> <userinput>mysql -u root -p -e "SELECT VERSION();SELECT NOW()"</userinput>
+Enter password: <userinput>******</userinput>
++------------+
+| VERSION() |
++------------+
+| 5.0.19-log |
++------------+
++---------------------+
+| NOW() |
++---------------------+
+| 2006-01-05 21:19:04 |
++---------------------+
+</programlisting>
+
<para>
- The <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="multi-shutdown-restart"/>, for an example.
+ 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="multi-shutdown-restart"/>, for an example.
</para>
</section>
@@ -673,23 +675,20 @@
</indexterm>
<para>
- MySQL programs can read startup options from option files (also
- sometimes called configuration files). Option files provide a
- convenient way to specify commonly used options so that they
- need not be entered on the command line each time you run a
- program.
+ Most MySQL programs can read startup options from option files
+ (also sometimes called configuration files). Option files
+ provide a convenient way to specify commonly used options so
+ that they need not be entered on the command line each time you
+ run a program.
</para>
<para>
- The following programs support option files:
- <command>myisamchk</command>, <command>myisampack</command>,
- <command>mysql</command>, <command>mysql.server</command>,
- <command>mysqladmin</command>, <command>mysqlbinlog</command>,
- <command>mysqlcc</command>, <command>mysqlcheck</command>,
- <command>mysqld_safe</command>, <command>mysqldump</command>,
- <command>mysqld</command>, <command>mysqlhotcopy</command>,
- <command>mysqlimport</command>, and
- <command>mysqlshow</command>.
+ To determine whether a program reads option files, invoke it
+ with the <option>--help</option> option
+ (<option>--verbose</option> and <option>--help</option> for
+ <command>mysqld</command>). If the program reads option files,
+ the help message indicates which files it looks for and which
+ option groups it recognizes.
</para>
<para>
@@ -1227,7 +1226,8 @@
<para>
In shell scripts, you can use the
<command>my_print_defaults</command> program to parse option
- files. The following example shows the output that
+ files and see what options would be used by a given program. The
+ following example shows the output that
<command>my_print_defaults</command> might produce when asked to
show the options found in the <literal>[client]</literal> and
<literal>[mysql]</literal> groups:
@@ -1243,21 +1243,21 @@
<para>
<emphasis role="bold">Note for developers</emphasis>: Option
file handling is implemented in the C client library simply by
- processing all matching options (that is, options in the
- appropriate group) before any command-line arguments. This works
- nicely for programs that use the last instance of an option that
- is specified multiple times. If you have a C or C++ program that
- handles multiply specified options this way but does not read
- option files, you need add only two lines to give it that
- capability. Check the source code of any of the standard MySQL
- clients to see how to do this.
+ processing all options in the appropriate group or groups before
+ any command-line arguments. This works well for programs that
+ use the last instance of an option that is specified multiple
+ times. If you have a C or C++ program that handles
+ multiply-specified options this way but that doesn't read option
+ files, you need add only two lines to give it that capability.
+ Check the source code of any of the standard MySQL clients to
+ see how to do this.
</para>
<para>
Several other language interfaces to MySQL are based on the C
client library, and some of them provide a way to access option
- file contents. These include Perl and Python. See the
- documentation for your preferred interface for details.
+ file contents. These include Perl and Python. For details, see
+ the documentation for your preferred interface.
</para>
</section>
@@ -1272,7 +1272,7 @@
<para>
To specify an option using an environment variable, set the
- variable using the syntax appropriate for your comment
+ variable using the syntax appropriate for your command
processor. For example, on Windows or NetWare, you can set the
<literal>USER</literal> variable to specify your MySQL account
name. To do so, use this syntax:
@@ -1303,8 +1303,7 @@
</para>
<para>
- For <command>csh</command> and <command>tcsh</command> there are
- similar issues. When running these shells, use
+ For <command>csh</command> and <command>tcsh</command>, use
<command>setenv</command> to make the shell variable available
to the environment:
</para>
@@ -1315,11 +1314,11 @@
<para>
The commands to set environment variables can be executed at
- your command prompt to take effect immediately. These settings
- persist until you log out. To have the settings take effect each
- time you log in, place the appropriate command or commands in a
- startup file that your command interpreter reads each time it
- starts. Typical startup files are
+ your command prompt to take effect immediately, but the settings
+ persist only until you log out. To have the settings take effect
+ each time you log in, place the appropriate command or commands
+ in a startup file that your command interpreter reads each time
+ it starts. Typical startup files are
<filename>AUTOEXEC.BAT</filename> for Windows,
<filename>.bash_profile</filename> for <command>bash</command>,
or <filename>.tcshrc</filename> for <command>tcsh</command>.
@@ -1381,7 +1380,7 @@
</para>
<para>
- In an option file, the variable setting is given without the
+ In an option file, variable settings are given without the
leading dashes:
</para>
@@ -1401,20 +1400,31 @@
<para>
If you like, underscores in a variable name can be specified as
- dashes.
+ dashes. The following option groups are equivalent. Both set the
+ size of the server's key buffer to 512MB:
</para>
+<programlisting>
+[mysqld]
+key_buffer_size=512M
+
+[mysqld]
+key-buffer-size=512M
+</programlisting>
+
<para>
- <emphasis role="bold">Note</emphasis>: The older syntax
- <option>--set-variable =
- <replaceable>option</replaceable>=<replaceable>value</replaceable></option>
- is still recognized in MySQL ¤t-series;, but is now
- deprecated.
+ <emphasis role="bold">Note</emphasis>: Before MySQL 4.0.2, the
+ only syntax for setting program variables was
+ <option>--set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
+ (or
+ <option>set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
+ in option files). This syntax still is recognized, but is
+ deprecated as of MySQL 4.0.2.
</para>
<para>
- Some server variables can be set at runtime. For details, see
- <xref linkend="dynamic-system-variables"/>.
+ Many server system variables can also be set at runtime. For
+ details, see <xref linkend="dynamic-system-variables"/>.
</para>
</section>
Modified: trunk/refman-5.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.1/using-mysql-programs.xml 2006-01-06 04:02:23 UTC (rev 702)
+++ trunk/refman-5.1/using-mysql-programs.xml 2006-01-06 04:02:38 UTC (rev 703)
@@ -554,9 +554,9 @@
</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:
+ 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>
@@ -576,25 +576,24 @@
</para>
<para>
- Another option which may be occasionally useful with
- <command>mysql</command> is the <option>-e</option> or
- <option>--execute</option> option, which can be used to pass SQL
- statements to the server. The statements must be surrounded by
- (single or double) quotation marks. (However, if you wish to use
- quoted values within the query, you should use double quotes for
- the query, and single quotes for any quoted values within the
- query.) When this option is used, the statements are executed,
- and then <command>mysql</command> exits to the command shell
- immediately thereafter.
+ Another option that may occasionally be useful with
+ <command>mysql</command> is the <option>--execute</option> or
+ <option>-e</option> option, which can be used to pass SQL
+ statements to the server. The statements must be enclosed by
+ single or double quotation marks. If you wish to use quoted
+ values within a statement, you should use double quotes for the
+ statement, and single quotes for any quoted values within the
+ statement. When this option is used, <command>mysql</command>
+ executes the statements and exits.
</para>
<para>
- For example, you can use the following to obtain a list of user
- accounts:
+ For example, you can use the following command to obtain a list
+ of user accounts:
</para>
<programlisting>
-shell> <userinput>mysql -u root -p -e "SELECT User, Host FROM user" mysql</userinput>
+shell> <userinput>mysql -u root -p --execute="SELECT User, Host FROM user" mysql</userinput>
Enter password: <userinput>******</userinput>
+------+-----------+
| User | Host |
@@ -609,43 +608,46 @@
</programlisting>
<para>
- Note that the name of the <literal>mysql</literal> database was
- passed as a separate argument. However, the same query could
- have been executed using <command>mysql -u root -p -e "SELECT
- User, Host FROM mysql.user"</command> from the shell prompt.
+ Note that the long form (<option>--execute</option>) must be
+ followed by an equals sign (<literal>=</literal>).
</para>
<para>
- Multiple SQL statements may be passed in this way, separated by
- semicolons:
+ In the preceding example, the name of the
+ <literal>mysql</literal> database was passed as a separate
+ argument. However, the same statement could have been executed
+ using this command, which specifies no default database:
</para>
<programlisting>
-shell> <userinput>mysql -u root -p --execute="SELECT Name FROM Country WHERE Name LIKE 'AU%';SELECT COUNT(*) FROM City" world</userinput>
-Enter password: <userinput>******</userinput>
-+-----------+
-| Name |
-+-----------+
-| Australia |
-| Austria |
-+-----------+
-+----------+
-| COUNT(*) |
-+----------+
-| 4079 |
-+----------+
+mysql> <userinput>mysql -u root -p --execute="SELECT User, Host FROM mysql.user"</userinput>
</programlisting>
<para>
- Note that the long form (<option>--execute</option>) must be
- followed by an equals sign (<literal>=</literal>).
+ Multiple SQL statements may be passed on the command line,
+ separated by semicolons:
</para>
+<programlisting>
+shell> <userinput>mysql -u root -p -e "SELECT VERSION();SELECT NOW()"</userinput>
+Enter password: <userinput>******</userinput>
++-----------------+
+| VERSION() |
++-----------------+
+| 5.1.5-alpha-log |
++-----------------+
++---------------------+
+| NOW() |
++---------------------+
+| 2006-01-05 21:19:04 |
++---------------------+
+</programlisting>
+
<para>
- The <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="multi-shutdown-restart"/>, for an example.
+ 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="multi-shutdown-restart"/>, for an example.
</para>
</section>
@@ -673,23 +675,20 @@
</indexterm>
<para>
- MySQL programs can read startup options from option files (also
- sometimes called configuration files). Option files provide a
- convenient way to specify commonly used options so that they
- need not be entered on the command line each time you run a
- program.
+ Most MySQL programs can read startup options from option files
+ (also sometimes called configuration files). Option files
+ provide a convenient way to specify commonly used options so
+ that they need not be entered on the command line each time you
+ run a program.
</para>
<para>
- The following programs support option files:
- <command>myisamchk</command>, <command>myisampack</command>,
- <command>mysql</command>, <command>mysql.server</command>,
- <command>mysqladmin</command>, <command>mysqlbinlog</command>,
- <command>mysqlcc</command>, <command>mysqlcheck</command>,
- <command>mysqld_safe</command>, <command>mysqldump</command>,
- <command>mysqld</command>, <command>mysqlhotcopy</command>,
- <command>mysqlimport</command>, and
- <command>mysqlshow</command>.
+ To determine whether a program reads option files, invoke it
+ with the <option>--help</option> option
+ (<option>--verbose</option> and <option>--help</option> for
+ <command>mysqld</command>). If the program reads option files,
+ the help message indicates which files it looks for and which
+ option groups it recognizes.
</para>
<para>
@@ -1226,7 +1225,8 @@
<para>
In shell scripts, you can use the
<command>my_print_defaults</command> program to parse option
- files. The following example shows the output that
+ files and see what options would be used by a given program. The
+ following example shows the output that
<command>my_print_defaults</command> might produce when asked to
show the options found in the <literal>[client]</literal> and
<literal>[mysql]</literal> groups:
@@ -1242,21 +1242,21 @@
<para>
<emphasis role="bold">Note for developers</emphasis>: Option
file handling is implemented in the C client library simply by
- processing all matching options (that is, options in the
- appropriate group) before any command-line arguments. This works
- nicely for programs that use the last instance of an option that
- is specified multiple times. If you have a C or C++ program that
- handles multiply specified options this way but does not read
- option files, you need add only two lines to give it that
- capability. Check the source code of any of the standard MySQL
- clients to see how to do this.
+ processing all options in the appropriate group or groups before
+ any command-line arguments. This works well for programs that
+ use the last instance of an option that is specified multiple
+ times. If you have a C or C++ program that handles
+ multiply-specified options this way but that doesn't read option
+ files, you need add only two lines to give it that capability.
+ Check the source code of any of the standard MySQL clients to
+ see how to do this.
</para>
<para>
Several other language interfaces to MySQL are based on the C
client library, and some of them provide a way to access option
- file contents. These include Perl and Python. See the
- documentation for your preferred interface for details.
+ file contents. These include Perl and Python. For details, see
+ the documentation for your preferred interface.
</para>
</section>
@@ -1271,7 +1271,7 @@
<para>
To specify an option using an environment variable, set the
- variable using the syntax appropriate for your comment
+ variable using the syntax appropriate for your command
processor. For example, on Windows or NetWare, you can set the
<literal>USER</literal> variable to specify your MySQL account
name. To do so, use this syntax:
@@ -1302,8 +1302,7 @@
</para>
<para>
- For <command>csh</command> and <command>tcsh</command> there are
- similar issues. When running these shells, use
+ For <command>csh</command> and <command>tcsh</command>, use
<command>setenv</command> to make the shell variable available
to the environment:
</para>
@@ -1314,11 +1313,11 @@
<para>
The commands to set environment variables can be executed at
- your command prompt to take effect immediately. These settings
- persist until you log out. To have the settings take effect each
- time you log in, place the appropriate command or commands in a
- startup file that your command interpreter reads each time it
- starts. Typical startup files are
+ your command prompt to take effect immediately, but the settings
+ persist only until you log out. To have the settings take effect
+ each time you log in, place the appropriate command or commands
+ in a startup file that your command interpreter reads each time
+ it starts. Typical startup files are
<filename>AUTOEXEC.BAT</filename> for Windows,
<filename>.bash_profile</filename> for <command>bash</command>,
or <filename>.tcshrc</filename> for <command>tcsh</command>.
@@ -1380,7 +1379,7 @@
</para>
<para>
- In an option file, the variable setting is given without the
+ In an option file, variable settings are given without the
leading dashes:
</para>
@@ -1400,24 +1399,31 @@
<para>
If you like, underscores in a variable name can be specified as
- dashes.
+ dashes. The following option groups are equivalent. Both set the
+ size of the server's key buffer to 512MB:
</para>
- <remark role="todo">
- [js] Next para: Still true in 5.1?
- </remark>
+<programlisting>
+[mysqld]
+key_buffer_size=512M
+[mysqld]
+key-buffer-size=512M
+</programlisting>
+
<para>
- <emphasis role="bold">Note</emphasis>: The older syntax
- <option>--set-variable =
- <replaceable>option</replaceable>=<replaceable>value</replaceable></option>
- is still recognized in MySQL ¤t-series;, but is now
- deprecated.
+ <emphasis role="bold">Note</emphasis>: Before MySQL 4.0.2, the
+ only syntax for setting program variables was
+ <option>--set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
+ (or
+ <option>set-variable=<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
+ in option files). This syntax still is recognized, but is
+ deprecated as of MySQL 4.0.2.
</para>
<para>
- Some server variables can be set at runtime. For details, see
- <xref linkend="dynamic-system-variables"/>.
+ Many server system variables can also be set at runtime. For
+ details, see <xref linkend="dynamic-system-variables"/>.
</para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r703 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 6 Jan |
