Below is the list of changes that have just been committed into a local
mysqldoc repository of jon. When jon 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.3473 05/09/04 17:39:55 jon@stripped +6 -0
using-mysql-programs.xml:
4.1 and 5.1 edits;
merge unwanted diffs.
Updated 4.1 and 5.1 Status.
refman/using-mysql-programs.xml
1.12 05/09/04 17:39:54 jon@stripped +141 -78
Merge unneeded diffs.
refman-5.1/using-mysql-programs.xml
1.9 05/09/04 17:39:54 jon@stripped +21 -20
Version-specific edits; merge unneeded diffs.
refman-5.1/Status
1.7 05/09/04 17:39:54 jon@stripped +1 -1
Updating...
refman-5.0/using-mysql-programs.xml
1.8 05/09/04 17:39:54 jon@stripped +15 -17
Merge unneeded diffs.
refman-4.1/using-mysql-programs.xml
1.13 05/09/04 17:39:54 jon@stripped +120 -74
Version-specific edits; merge unneeded diffs.
refman-4.1/Status
1.20 05/09/04 17:39:54 jon@stripped +1 -1
Updating...
# 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: jon
# Host: gigan.
# Root: /home/jon/bk/mysqldoc
--- 1.19/refman-4.1/Status 2005-09-03 19:48:41 +10:00
+++ 1.20/refman-4.1/Status 2005-09-04 17:39:54 +10:00
@@ -15,9 +15,9 @@
innodb
replication
tutorial
+ using-mysql-programs
- 4.1 chapters awaiting major edits:
- using-mysql-programs
error-handling
limits
restrictions
--- 1.6/refman-5.1/Status 2005-08-31 17:17:54 +10:00
+++ 1.7/refman-5.1/Status 2005-09-04 17:39:54 +10:00
@@ -1,6 +1,7 @@
- 5.1 chapters that have been edited:
mysql-apis
introduction
+ using-mysql-programs
- 5.1 chapters awaiting major edits:
preface
@@ -15,7 +16,6 @@
storage-engines
replication
installing
- using-mysql-programs
client-side-scripts
innodb
error-handling
--- 1.8/refman-5.1/using-mysql-programs.xml 2005-09-04 03:58:01 +10:00
+++ 1.9/refman-5.1/using-mysql-programs.xml 2005-09-04 17:39:54 +10:00
@@ -494,8 +494,8 @@
-->
<remark role="todo">
- also can specify unambigious prefix of option - but that's not
- 4.0.2 (?), so it should be mentioned earlier.
+ Also: can specify unambigious prefix of option - hm, but that's
+ not 4.0.2 (?), so it should be mentioned earlier.
</remark>
<para>
@@ -557,9 +557,6 @@
<option>--loose</option> prefix (or <literal>loose</literal> in
an option file). Versions of the program that do not recognize
the option issue a warning and ignore the option.
- <emphasis role="bold">Note</emphasis>: This strategy requires
- that versions involved be 4.0.2 or later, because earlier
- versions know nothing of the <option>--loose</option>
convention.
</para>
@@ -593,7 +590,7 @@
| jon | localhost |
| root | localhost |
+------+-----------+
-shell><userinput/>
+shell>
</programlisting>
<para>
@@ -790,8 +787,7 @@
<para>
<literal>MYSQL_HOME</literal> is an environment variable
containing the path to the directory in which the
- server-specific <literal>my.cnf</literal> file resides. (This
- was <literal>DATADIR</literal> prior to MySQL version 5.0.3.)
+ server-specific <filename>my.cnf</filename> file resides.
</para>
<para>
@@ -925,10 +921,11 @@
</listitem>
<!--
-
+ <listitem>
<remark role="note">Commented out. Probably should just be dropped?
/JS 2005-07-18</remark>
- <listitem><para>
+
+ <para>
<literal>set-variable =
<replaceable>var_name</replaceable>=<replaceable>value</replaceable></literal>
</para>
@@ -977,7 +974,7 @@
<para>
The <literal>[client]</literal> option group is read by all
- client programs (but <emphasis role="bold">not</emphasis> by
+ client programs (but <emphasis>not</emphasis> by
<command>mysqld</command>). This allows you to specify options
that apply to all clients. For example,
<literal>[client]</literal> is the perfect group to use to
@@ -1048,15 +1045,15 @@
<para>
<emphasis role="bold">Note</emphasis>: Currently, any files to
be found and included using the <literal>!includedir</literal>
- directive <emphasis role="bold">must</emphasis> have filenames
- ending in <filename>.cnf</filename>. On Windows, this directive
- also checks for files with a <filename>.ini</filename>
- extension.
+ directive on Unix operating systems <emphasis>must</emphasis> have filenames
+ ending in <filename>.cnf</filename>. On Windows,
+ this directive also checks for files with a
+ <filename>.ini</filename> extension (in addition to
+ <filename>.cnf</filename>).
</para>
<para>
- With MySQL 4.0.14 and later versions of MySQL, if you want to
- create option groups that should be read by one specific
+ If you want to create option groups that should be read by one specific
<command>mysqld</command> server release series only, you can do
this by using groups with names of
<literal>[mysqld-4.0]</literal>,
@@ -1207,7 +1204,7 @@
</para>
<remark role="todo">
- next few paragraphs probably should go into API chapter.
+ The next few paragraphs probably should go into the API chapter.
</remark>
<para>
@@ -1227,7 +1224,7 @@
</programlisting>
<para>
- <emphasis>Note for developers</emphasis>: Option file handling
+ <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
@@ -1386,11 +1383,15 @@
dashes.
</para>
+ <remark role="todo">
+ [js] Next para: Still true in 5.1?
+ </remark>
+
<para>
<emphasis role="bold">Note</emphasis>: The older syntax
<option>--set-variable =
<replaceable>option</replaceable>=<replaceable>value</replaceable></option>
- is still recognized in MySQL 5.0, but is now deprecated.
+ is still recognized in MySQL 5.1, but is now deprecated.
</para>
<para>
--- 1.12/refman-4.1/using-mysql-programs.xml 2005-09-04 03:28:05 +10:00
+++ 1.13/refman-4.1/using-mysql-programs.xml 2005-09-04 17:39:54 +10:00
@@ -6,13 +6,18 @@
%fixedchars.entities;
<!ENTITY % title.entities SYSTEM "refman-common/titles.ent">
%title.entities;
- <!ENTITY % versions.entities SYSTEM "versions.ent">
- %versions.entities;
]>
<chapter id="using-mysql-programs">
<title id="title-using-mysql-programs">&title-using-mysql-programs;</title>
+ <remark role="todo">
+ This chapter ought to be called something like "Using MySQL
+ Command-Line Programs" since we now have the GUI tools. I've updated
+ this section to include a brief description of and a link to the
+ documentation for each of them. /JS 2005-07-18
+ </remark>
+
<para>
This chapter provides a brief overview of the programs provided by
MySQL AB and discusses how to specify options when you run these
@@ -22,6 +27,51 @@
individual programs, including which options they recognize.
</para>
+ <para>
+ This chapter provides a brief overview of the command-line programs
+ provided by MySQL AB and discusses how to specify options when you
+ run these programs. Most programs have options that are specific to
+ their own operation, but the syntax for specifying options is
+ similar for all of them. Later chapters provide more detailed
+ descriptions of individual programs, including which options they
+ recognize.
+ </para>
+
+ <para>
+ MySQL AB also provide three GUI client programs for use with the
+ MySQL server:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <ulink url="http://dev.mysql.com/doc/administrator/en/">MySQL
+ Administrator</ulink>: This tool is used for administering MySQL
+ servers, databases, tables, and users.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://dev.mysql.com/doc/query-browser/en/">MySQL
+ Query Browser</ulink>: This graphical tool is provided by MySQL
+ AB for creating, executing, and optimizing queries on MySQL
+ databases.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://dev.mysql.com/doc/migration-toolkit/en/">MySQL
+ Migration Toolkit</ulink>: This tool is intended to help you
+ with migrating schemas and data from other relational database
+ management systems to MySQL.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<section id="program-overview">
<title id="title-program-overview">&title-program-overview;</title>
@@ -82,21 +132,13 @@
<listitem>
<para>
<command>mysql</command> is a command-line client for
- executing SQL statements interactively or in batch mode
- </para>
- </listitem>
-
- <listitem>
- <para>
- <command>mysqlcc</command> (MySQL Control Center) is an
- interactive graphical tool for executing SQL statements
- and administration
+ executing SQL statements interactively or in batch mode.
</para>
</listitem>
<listitem>
<para>
- <command>mysqladmin</command> is an administrative client
+ <command>mysqladmin</command> is an administrative client.
</para>
</listitem>
@@ -110,20 +152,20 @@
<listitem>
<para>
<command>mysqldump</command> and
- <command>mysqlhotcopy</command> make database backups
+ <command>mysqlhotcopy</command> make database backups.
</para>
</listitem>
<listitem>
<para>
- <command>mysqlimport</command> imports data files
+ <command>mysqlimport</command> imports data files.
</para>
</listitem>
<listitem>
<para>
<command>mysqlshow</command> displays information about
- databases and tables
+ databases and tables.
</para>
</listitem>
@@ -145,27 +187,27 @@
<listitem>
<para>
<command>myisamchk</command> performs table maintenance
- operations
+ operations.
</para>
</listitem>
<listitem>
<para>
<command>myisampack</command> produces compressed,
- read-only tables
+ read-only tables.
</para>
</listitem>
<listitem>
<para>
<command>mysqlbinlog</command> is a tool for processing
- binary log files
+ binary log files.
</para>
</listitem>
<listitem>
<para>
- <command>perror</command> displays error code meanings
+ <command>perror</command> displays error code meanings.
</para>
</listitem>
@@ -208,10 +250,10 @@
<title id="title-invoking-programs">&title-invoking-programs;</title>
<para>
- To invoke a MySQL program at the command line (that is, from your
- shell or command prompt), enter the program name followed by any
- options or other arguments needed to instruct the program what you
- want it to do. The following commands show some sample program
+ To invoke a MySQL program from the command line (that is, from
+ your shell or command prompt), enter the program name followed by
+ any options or other arguments needed to instruct the program what
+ you want it to do. The following commands show some sample program
invocations. <quote><literal>shell></literal></quote>
represents the prompt for your command interpreter; it is not part
of what you type. The particular prompt you see depends on your
@@ -453,10 +495,7 @@
</para>
<remark role="todo">
- also: can specify unambigious prefix of option - hm, but that's
- </remark>
-
- <remark>
+ Also: can specify unambigious prefix of option - hm, but that's
not 4.0.2 (?), so it should be mentioned earlier.
</remark>
@@ -522,7 +561,7 @@
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 do not recognize
- the option issue a warning and ignore it. This strategy requires
+ the option issue a warning and ignore the option. This strategy requires
that versions involved be 4.0.2 or later, because earlier
versions know nothing of the <option>--loose</option>
convention.
@@ -558,7 +597,7 @@
| jon | localhost |
| root | localhost |
+------+-----------+
-shell><userinput/>
+shell>
</programlisting>
<para>
@@ -646,6 +685,12 @@
</para>
<para>
+ <emphasis role="bold">Note</emphasis>: Option files used with
+ MySQL Cluster programs are covered in
+ <xref linkend="mysql-cluster-configuration"/>.
+ </para>
+
+ <para>
On Windows, MySQL programs read startup options from the
following files:
</para>
@@ -684,8 +729,8 @@
<para>
<replaceable>WINDIR</replaceable> represents the location of
your Windows directory. This is commonly
- <filename>C:\Windows</filename> or
- <filename>C:\WinNT</filename>. You can determine its exact
+ <filename>C:\WINDOWS</filename> or
+ <filename>C:\WINNT</filename>. You can determine its exact
location from the value of the <filename>WINDIR</filename>
environment variable using the following command:
</para>
@@ -725,7 +770,7 @@
<entry>Global options</entry>
</row>
<row>
- <entry><filename>$MYSQL_HOME/my.cnf</filename></entry>
+ <entry><filename>DATADIR/my.cnf</filename></entry>
<entry>Server-specific options</entry>
</row>
<row>
@@ -743,11 +788,9 @@
</informaltable>
<para>
- <literal>MYSQL_HOME</literal> is an environment variable
+ <literal>DATADIR</literal> is an environment variable
containing the path to the directory in which the
- server-specific <literal>my.cnf</literal> file resides. This
- used to be <replaceable>DATADIR</replaceable> prior to MySQL
- version 5.0.3.
+ server-specific <literal>my.cnf</literal> file resides.
</para>
<para>
@@ -830,7 +873,7 @@
<para>
Comment lines start with ‘<literal>#</literal>’
or ‘<literal>;</literal>’. As of MySQL 4.0.14, a
- ‘<literal>#</literal>’-comment can start in the
+ ‘<literal>#</literal>’ comment can start in the
middle of a line as well.
</para>
</listitem>
@@ -930,17 +973,18 @@
<para>
The <literal>[client]</literal> option group is read by all
- client programs (but not by <command>mysqld</command>). This
- allows you to specify options that apply to every client. For
- example, <literal>[client]</literal> is the perfect group to use
- to specify the password that you use to connect to the server.
- (But make sure that the option file is readable and writable
- only by yourself, so that other people cannot find out your
- password.) Be sure not to put an option in the
- <literal>[client]</literal> group unless it is recognized by
- <emphasis>all</emphasis> client programs that you use. Programs
- that do not understand the option quit after displaying an error
- message if you try to run them.
+ client programs (but <emphasis>not</emphasis> by
+ <command>mysqld</command>). This allows you to specify options
+ that apply to all clients. For example,
+ <literal>[client]</literal> is the perfect group to use to
+ specify the password that you use to connect to the server. (But
+ make sure that the option file is readable and writable only by
+ yourself, so that other people cannot find out your password.)
+ Be sure not to put an option in the <literal>[client]</literal> group unless it is recognized by
+ <emphasis>all</emphasis> client
+ programs that you use. Programs that do not understand the
+ option quit after displaying an error message if you try to run
+ them.
</para>
<para>
@@ -1001,17 +1045,18 @@
<para>
<emphasis role="bold">Note</emphasis>: Currently, any files to
be found and included using the <literal>!includedir</literal>
- directive <emphasis role="bold">must</emphasis> have filenames
- ending in <filename>.cnf</filename>. On Windows, this directive
- also checks for files with a <filename>.ini</filename>
- extension.
+ directive on Unix operating systems <emphasis>must</emphasis>
+ have filenames ending in <filename>.cnf</filename>. On Windows,
+ this directive also checks for files with a
+ <filename>.ini</filename> extension (in addition to
+ <filename>.cnf</filename>).
</para>
<para>
As of MySQL 4.0.14, if you want to create option groups that
- should be read only by one specific <command>mysqld</command>
- server release series, you can do this by using groups with
- names of <literal>[mysqld-4.0]</literal>,
+ should be read only by one specific <command>mysqld</command> server release series only, you can do
+ this by using groups with names of
+ <literal>[mysqld-4.0]</literal>,
<literal>[mysqld-4.1]</literal>, and so forth. The following
group indicates that the <option>--new</option> option should be
used only by MySQL servers with 4.0.x version numbers:
@@ -1087,14 +1132,14 @@
the <filename>support-files</filename> directory. If you have a
binary distribution, look in the
<filename>support-files</filename> directory under your MySQL
- installation directory (typically <filename>C:\mysql</filename>
- on Windows or <filename>/usr/local/mysql</filename> on Unix). On
- Windows the sample option files may also be located in the MySQL
- installation directory. Currently there are sample option files
- for small, medium, large, and very large systems. To experiment
- with one of these files, copy it to
- <filename>C:\my.cnf</filename> on Windows or to
- <filename>.my.cnf</filename> in your home directory on Unix.
+ installation directory. On Windows the sample option files may
+ also be located in the MySQL installation directory (see earlier
+ in this section or <xref linkend="installing"/> if you do not
+ know where this is). Currently there are sample option files for
+ small, medium, large, and very large systems. To experiment with
+ one of these files, copy it to <filename>C:\my.cnf</filename> on
+ Windows or to <filename>.my.cnf</filename> in your home
+ directory on Unix.
</para>
<para>
@@ -1167,7 +1212,7 @@
</para>
<remark role="todo">
- next few paragraphs probably should go into API chapter.
+ The next few paragraphs probably should go into the API chapter.
</remark>
<para>
@@ -1187,15 +1232,16 @@
</programlisting>
<para>
- Note for developers: 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 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.
+ <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.
</para>
<para>
@@ -1232,7 +1278,7 @@
to specify the TCP/IP port number using the
<literal>MYSQL_TCP_PORT</literal> variable. Typical syntax (such
as for <command>sh</command>, <literal>bash</literal>,
- <command>zsh</command>, etc.) is as follows:
+ <command>zsh</command>, and so on) is as follows:
</para>
<programlisting>
--- 1.11/refman/using-mysql-programs.xml 2005-09-04 03:28:20 +10:00
+++ 1.12/refman/using-mysql-programs.xml 2005-09-04 17:39:54 +10:00
@@ -11,6 +11,13 @@
<title id='title-using-mysql-programs'>&title-using-mysql-programs;</title>
+ <remark role="todo">
+ This chapter ought to be called something like "Using MySQL
+ Command-Line Programs" since we now have the GUI tools. I've updated
+ this section to include a brief description of and a link to the
+ documentation for each of them. /JS 2005-07-18
+ </remark>
+
<para>
This chapter provides a brief overview of the programs provided by
MySQL AB and discusses how to specify options when you run these
@@ -20,11 +27,58 @@
individual programs, including which options they recognize.
</para>
+ <para>
+ This chapter provides a brief overview of the command-line programs
+ provided by MySQL AB and discusses how to specify options when you
+ run these programs. Most programs have options that are specific to
+ their own operation, but the syntax for specifying options is
+ similar for all of them. Later chapters provide more detailed
+ descriptions of individual programs, including which options they
+ recognize.
+ </para>
+
+ <para>
+ MySQL AB also provide three GUI client programs for use with the
+ MySQL server:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <ulink url="http://dev.mysql.com/doc/administrator/en/">MySQL
+ Administrator</ulink>: This tool is used for administering MySQL
+ servers, databases, tables, and users.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://dev.mysql.com/doc/query-browser/en/">MySQL
+ Query Browser</ulink>: This graphical tool is provided by MySQL
+ AB for creating, executing, and optimizing queries on MySQL
+ databases.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://dev.mysql.com/doc/migration-toolkit/en/">MySQL
+ Migration Toolkit</ulink>: This tool is intended to help you
+ with migrating schemas and data from other relational database
+ management systems to MySQL.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<section id="program-overview">
<title id='title-program-overview'>&title-program-overview;</title>
-<!-- TODO: maybe mention (or xref) third-party programs -->
+ <remark role="todo">
+ maybe mention (or xref) third-party programs
+ </remark>
<para>
MySQL AB provides several types of programs:
@@ -78,21 +132,13 @@
<listitem>
<para>
<command>mysql</command> is a command-line client for
- executing SQL statements interactively or in batch mode
- </para>
- </listitem>
-
- <listitem>
- <para>
- <command>mysqlcc</command> (MySQL Control Center) is an
- interactive graphical tool for executing SQL statements
- and administration
+ executing SQL statements interactively or in batch mode.
</para>
</listitem>
<listitem>
<para>
- <command>mysqladmin</command> is an administrative client
+ <command>mysqladmin</command> is an administrative client.
</para>
</listitem>
@@ -106,20 +152,20 @@
<listitem>
<para>
<command>mysqldump</command> and
- <command>mysqlhotcopy</command> make database backups
+ <command>mysqlhotcopy</command> make database backups.
</para>
</listitem>
<listitem>
<para>
- <command>mysqlimport</command> imports data files
+ <command>mysqlimport</command> imports data files.
</para>
</listitem>
<listitem>
<para>
<command>mysqlshow</command> displays information about
- databases and tables
+ databases and tables.
</para>
</listitem>
@@ -141,38 +187,40 @@
<listitem>
<para>
<command>myisamchk</command> performs table maintenance
- operations
+ operations.
</para>
</listitem>
<listitem>
<para>
<command>myisampack</command> produces compressed,
- read-only tables
+ read-only tables.
</para>
</listitem>
<listitem>
<para>
<command>mysqlbinlog</command> is a tool for processing
- binary log files
+ binary log files.
</para>
</listitem>
<listitem>
<para>
- <command>perror</command> displays error code meanings
+ <command>perror</command> displays error code meanings.
</para>
</listitem>
</itemizedlist>
-<!-- TODO: this table is missing some programs (e.g., replace). -->
-
-<!--
- TODO: not all programs named here have their own entries in the
- following chapters (e.g., mysql_install_db)
--->
+ <remark role="todo">
+ this table is missing some programs (e.g., replace).
+ </remark>
+
+ <remark role="todo">
+ not all programs named here have their own entries in the
+ following chapters (e.g., mysql_install_db)
+ </remark>
<para>
<command>myisamchk</command> is discussed further in
@@ -202,10 +250,10 @@
<title id='title-invoking-programs'>&title-invoking-programs;</title>
<para>
- To invoke a MySQL program at the command line (that is, from your
- shell or command prompt), enter the program name followed by any
- options or other arguments needed to instruct the program what you
- want it to do. The following commands show some sample program
+ To invoke a MySQL program from the command line (that is, from
+ your shell or command prompt), enter the program name followed by
+ any options or other arguments needed to instruct the program what
+ you want it to do. The following commands show some sample program
invocations. <quote><literal>shell></literal></quote>
represents the prompt for your command interpreter; it is not part
of what you type. The particular prompt you see depends on your
@@ -446,9 +494,10 @@
discusses that topic further.
</para>
-<!-- TODO: also: can specify unambigious prefix of option - hm, but that's -->
-
-<!-- not 4.0.2 (?), so it should be mentioned earlier. -->
+ <remark role="todo">
+ Also: can specify unambigious prefix of option - hm, but that's
+ not 4.0.2 (?), so it should be mentioned earlier.
+ </remark>
<para>
Some options control behavior that can be turned on or off. For
@@ -512,7 +561,7 @@
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 do not recognize
- the option issue a warning and ignore it. This strategy requires
+ the option issue a warning and ignore the option. This strategy requires
that versions involved be 4.0.2 or later, because earlier
versions know nothing of the <option>--loose</option>
convention.
@@ -548,7 +597,7 @@
| jon | localhost |
| root | localhost |
+------+-----------+
-shell><userinput></userinput>
+shell>
</programlisting>
<para>
@@ -636,6 +685,12 @@
</para>
<para>
+ <emphasis role="bold">Note</emphasis>: Option files used with
+ MySQL Cluster programs are covered in
+ <xref linkend="mysql-cluster-configuration"/>.
+ </para>
+
+ <para>
On Windows, MySQL programs read startup options from the
following files:
</para>
@@ -674,8 +729,8 @@
<para>
<replaceable>WINDIR</replaceable> represents the location of
your Windows directory. This is commonly
- <filename>C:\Windows</filename> or
- <filename>C:\WinNT</filename>. You can determine its exact
+ <filename>C:\WINDOWS</filename> or
+ <filename>C:\WINNT</filename>. You can determine its exact
location from the value of the <filename>WINDIR</filename>
environment variable using the following command:
</para>
@@ -735,9 +790,9 @@
<para>
<literal>MYSQL_HOME</literal> is an environment variable
containing the path to the directory in which the
- server-specific <literal>my.cnf</literal> file resides. This
- used to be <replaceable>DATADIR</replaceable> prior to MySQL
- version 5.0.3.
+ server-specific <filename>my.cnf</filename> file resides. (This
+ was <literal>DATADIR</literal> prior to MySQL
+ version 5.0.3.)
</para>
<para>
@@ -820,7 +875,7 @@
<para>
Comment lines start with ‘<literal>#</literal>’
or ‘<literal>;</literal>’. As of MySQL 4.0.14, a
- ‘<literal>#</literal>’-comment can start in the
+ ‘<literal>#</literal>’ comment can start in the
middle of a line as well.
</para>
</listitem>
@@ -920,17 +975,18 @@
<para>
The <literal>[client]</literal> option group is read by all
- client programs (but not by <command>mysqld</command>). This
- allows you to specify options that apply to every client. For
- example, <literal>[client]</literal> is the perfect group to use
- to specify the password that you use to connect to the server.
- (But make sure that the option file is readable and writable
- only by yourself, so that other people cannot find out your
- password.) Be sure not to put an option in the
- <literal>[client]</literal> group unless it is recognized by
- <emphasis>all</emphasis> client programs that you use. Programs
- that do not understand the option quit after displaying an error
- message if you try to run them.
+ client programs (but <emphasis>not</emphasis> by
+ <command>mysqld</command>). This allows you to specify options
+ that apply to all clients. For example,
+ <literal>[client]</literal> is the perfect group to use to
+ specify the password that you use to connect to the server. (But
+ make sure that the option file is readable and writable only by
+ yourself, so that other people cannot find out your password.)
+ Be sure not to put an option in the <literal>[client]</literal>
+ group unless it is recognized by <emphasis>all</emphasis> client
+ programs that you use. Programs that do not understand the
+ option quit after displaying an error message if you try to run
+ them.
</para>
<para>
@@ -991,18 +1047,20 @@
<para>
<emphasis role="bold">Note</emphasis>: Currently, any files to
be found and included using the <literal>!includedir</literal>
- directive <emphasis role="bold">must</emphasis> have filenames
- ending in <filename>.cnf</filename>. On Windows, this directive
- also checks for files with a <filename>.ini</filename>
- extension.
+ directive on Unix operating systems <emphasis>must</emphasis>
+ have filenames ending in <filename>.cnf</filename>. On Windows,
+ this directive also checks for files with a
+ <filename>.ini</filename> extension (in addition to
+ <filename>.cnf</filename>).
</para>
<para>
As of MySQL 4.0.14, if you want to create option groups that
- should be read only by one specific <command>mysqld</command>
- server release series, you can do this by using groups with
- names of <literal>[mysqld-4.0]</literal>,
- <literal>[mysqld-4.1]</literal>, and so forth. The following
+ should be read only by one specific <command>mysqld</command> server release series only, you can do
+ this by using groups with names of
+ <literal>[mysqld-4.0]</literal>,
+ <literal>[mysqld-4.1]</literal>,
+ <literal>[mysqld-5.0]</literal>, and so forth. The following
group indicates that the <option>--new</option> option should be
used only by MySQL servers with 4.0.x version numbers:
</para>
@@ -1077,14 +1135,14 @@
the <filename>support-files</filename> directory. If you have a
binary distribution, look in the
<filename>support-files</filename> directory under your MySQL
- installation directory (typically <filename>C:\mysql</filename>
- on Windows or <filename>/usr/local/mysql</filename> on Unix). On
- Windows the sample option files may also be located in the MySQL
- installation directory. Currently there are sample option files
- for small, medium, large, and very large systems. To experiment
- with one of these files, copy it to
- <filename>C:\my.cnf</filename> on Windows or to
- <filename>.my.cnf</filename> in your home directory on Unix.
+ installation directory. On Windows the sample option files may
+ also be located in the MySQL installation directory (see earlier
+ in this section or <xref linkend="installing"/> if you do not
+ know where this is). Currently there are sample option files for
+ small, medium, large, and very large systems. To experiment with
+ one of these files, copy it to <filename>C:\my.cnf</filename> on
+ Windows or to <filename>.my.cnf</filename> in your home
+ directory on Unix.
</para>
<para>
@@ -1156,7 +1214,9 @@
<option>--defaults-extra-file</option>.
</para>
-<!-- TODO: next few paragraphs probably should go into API chapter. -->
+ <remark role="todo">
+ The next few paragraphs probably should go into the API chapter.
+ </remark>
<para>
In shell scripts, you can use the
@@ -1175,15 +1235,16 @@
</programlisting>
<para>
- Note for developers: 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 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.
+ <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.
</para>
<para>
@@ -1220,7 +1281,7 @@
to specify the TCP/IP port number using the
<literal>MYSQL_TCP_PORT</literal> variable. Typical syntax (such
as for <command>sh</command>, <literal>bash</literal>,
- <command>zsh</command>, etc.) is as follows:
+ <command>zsh</command>, and so on) is as follows:
</para>
<programlisting>
@@ -1280,7 +1341,9 @@
<primary>setting program variables</primary>
</indexterm>
-<!-- TODO: check whether program variables can be set by unique prefix. -->
+ <remark role="todo">
+ check whether program variables can be set by unique prefix.
+ </remark>
<para>
Many MySQL programs have internal variables that can be set at
--- 1.7/refman-5.0/using-mysql-programs.xml 2005-09-04 03:28:09 +10:00
+++ 1.8/refman-5.0/using-mysql-programs.xml 2005-09-04 17:39:54 +10:00
@@ -494,8 +494,8 @@
-->
<remark role="todo">
- also can specify unambigious prefix of option - but that's not
- 4.0.2 (?), so it should be mentioned earlier.
+ Also: can specify unambigious prefix of option - hm, but that's
+ not 4.0.2 (?), so it should be mentioned earlier.
</remark>
<para>
@@ -557,9 +557,6 @@
<option>--loose</option> prefix (or <literal>loose</literal> in
an option file). Versions of the program that do not recognize
the option issue a warning and ignore the option.
- <emphasis role="bold">Note</emphasis>: This strategy requires
- that versions involved be 4.0.2 or later, because earlier
- versions know nothing of the <option>--loose</option>
convention.
</para>
@@ -593,7 +590,7 @@
| jon | localhost |
| root | localhost |
+------+-----------+
-shell><userinput/>
+shell>
</programlisting>
<para>
@@ -790,8 +787,9 @@
<para>
<literal>MYSQL_HOME</literal> is an environment variable
containing the path to the directory in which the
- server-specific <literal>my.cnf</literal> file resides. (This
- was <literal>DATADIR</literal> prior to MySQL version 5.0.3.)
+ server-specific <filename>my.cnf</filename> file resides. (This
+ was <literal>DATADIR</literal> prior to MySQL
+ version 5.0.3.)
</para>
<para>
@@ -978,7 +976,7 @@
<para>
The <literal>[client]</literal> option group is read by all
- client programs (but <emphasis role="bold">not</emphasis> by
+ client programs (but <emphasis>not</emphasis> by
<command>mysqld</command>). This allows you to specify options
that apply to all clients. For example,
<literal>[client]</literal> is the perfect group to use to
@@ -1049,15 +1047,15 @@
<para>
<emphasis role="bold">Note</emphasis>: Currently, any files to
be found and included using the <literal>!includedir</literal>
- directive <emphasis role="bold">must</emphasis> have filenames
- ending in <filename>.cnf</filename>. On Windows, this directive
- also checks for files with a <filename>.ini</filename>
- extension.
+ directive on Unix operating systems <emphasis>must</emphasis> have filenames
+ ending in <filename>.cnf</filename>. On Windows,
+ this directive also checks for files with a
+ <filename>.ini</filename> extension (in addition to
+ <filename>.cnf</filename>).
</para>
<para>
- With MySQL 4.0.14 and later versions of MySQL, if you want to
- create option groups that should be read by one specific
+ If you want to create option groups that should be read by one specific
<command>mysqld</command> server release series only, you can do
this by using groups with names of
<literal>[mysqld-4.0]</literal>,
@@ -1208,7 +1206,7 @@
</para>
<remark role="todo">
- next few paragraphs probably should go into API chapter.
+ The next few paragraphs probably should go into the API chapter.
</remark>
<para>
@@ -1228,7 +1226,7 @@
</programlisting>
<para>
- <emphasis>Note for developers</emphasis>: Option file handling
+ <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
| Thread |
|---|
| • bk commit - mysqldoc@docsrva tree (jon:1.3473) | jon | 4 Sep |
