List:Commits« Previous MessageNext Message »
From:paul Date:January 6 2006 4:02am
Subject:svn commit - mysqldoc@docsrva: r701 - in trunk: . refman-4.1 refman-5.0 refman-5.1
View as plain text  
Author: paul
Date: 2006-01-06 05:02:03 +0100 (Fri, 06 Jan 2006)
New Revision: 701

Log:
 r5903@frost:  paul | 2006-01-05 21:05:51 -0600
 General revisions.


Modified:
   trunk/
   trunk/refman-4.1/database-administration.xml
   trunk/refman-4.1/using-mysql-programs.xml
   trunk/refman-5.0/database-administration.xml
   trunk/refman-5.0/using-mysql-programs.xml
   trunk/refman-5.1/database-administration.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:5902
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1933
   + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:5903
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1933

Modified: trunk/refman-4.1/database-administration.xml
===================================================================
--- trunk/refman-4.1/database-administration.xml	2006-01-06 04:01:37 UTC (rev 700)
+++ trunk/refman-4.1/database-administration.xml	2006-01-06 04:02:03 UTC (rev 701)
@@ -4139,10 +4139,15 @@
         </para>
 
         <para>
-          When setting a variable using a startup option, variable
-          values can be given with a suffix of <literal>K</literal>,
-          <literal>M</literal>, or <literal>G</literal> to indicate
-          kilobytes, megabytes, or gigabytes, respectively. For example,
+When you use a startup option to set a variable that takes a numeric value,
+        the value can be given with a suffix of
+        <literal>K</literal>, <literal>M</literal>, or
+        <literal>G</literal> (either uppercase or lowercase) to indicate
+        a multiplier of 1024, 1024<superscript>2</superscript> or
+        1024<superscript>3</superscript>. For example, when used to set
+        <literal>key_buffer_size</literal>, the suffixes indicate
+        units of kilobytes, megabytes, or gigabygtes.
+           Thus,
           the following command starts the server with a key buffer size
           of 16 megabytes:
         </para>

Modified: trunk/refman-4.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-4.1/using-mysql-programs.xml	2006-01-06 04:01:37 UTC (rev 700)
+++ trunk/refman-4.1/using-mysql-programs.xml	2006-01-06 04:02:03 UTC (rev 701)
@@ -15,48 +15,51 @@
 
   <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
+    provided by MySQL AB and discusses the general syntax for specifying
+    options when you run these programs. Most programs have options that
+    are specific to their own operation, but the option syntax 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:
+    MySQL AB also provides three GUI client programs for use with MySQL
+    Server:
   </para>
 
   <itemizedlist>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;administrator/en/">MySQL
-        Administrator</ulink>: This tool is used for administering MySQL
-        servers, databases, tables, and users.
+        MySQL Administrator: This tool is used for administering MySQL
+        servers, databases, tables, and user accounts.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;query-browser/en/">MySQL Query
-        Browser</ulink>: This graphical tool is provided by MySQL AB for
-        creating, executing, and optimizing queries on MySQL databases.
+        MySQL Query Browser: This graphical tool is provided by MySQL AB
+        for creating, executing, and optimizing queries on MySQL
+        databases.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;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.
+        MySQL Migration Toolkit: This tool helps you migrate schemas and
+        data from other relational database management systems for use
+        with MySQL.
       </para>
     </listitem>
 
   </itemizedlist>
 
+  <para>
+    These GUI programs each have their own manuals that you can access
+    at <ulink url="&base-url-docs;"/>.
+  </para>
+
   <section id="program-overview">
 
     <title>&title-program-overview;</title>
@@ -80,7 +83,7 @@
 
           <listitem>
             <para>
-              <command>mysqld</command> is the MySQL server
+              <command>mysqld</command> is the MySQL server.
             </para>
           </listitem>
 
@@ -88,22 +91,23 @@
             <para>
               <command>mysqld_safe</command>,
               <command>mysql.server</command>, and
-              <command>mysqld_multi</command> are server startup scripts
+              <command>mysqld_multi</command> are server startup
+              scripts.
             </para>
           </listitem>
 
           <listitem>
             <para>
               <command>mysql_install_db</command> initializes the data
-              directory and the initial databases
+              directory and the initial databases.
             </para>
           </listitem>
 
         </itemizedlist>
 
         <para>
-          These programs are discussed further in
-          <xref linkend="database-administration"/>.
+          <xref linkend="database-administration"/>, discusses these
+          programs further
         </para>
       </listitem>
 
@@ -130,7 +134,7 @@
           <listitem>
             <para>
               <command>mysqlcheck</command> performs table maintenance
-              operations
+              operations.
             </para>
           </listitem>
 
@@ -157,8 +161,8 @@
         </itemizedlist>
 
         <para>
-          These programs are discussed further in
-          <xref linkend="client-side-scripts"/>.
+          <xref linkend="client-side-scripts"/>, discusses these
+          programs further
         </para>
       </listitem>
 
@@ -192,7 +196,8 @@
 
           <listitem>
             <para>
-              <command>perror</command> displays error code meanings.
+              <command>perror</command> displays the meaning of error
+              codes.
             </para>
           </listitem>
 
@@ -208,9 +213,10 @@
         </remark>
 
         <para>
-          <command>myisamchk</command> is discussed further in
-          <xref linkend="database-administration"/>. The other programs
-          are further in <xref linkend="client-side-scripts"/>.
+          <xref linkend="database-administration"/>, discusses
+          <command>myisamchk</command>.
+          <xref linkend="client-side-scripts"/>, discusses the other
+          programs.
         </para>
       </listitem>
 
@@ -221,10 +227,11 @@
       those programs that are platform-specific. (For example, the
       server startup scripts are not used on Windows.) The exception is
       that RPM distributions are more specialized. There is one RPM for
-      the server, another for the client programs, and so forth. If you
+      the server, another for client programs, and so forth. If you
       appear to be missing one or more programs, see
       <xref linkend="installing"/>, for information on types of
-      distributions and what they contain. It may be that you need to
+      distributions and what they contain. It may be that you have a
+      distribution that does not include all programs and you need to
       install something else.
     </para>
 
@@ -245,30 +252,32 @@
       command interpreter. Typical prompts are <literal>$</literal> for
       <command>sh</command> or <command>bash</command>,
       <literal>%</literal> for <command>csh</command> or
-      <command>tcsh</command>, and <literal>C:\&gt;</literal> for
+      <command>tcsh</command>, and <literal>C:\&gt;</literal> for the
       Windows <command>command.com</command> or
-      <command>cmd.exe</command>.
+      <command>cmd.exe</command> command interpreters.
     </para>
 
 <programlisting>
-shell&gt; <userinput>mysql test</userinput>
+shell&gt; <userinput>mysql -u root test</userinput>
 shell&gt; <userinput>mysqladmin extended-status variables</userinput>
 shell&gt; <userinput>mysqlshow --help</userinput>
 shell&gt; <userinput>mysqldump --user=root personnel</userinput>
 </programlisting>
 
     <para>
-      Arguments that begin with a dash are option arguments. They
+      Arguments that begin with a single or double dash
+      (&lsquo;<literal>-</literal>&rsquo;,
+      &lsquo;<literal>--</literal>&rsquo;) are option arguments. Options
       typically specify the type of connection a program should make to
-      the server or affect its operational mode. Options have a syntax
-      that is described in <xref linkend="program-options"/>.
+      the server or affect its operational mode. Option syntax is
+      described in <xref linkend="program-options"/>.
     </para>
 
     <para>
       Non-option arguments (arguments with no leading dash) provide
       additional information to the program. For example, the
       <command>mysql</command> program interprets the first non-option
-      argument as a database name, so the command <literal>mysql
+      argument as a database name, so the command <literal>mysql -u root
       test</literal> indicates that you want to use the
       <literal>test</literal> database.
     </para>
@@ -281,13 +290,14 @@
 
     <para>
       Some options are common to a number of programs. The most common
-      of these are the <option>--host</option>, <option>--user</option>,
-      and <option>--password</option> options that specify connection
-      parameters. They indicate the host where the MySQL server is
-      running, and the username and password of your MySQL account. All
-      MySQL client programs understand these options; they allow you to
-      specify which server to connect to and the account to use on that
-      server.
+      of these are the <option>--host</option> (or <option>-h</option>),
+      <option>--user</option> (or <option>-u</option>), and
+      <option>--password</option> (or <option>-p</option>) options that
+      specify connection parameters. They indicate the host where the
+      MySQL server is running, and the username and password of your
+      MySQL account. All MySQL client programs understand these options;
+      they allow you to specify which server to connect to and the
+      account to use on that server.
     </para>
 
     <indexterm>
@@ -308,14 +318,19 @@
       <filename>bin</filename> directory. To make it more convenient to
       use MySQL, you can add the pathname of the
       <filename>bin</filename> directory to your <literal>PATH</literal>
-      environment variable setting. Then to run a program you need only
-      type its name, not its entire pathname.
+      environment variable setting. That enables you to run a program by
+      typing only its name, not its entire pathname. For example, if
+      <command>mysql</command> is installed in
+      <filename>/usr/local/mysql/bin</filename>, you'll be able to run
+      it by invoking it as <command>mysql</command>; it will not be
+      necessary to invoke it as
+      <command>/usr/local/mysql/bin/mysql</command>.
     </para>
 
     <para>
       Consult the documentation for your command interpreter for
-      instructions on setting your <literal>PATH</literal>. The syntax
-      for setting environment variables is interpreter-specific.
+      instructions on setting your <literal>PATH</literal> variable. The
+      syntax for setting environment variables is interpreter-specific.
     </para>
 
   </section>
@@ -325,56 +340,58 @@
     <title>&title-program-options;</title>
 
     <para>
-      You can provide options for MySQL programs in several ways:
+      There are several ways to specify options for MySQL programs:
     </para>
 
     <itemizedlist>
 
       <listitem>
         <para>
-          On the command line following the program name. This is most
-          common for options that apply to a specific invocation of the
-          program.
+          List the options on the command line following the program
+          name. This is most common for options that apply to a specific
+          invocation of the program.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          In an option file that the program reads when it starts. This
-          is common for options that you want the program to use each
-          time it runs.
+          List the options in an option file that the program reads when
+          it starts. This is common for options that you want the
+          program to use each time it runs.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          In environment variables. These are useful for options that
-          you want to apply each time the program runs, although in
-          practice option files are used more commonly for this purpose.
-          (<xref linkend="multiple-unix-servers"/>, discusses one
+          List the options in environment variables. This method is
+          useful for options that you want to apply each time the
+          program runs. In practice, option files are used more commonly
+          for this purpose. However,
+          <xref linkend="multiple-unix-servers"/>, discusses one
           situation in which environment variables can be very helpful.
           It describes a handy technique that uses such variables to
           specify the TCP/IP port number and Unix socket file for both
-          the server and client programs.)
+          the server and client programs.
         </para>
       </listitem>
 
     </itemizedlist>
 
     <para>
-      MySQL programs determine which options are given first by
-      examining environment variables, then option files, and then the
-      command line. If an option is specified multiple times, the last
-      occurrence takes precedence. This means that environment variables
-      have the lowest precedence and command-line options the highest.
+      To determine which options are given, MySQL programs first by
+      examining environment variables, then by reading option files, and
+      then by checking the command line. If an option is specified
+      multiple times, the last occurrence takes precedence. This means
+      that environment variables have the lowest precedence and
+      command-line options the highest.
     </para>
 
     <para>
       You can take advantage of the way that MySQL programs process
-      options by specifying the default values for a program's options
-      in an option file. Then you need not type them each time you run
-      the program, but can override the defaults if necessary by using
-      command-line options.
+      options by specifying default values for a program's options in an
+      option file. That enables you to avoid typing them each time you
+      run the program, but also allows you to override the defaults if
+      necessary by using command-line options.
     </para>
 
     <section id="command-line-options">
@@ -431,8 +448,8 @@
             name and the value by an &lsquo;<literal>=</literal>&rsquo;
             sign. For a short option that takes a value, the option
             value can immediately follow the option letter, or there can
-            be a space between. (<option>-hlocalhost</option> and
-            <option>-h localhost</option> are equivalent.) An exception
+            be a space between: <option>-hlocalhost</option> and
+            <option>-h localhost</option> are equivalent. An exception
             to this rule is the option for specifying your MySQL
             password. This option can be given in long form as
             <option>--password=<replaceable>pass_val</replaceable></option>
@@ -1346,10 +1363,14 @@
 
       <para>
         The first command specifies the value in bytes. The second
-        specifies the value in megabytes. Variable values can have a
-        suffix of <literal>K</literal>, <literal>M</literal>, or
+        specifies the value in megabytes. For variables that take a
+        numeric value, the value can be given with a suffix of
+        <literal>K</literal>, <literal>M</literal>, or
         <literal>G</literal> (either uppercase or lowercase) to indicate
-        units of kilobytes, megabytes, or gigabytes.
+        a multiplier of 1024, 1024<superscript>2</superscript> or
+        1024<superscript>3</superscript>. (For example, when used to set
+        <literal>max_allowed_packet</literal>, the suffixes indicate
+        units of kilobytes, megabytes, or gigabygtes.)
       </para>
 
       <para>

Modified: trunk/refman-5.0/database-administration.xml
===================================================================
--- trunk/refman-5.0/database-administration.xml	2006-01-06 04:01:37 UTC (rev 700)
+++ trunk/refman-5.0/database-administration.xml	2006-01-06 04:02:03 UTC (rev 701)
@@ -5222,10 +5222,15 @@
         </para>
 
         <para>
-          When setting a variable using a startup option, variable
-          values can be given with a suffix of <literal>K</literal>,
-          <literal>M</literal>, or <literal>G</literal> to indicate
-          kilobytes, megabytes, or gigabytes, respectively. For example,
+When you use a startup option to set a variable that takes a numeric value,
+        the value can be given with a suffix of
+        <literal>K</literal>, <literal>M</literal>, or
+        <literal>G</literal> (either uppercase or lowercase) to indicate
+        a multiplier of 1024, 1024<superscript>2</superscript> or
+        1024<superscript>3</superscript>. For example, when used to set
+        <literal>key_buffer_size</literal>, the suffixes indicate
+        units of kilobytes, megabytes, or gigabygtes.
+           Thus,
           the following command starts the server with a key buffer size
           of 16 megabytes:
         </para>

Modified: trunk/refman-5.0/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.0/using-mysql-programs.xml	2006-01-06 04:01:37 UTC (rev 700)
+++ trunk/refman-5.0/using-mysql-programs.xml	2006-01-06 04:02:03 UTC (rev 701)
@@ -15,48 +15,51 @@
 
   <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
+    provided by MySQL AB and discusses the general syntax for specifying
+    options when you run these programs. Most programs have options that
+    are specific to their own operation, but the option syntax 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:
+    MySQL AB also provides three GUI client programs for use with MySQL
+    Server:
   </para>
 
   <itemizedlist>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;administrator/en/">MySQL
-        Administrator</ulink>: This tool is used for administering MySQL
-        servers, databases, tables, and users.
+        MySQL Administrator: This tool is used for administering MySQL
+        servers, databases, tables, and user accounts.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;query-browser/en/">MySQL Query
-        Browser</ulink>: This graphical tool is provided by MySQL AB for
-        creating, executing, and optimizing queries on MySQL databases.
+        MySQL Query Browser: This graphical tool is provided by MySQL AB
+        for creating, executing, and optimizing queries on MySQL
+        databases.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;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.
+        MySQL Migration Toolkit: This tool helps you migrate schemas and
+        data from other relational database management systems for use
+        with MySQL.
       </para>
     </listitem>
 
   </itemizedlist>
 
+  <para>
+    These GUI programs each have their own manuals that you can access
+    at <ulink url="&base-url-docs;"/>.
+  </para>
+
   <section id="program-overview">
 
     <title>&title-program-overview;</title>
@@ -80,7 +83,7 @@
 
           <listitem>
             <para>
-              <command>mysqld</command> is the MySQL server
+              <command>mysqld</command> is the MySQL server.
             </para>
           </listitem>
 
@@ -88,22 +91,30 @@
             <para>
               <command>mysqld_safe</command>,
               <command>mysql.server</command>, and
-              <command>mysqld_multi</command> are server startup scripts
+              <command>mysqld_multi</command> are server startup
+              scripts.
             </para>
           </listitem>
 
           <listitem>
             <para>
               <command>mysql_install_db</command> initializes the data
-              directory and the initial databases
+              directory and the initial databases.
             </para>
           </listitem>
 
+          <listitem>
+            <para>
+              MySQL Instance Manager monitors and manages MySQL Server
+              instances.
+            </para>
+          </listitem>
+
         </itemizedlist>
 
         <para>
-          These programs are discussed further in
-          <xref linkend="database-administration"/>.
+          <xref linkend="database-administration"/>, discusses these
+          programs further
         </para>
       </listitem>
 
@@ -130,7 +141,7 @@
           <listitem>
             <para>
               <command>mysqlcheck</command> performs table maintenance
-              operations
+              operations.
             </para>
           </listitem>
 
@@ -157,8 +168,8 @@
         </itemizedlist>
 
         <para>
-          These programs are discussed further in
-          <xref linkend="client-side-scripts"/>.
+          <xref linkend="client-side-scripts"/>, discusses these
+          programs further
         </para>
       </listitem>
 
@@ -192,7 +203,8 @@
 
           <listitem>
             <para>
-              <command>perror</command> displays error code meanings.
+              <command>perror</command> displays the meaning of error
+              codes.
             </para>
           </listitem>
 
@@ -208,9 +220,10 @@
         </remark>
 
         <para>
-          <command>myisamchk</command> is discussed further in
-          <xref linkend="database-administration"/>. The other programs
-          are further in <xref linkend="client-side-scripts"/>.
+          <xref linkend="database-administration"/>, discusses
+          <command>myisamchk</command>.
+          <xref linkend="client-side-scripts"/>, discusses the other
+          programs.
         </para>
       </listitem>
 
@@ -221,10 +234,11 @@
       those programs that are platform-specific. (For example, the
       server startup scripts are not used on Windows.) The exception is
       that RPM distributions are more specialized. There is one RPM for
-      the server, another for the client programs, and so forth. If you
+      the server, another for client programs, and so forth. If you
       appear to be missing one or more programs, see
       <xref linkend="installing"/>, for information on types of
-      distributions and what they contain. It may be that you need to
+      distributions and what they contain. It may be that you have a
+      distribution that does not include all programs and you need to
       install something else.
     </para>
 
@@ -245,30 +259,32 @@
       command interpreter. Typical prompts are <literal>$</literal> for
       <command>sh</command> or <command>bash</command>,
       <literal>%</literal> for <command>csh</command> or
-      <command>tcsh</command>, and <literal>C:\&gt;</literal> for
+      <command>tcsh</command>, and <literal>C:\&gt;</literal> for the
       Windows <command>command.com</command> or
-      <command>cmd.exe</command>.
+      <command>cmd.exe</command> command interpreters.
     </para>
 
 <programlisting>
-shell&gt; <userinput>mysql test</userinput>
+shell&gt; <userinput>mysql -u root test</userinput>
 shell&gt; <userinput>mysqladmin extended-status variables</userinput>
 shell&gt; <userinput>mysqlshow --help</userinput>
 shell&gt; <userinput>mysqldump --user=root personnel</userinput>
 </programlisting>
 
     <para>
-      Arguments that begin with a dash are option arguments. They
+      Arguments that begin with a single or double dash
+      (&lsquo;<literal>-</literal>&rsquo;,
+      &lsquo;<literal>--</literal>&rsquo;) are option arguments. Options
       typically specify the type of connection a program should make to
-      the server or affect its operational mode. Options have a syntax
-      that is described in <xref linkend="program-options"/>.
+      the server or affect its operational mode. Option syntax is
+      described in <xref linkend="program-options"/>.
     </para>
 
     <para>
       Non-option arguments (arguments with no leading dash) provide
       additional information to the program. For example, the
       <command>mysql</command> program interprets the first non-option
-      argument as a database name, so the command <literal>mysql
+      argument as a database name, so the command <literal>mysql -u root
       test</literal> indicates that you want to use the
       <literal>test</literal> database.
     </para>
@@ -281,13 +297,14 @@
 
     <para>
       Some options are common to a number of programs. The most common
-      of these are the <option>--host</option>, <option>--user</option>,
-      and <option>--password</option> options that specify connection
-      parameters. They indicate the host where the MySQL server is
-      running, and the username and password of your MySQL account. All
-      MySQL client programs understand these options; they allow you to
-      specify which server to connect to and the account to use on that
-      server.
+      of these are the <option>--host</option> (or <option>-h</option>),
+      <option>--user</option> (or <option>-u</option>), and
+      <option>--password</option> (or <option>-p</option>) options that
+      specify connection parameters. They indicate the host where the
+      MySQL server is running, and the username and password of your
+      MySQL account. All MySQL client programs understand these options;
+      they allow you to specify which server to connect to and the
+      account to use on that server.
     </para>
 
     <indexterm>
@@ -308,14 +325,19 @@
       <filename>bin</filename> directory. To make it more convenient to
       use MySQL, you can add the pathname of the
       <filename>bin</filename> directory to your <literal>PATH</literal>
-      environment variable setting. Then to run a program you need only
-      type its name, not its entire pathname.
+      environment variable setting. That enables you to run a program by
+      typing only its name, not its entire pathname. For example, if
+      <command>mysql</command> is installed in
+      <filename>/usr/local/mysql/bin</filename>, you'll be able to run
+      it by invoking it as <command>mysql</command>; it will not be
+      necessary to invoke it as
+      <command>/usr/local/mysql/bin/mysql</command>.
     </para>
 
     <para>
       Consult the documentation for your command interpreter for
-      instructions on setting your <literal>PATH</literal>. The syntax
-      for setting environment variables is interpreter-specific.
+      instructions on setting your <literal>PATH</literal> variable. The
+      syntax for setting environment variables is interpreter-specific.
     </para>
 
   </section>
@@ -325,56 +347,58 @@
     <title>&title-program-options;</title>
 
     <para>
-      You can provide options for MySQL programs in several ways:
+      There are several ways to specify options for MySQL programs:
     </para>
 
     <itemizedlist>
 
       <listitem>
         <para>
-          On the command line following the program name. This is most
-          common for options that apply to a specific invocation of the
-          program.
+          List the options on the command line following the program
+          name. This is most common for options that apply to a specific
+          invocation of the program.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          In an option file that the program reads when it starts. This
-          is common for options that you want the program to use each
-          time it runs.
+          List the options in an option file that the program reads when
+          it starts. This is common for options that you want the
+          program to use each time it runs.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          In environment variables. These are useful for options that
-          you want to apply each time the program runs, although in
-          practice option files are used more commonly for this purpose.
-          (<xref linkend="multiple-unix-servers"/>, discusses one
+          List the options in environment variables. This method is
+          useful for options that you want to apply each time the
+          program runs. In practice, option files are used more commonly
+          for this purpose. However,
+          <xref linkend="multiple-unix-servers"/>, discusses one
           situation in which environment variables can be very helpful.
           It describes a handy technique that uses such variables to
           specify the TCP/IP port number and Unix socket file for both
-          the server and client programs.)
+          the server and client programs.
         </para>
       </listitem>
 
     </itemizedlist>
 
     <para>
-      MySQL programs determine which options are given first by
-      examining environment variables, then option files, and then the
-      command line. If an option is specified multiple times, the last
-      occurrence takes precedence. This means that environment variables
-      have the lowest precedence and command-line options the highest.
+      To determine which options are given, MySQL programs first by
+      examining environment variables, then by reading option files, and
+      then by checking the command line. If an option is specified
+      multiple times, the last occurrence takes precedence. This means
+      that environment variables have the lowest precedence and
+      command-line options the highest.
     </para>
 
     <para>
       You can take advantage of the way that MySQL programs process
-      options by specifying the default values for a program's options
-      in an option file. Then you need not type them each time you run
-      the program, but can override the defaults if necessary by using
-      command-line options.
+      options by specifying default values for a program's options in an
+      option file. That enables you to avoid typing them each time you
+      run the program, but also allows you to override the defaults if
+      necessary by using command-line options.
     </para>
 
     <section id="command-line-options">
@@ -431,8 +455,8 @@
             name and the value by an &lsquo;<literal>=</literal>&rsquo;
             sign. For a short option that takes a value, the option
             value can immediately follow the option letter, or there can
-            be a space between. (<option>-hlocalhost</option> and
-            <option>-h localhost</option> are equivalent.) An exception
+            be a space between: <option>-hlocalhost</option> and
+            <option>-h localhost</option> are equivalent. An exception
             to this rule is the option for specifying your MySQL
             password. This option can be given in long form as
             <option>--password=<replaceable>pass_val</replaceable></option>
@@ -1346,10 +1370,14 @@
 
       <para>
         The first command specifies the value in bytes. The second
-        specifies the value in megabytes. Variable values can have a
-        suffix of <literal>K</literal>, <literal>M</literal>, or
+        specifies the value in megabytes. For variables that take a
+        numeric value, the value can be given with a suffix of
+        <literal>K</literal>, <literal>M</literal>, or
         <literal>G</literal> (either uppercase or lowercase) to indicate
-        units of kilobytes, megabytes, or gigabytes.
+        a multiplier of 1024, 1024<superscript>2</superscript> or
+        1024<superscript>3</superscript>. (For example, when used to set
+        <literal>max_allowed_packet</literal>, the suffixes indicate
+        units of kilobytes, megabytes, or gigabygtes.)
       </para>
 
       <para>

Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml	2006-01-06 04:01:37 UTC (rev 700)
+++ trunk/refman-5.1/database-administration.xml	2006-01-06 04:02:03 UTC (rev 701)
@@ -5166,10 +5166,15 @@
         </para>
 
         <para>
-          When setting a variable using a startup option, variable
-          values can be given with a suffix of <literal>K</literal>,
-          <literal>M</literal>, or <literal>G</literal> to indicate
-          kilobytes, megabytes, or gigabytes, respectively. For example,
+When you use a startup option to set a variable that takes a numeric value,
+        the value can be given with a suffix of
+        <literal>K</literal>, <literal>M</literal>, or
+        <literal>G</literal> (either uppercase or lowercase) to indicate
+        a multiplier of 1024, 1024<superscript>2</superscript> or
+        1024<superscript>3</superscript>. For example, when used to set
+        <literal>key_buffer_size</literal>, the suffixes indicate
+        units of kilobytes, megabytes, or gigabygtes.
+           Thus,
           the following command starts the server with a key buffer size
           of 16 megabytes:
         </para>

Modified: trunk/refman-5.1/using-mysql-programs.xml
===================================================================
--- trunk/refman-5.1/using-mysql-programs.xml	2006-01-06 04:01:37 UTC (rev 700)
+++ trunk/refman-5.1/using-mysql-programs.xml	2006-01-06 04:02:03 UTC (rev 701)
@@ -15,48 +15,51 @@
 
   <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
+    provided by MySQL AB and discusses the general syntax for specifying
+    options when you run these programs. Most programs have options that
+    are specific to their own operation, but the option syntax 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:
+    MySQL AB also provides three GUI client programs for use with MySQL
+    Server:
   </para>
 
   <itemizedlist>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;administrator/en/">MySQL
-        Administrator</ulink>: This tool is used for administering MySQL
-        servers, databases, tables, and users.
+        MySQL Administrator: This tool is used for administering MySQL
+        servers, databases, tables, and user accounts.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;query-browser/en/">MySQL Query
-        Browser</ulink>: This graphical tool is provided by MySQL AB for
-        creating, executing, and optimizing queries on MySQL databases.
+        MySQL Query Browser: This graphical tool is provided by MySQL AB
+        for creating, executing, and optimizing queries on MySQL
+        databases.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <ulink url="&base-url-docs;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.
+        MySQL Migration Toolkit: This tool helps you migrate schemas and
+        data from other relational database management systems for use
+        with MySQL.
       </para>
     </listitem>
 
   </itemizedlist>
 
+  <para>
+    These GUI programs each have their own manuals that you can access
+    at <ulink url="&base-url-docs;"/>.
+  </para>
+
   <section id="program-overview">
 
     <title>&title-program-overview;</title>
@@ -80,7 +83,7 @@
 
           <listitem>
             <para>
-              <command>mysqld</command> is the MySQL server
+              <command>mysqld</command> is the MySQL server.
             </para>
           </listitem>
 
@@ -88,22 +91,30 @@
             <para>
               <command>mysqld_safe</command>,
               <command>mysql.server</command>, and
-              <command>mysqld_multi</command> are server startup scripts
+              <command>mysqld_multi</command> are server startup
+              scripts.
             </para>
           </listitem>
 
           <listitem>
             <para>
               <command>mysql_install_db</command> initializes the data
-              directory and the initial databases
+              directory and the initial databases.
             </para>
           </listitem>
 
+          <listitem>
+            <para>
+              MySQL Instance Manager monitors and manages MySQL Server
+              instances.
+            </para>
+          </listitem>
+
         </itemizedlist>
 
         <para>
-          These programs are discussed further in
-          <xref linkend="database-administration"/>.
+          <xref linkend="database-administration"/>, discusses these
+          programs further
         </para>
       </listitem>
 
@@ -130,7 +141,7 @@
           <listitem>
             <para>
               <command>mysqlcheck</command> performs table maintenance
-              operations
+              operations.
             </para>
           </listitem>
 
@@ -157,8 +168,8 @@
         </itemizedlist>
 
         <para>
-          These programs are discussed further in
-          <xref linkend="client-side-scripts"/>.
+          <xref linkend="client-side-scripts"/>, discusses these
+          programs further
         </para>
       </listitem>
 
@@ -192,7 +203,8 @@
 
           <listitem>
             <para>
-              <command>perror</command> displays error code meanings.
+              <command>perror</command> displays the meaning of error
+              codes.
             </para>
           </listitem>
 
@@ -208,9 +220,10 @@
         </remark>
 
         <para>
-          <command>myisamchk</command> is discussed further in
-          <xref linkend="database-administration"/>. The other programs
-          are further in <xref linkend="client-side-scripts"/>.
+          <xref linkend="database-administration"/>, discusses
+          <command>myisamchk</command>.
+          <xref linkend="client-side-scripts"/>, discusses the other
+          programs.
         </para>
       </listitem>
 
@@ -221,10 +234,11 @@
       those programs that are platform-specific. (For example, the
       server startup scripts are not used on Windows.) The exception is
       that RPM distributions are more specialized. There is one RPM for
-      the server, another for the client programs, and so forth. If you
+      the server, another for client programs, and so forth. If you
       appear to be missing one or more programs, see
       <xref linkend="installing"/>, for information on types of
-      distributions and what they contain. It may be that you need to
+      distributions and what they contain. It may be that you have a
+      distribution that does not include all programs and you need to
       install something else.
     </para>
 
@@ -245,30 +259,32 @@
       command interpreter. Typical prompts are <literal>$</literal> for
       <command>sh</command> or <command>bash</command>,
       <literal>%</literal> for <command>csh</command> or
-      <command>tcsh</command>, and <literal>C:\&gt;</literal> for
+      <command>tcsh</command>, and <literal>C:\&gt;</literal> for the
       Windows <command>command.com</command> or
-      <command>cmd.exe</command>.
+      <command>cmd.exe</command> command interpreters.
     </para>
 
 <programlisting>
-shell&gt; <userinput>mysql test</userinput>
+shell&gt; <userinput>mysql -u root test</userinput>
 shell&gt; <userinput>mysqladmin extended-status variables</userinput>
 shell&gt; <userinput>mysqlshow --help</userinput>
 shell&gt; <userinput>mysqldump --user=root personnel</userinput>
 </programlisting>
 
     <para>
-      Arguments that begin with a dash are option arguments. They
+      Arguments that begin with a single or double dash
+      (&lsquo;<literal>-</literal>&rsquo;,
+      &lsquo;<literal>--</literal>&rsquo;) are option arguments. Options
       typically specify the type of connection a program should make to
-      the server or affect its operational mode. Options have a syntax
-      that is described in <xref linkend="program-options"/>.
+      the server or affect its operational mode. Option syntax is
+      described in <xref linkend="program-options"/>.
     </para>
 
     <para>
       Non-option arguments (arguments with no leading dash) provide
       additional information to the program. For example, the
       <command>mysql</command> program interprets the first non-option
-      argument as a database name, so the command <literal>mysql
+      argument as a database name, so the command <literal>mysql -u root
       test</literal> indicates that you want to use the
       <literal>test</literal> database.
     </para>
@@ -281,13 +297,14 @@
 
     <para>
       Some options are common to a number of programs. The most common
-      of these are the <option>--host</option>, <option>--user</option>,
-      and <option>--password</option> options that specify connection
-      parameters. They indicate the host where the MySQL server is
-      running, and the username and password of your MySQL account. All
-      MySQL client programs understand these options; they allow you to
-      specify which server to connect to and the account to use on that
-      server.
+      of these are the <option>--host</option> (or <option>-h</option>),
+      <option>--user</option> (or <option>-u</option>), and
+      <option>--password</option> (or <option>-p</option>) options that
+      specify connection parameters. They indicate the host where the
+      MySQL server is running, and the username and password of your
+      MySQL account. All MySQL client programs understand these options;
+      they allow you to specify which server to connect to and the
+      account to use on that server.
     </para>
 
     <indexterm>
@@ -308,14 +325,19 @@
       <filename>bin</filename> directory. To make it more convenient to
       use MySQL, you can add the pathname of the
       <filename>bin</filename> directory to your <literal>PATH</literal>
-      environment variable setting. Then to run a program you need only
-      type its name, not its entire pathname.
+      environment variable setting. That enables you to run a program by
+      typing only its name, not its entire pathname. For example, if
+      <command>mysql</command> is installed in
+      <filename>/usr/local/mysql/bin</filename>, you'll be able to run
+      it by invoking it as <command>mysql</command>; it will not be
+      necessary to invoke it as
+      <command>/usr/local/mysql/bin/mysql</command>.
     </para>
 
     <para>
       Consult the documentation for your command interpreter for
-      instructions on setting your <literal>PATH</literal>. The syntax
-      for setting environment variables is interpreter-specific.
+      instructions on setting your <literal>PATH</literal> variable. The
+      syntax for setting environment variables is interpreter-specific.
     </para>
 
   </section>
@@ -325,56 +347,58 @@
     <title>&title-program-options;</title>
 
     <para>
-      You can provide options for MySQL programs in several ways:
+      There are several ways to specify options for MySQL programs:
     </para>
 
     <itemizedlist>
 
       <listitem>
         <para>
-          On the command line following the program name. This is most
-          common for options that apply to a specific invocation of the
-          program.
+          List the options on the command line following the program
+          name. This is most common for options that apply to a specific
+          invocation of the program.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          In an option file that the program reads when it starts. This
-          is common for options that you want the program to use each
-          time it runs.
+          List the options in an option file that the program reads when
+          it starts. This is common for options that you want the
+          program to use each time it runs.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          In environment variables. These are useful for options that
-          you want to apply each time the program runs, although in
-          practice option files are used more commonly for this purpose.
-          (<xref linkend="multiple-unix-servers"/>, discusses one
+          List the options in environment variables. This method is
+          useful for options that you want to apply each time the
+          program runs. In practice, option files are used more commonly
+          for this purpose. However,
+          <xref linkend="multiple-unix-servers"/>, discusses one
           situation in which environment variables can be very helpful.
           It describes a handy technique that uses such variables to
           specify the TCP/IP port number and Unix socket file for both
-          the server and client programs.)
+          the server and client programs.
         </para>
       </listitem>
 
     </itemizedlist>
 
     <para>
-      MySQL programs determine which options are given first by
-      examining environment variables, then option files, and then the
-      command line. If an option is specified multiple times, the last
-      occurrence takes precedence. This means that environment variables
-      have the lowest precedence and command-line options the highest.
+      To determine which options are given, MySQL programs first by
+      examining environment variables, then by reading option files, and
+      then by checking the command line. If an option is specified
+      multiple times, the last occurrence takes precedence. This means
+      that environment variables have the lowest precedence and
+      command-line options the highest.
     </para>
 
     <para>
       You can take advantage of the way that MySQL programs process
-      options by specifying the default values for a program's options
-      in an option file. Then you need not type them each time you run
-      the program, but can override the defaults if necessary by using
-      command-line options.
+      options by specifying default values for a program's options in an
+      option file. That enables you to avoid typing them each time you
+      run the program, but also allows you to override the defaults if
+      necessary by using command-line options.
     </para>
 
     <section id="command-line-options">
@@ -431,8 +455,8 @@
             name and the value by an &lsquo;<literal>=</literal>&rsquo;
             sign. For a short option that takes a value, the option
             value can immediately follow the option letter, or there can
-            be a space between. (<option>-hlocalhost</option> and
-            <option>-h localhost</option> are equivalent.) An exception
+            be a space between: <option>-hlocalhost</option> and
+            <option>-h localhost</option> are equivalent. An exception
             to this rule is the option for specifying your MySQL
             password. This option can be given in long form as
             <option>--password=<replaceable>pass_val</replaceable></option>
@@ -1345,10 +1369,14 @@
 
       <para>
         The first command specifies the value in bytes. The second
-        specifies the value in megabytes. Variable values can have a
-        suffix of <literal>K</literal>, <literal>M</literal>, or
+        specifies the value in megabytes. For variables that take a
+        numeric value, the value can be given with a suffix of
+        <literal>K</literal>, <literal>M</literal>, or
         <literal>G</literal> (either uppercase or lowercase) to indicate
-        units of kilobytes, megabytes, or gigabytes.
+        a multiplier of 1024, 1024<superscript>2</superscript> or
+        1024<superscript>3</superscript>. (For example, when used to set
+        <literal>max_allowed_packet</literal>, the suffixes indicate
+        units of kilobytes, megabytes, or gigabygtes.)
       </para>
 
       <para>

Thread
svn commit - mysqldoc@docsrva: r701 - in trunk: . refman-4.1 refman-5.0 refman-5.1paul6 Jan