List:Commits« Previous MessageNext Message »
From:paul Date:January 23 2006 2:35am
Subject:svn commit - mysqldoc@docsrva: r994 - in trunk: . refman-4.1 refman-5.0 refman-5.1
View as plain text  
Author: paul
Date: 2006-01-23 03:35:01 +0100 (Mon, 23 Jan 2006)
New Revision: 994

Log:
 r6573@frost:  paul | 2006-01-22 20:14:05 -0600
 General revisions.


Modified:
   trunk/
   trunk/refman-4.1/client-utility-programs.xml
   trunk/refman-4.1/database-administration.xml
   trunk/refman-4.1/installing.xml
   trunk/refman-5.0/client-utility-programs.xml
   trunk/refman-5.0/database-administration.xml
   trunk/refman-5.1/client-utility-programs.xml
   trunk/refman-5.1/database-administration.xml


Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6572
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2396
   + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6573
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2396

Modified: trunk/refman-4.1/client-utility-programs.xml
===================================================================
--- trunk/refman-4.1/client-utility-programs.xml	2006-01-23 02:34:40 UTC (rev 993)
+++ trunk/refman-4.1/client-utility-programs.xml	2006-01-23 02:35:01 UTC (rev 994)
@@ -478,12 +478,12 @@
           The <command>myisamchk</command> utility gets information
           about your database tables or checks, repairs, or optimizes
           them. <command>myisamchk</command> works with
-          <literal>MyISAM</literal> tables (tables with
-          <filename>.MYI</filename> and <filename>.MYD</filename>
-          files). A related utility, <command>isamchk</command>, works
-          with <literal>ISAM</literal> tables (tables with
-          <filename>.ISM</filename> and <filename>.ISD</filename>
-          files).
+          <literal>MyISAM</literal> tables (tables that have
+          <filename>.MYD</filename> and <filename>.MYI</filename> files
+          for storing data and indexes). A related utility,
+          <command>isamchk</command>, works with <literal>ISAM</literal>
+          tables (tables that have <filename>.ISD</filename> and
+          <filename>.ISM</filename> files for storing data and indexes).
         </para>
 
         <para>
@@ -712,10 +712,9 @@
               Instead of terminating with an error if the table is
               locked, wait until the table is unlocked before
               continuing. Note that if you are running
-              <command>mysqld</command> with the
-              <option>--skip-external-locking</option> option, the table
-              can be locked only by another <command>myisamchk</command>
-              command.
+              <command>mysqld</command> with external locking disabled,
+              the table can be locked only by another
+              <command>myisamchk</command> command.
             </para>
           </listitem>
 
@@ -1069,7 +1068,7 @@
               Do a repair operation automatically if
               <command>myisamchk</command> finds any errors in the
               table. The repair type is the same as that specified with
-              the <option>--repair</option> or <option>-r</option>
+              the <option>--recover</option> or <option>-r</option>
               option.
             </para>
           </listitem>
@@ -1104,11 +1103,11 @@
             </para>
 
             <para>
-              do not mark the table as checked. This is useful if you
-              use <command>myisamchk</command> to check a table that is
-              in use by some other application that does not use
-              locking, such as <command>mysqld</command> when run with
-              the <option>--skip-external-locking</option> option.
+              Don't mark the table as checked. This is useful if you use
+              <command>myisamchk</command> to check a table that is in
+              use by some other application that does not use locking,
+              such as <command>mysqld</command> when run with external
+              locking disabled.
             </para>
           </listitem>
 
@@ -1122,10 +1121,9 @@
               indicate when the table was checked and whether the table
               crashed. This should be used to get full benefit of the
               <option>--check-only-changed</option> option, but you
-              should not use this option if the
-              <command>mysqld</command> server is using the table and
-              you are running it with the
-              <option>--skip-external-locking</option> option.
+              shouldn't use this option if the <command>mysqld</command>
+              server is using the table and you are running it with
+              external locking disabled.
             </para>
           </listitem>
 
@@ -1161,7 +1159,7 @@
 
             <para>
               Make a backup of the <filename>.MYD</filename> file as
-              <filename>file_name-time.BAK</filename>
+              <filename><replaceable>file_name</replaceable>-<replaceable>time</replaceable>.BAK</filename>
             </para>
           </listitem>
 
@@ -1205,8 +1203,8 @@
 
             <para>
               Do a repair that tries to recover every possible row from
-              the data file. Normally this also finds a lot of garbage
-              rows. do not use this option unless you are totally
+              the data file. Normally, this also finds a lot of garbage
+              rows. Don't use this option unless you are totally
               desperate.
             </para>
           </listitem>
@@ -1231,9 +1229,9 @@
 
             <para>
               For <command>myisamchk</command>, the option value is a
-              bit-value indicates which indexes to update. Each binary
-              bit of the option value corresponds to a table index,
-              where the first index is bit 0. For
+              bit-value that indicates which indexes to update. Each
+              binary bit of the option value corresponds to a table
+              index, where the first index is bit 0. For
               <command>isamchk</command>, the option value indicates
               that only the first <replaceable>val</replaceable> of the
               table indexes should be updated. In either case, an option
@@ -1253,7 +1251,7 @@
               Do not follow symbolic links. Normally
               <command>myisamchk</command> repairs the table that a
               symlink points to. This option does not exist as of MySQL
-              4.0, because versions from 4.0 on do not remove symlinks
+              4.0 because versions from 4.0 on do not remove symlinks
               during repair operations.
             </para>
           </listitem>
@@ -1271,8 +1269,8 @@
               Uses the same technique as <option>-r</option> and
               <option>-n</option>, but creates all the keys in parallel,
               using different threads. This option was added in MySQL
-              4.0.2. <emphasis>This is alpha code; use at your own
-              risk</emphasis>.
+              4.0.2. <emphasis>This is alpha-quality code; use at your
+              own risk</emphasis>.
             </para>
           </listitem>
 
@@ -1300,11 +1298,11 @@
               error with
               <literal>ISAM</literal>/<literal>MyISAM</literal> tables).
               If you want to recover a table, this is the option to try
-              first. You should try <option>-o</option> only if
-              <command>myisamchk</command> reports that the table cannot
-              be recovered by <option>-r</option>. (In the unlikely case
-              that <option>-r</option> fails, the data file remains
-              intact.)
+              first. You should try <option>--safe-recover</option> only
+              if <command>myisamchk</command> reports that the table
+              cannot be recovered by <option>--recover</option>. (In the
+              unlikely case that <option>--recover</option> fails, the
+              data file remains intact.)
             </para>
 
             <para>
@@ -1322,12 +1320,14 @@
               Do a repair using an old recovery method that reads
               through all rows in order and updates all index trees
               based on the rows found. This is an order of magnitude
-              slower than <option>-r</option>, but can handle a couple
-              of very unlikely cases that <option>-r</option> cannot.
-              This recovery method also uses much less disk space than
-              <option>-r</option>. Normally, you should repair first
-              using <option>-r</option>, and then with
-              <option>-o</option> only if <option>-r</option> fails.
+              slower than <option>--recover</option>, but can handle a
+              couple of very unlikely cases that
+              <option>--recover</option> cannot. This recovery method
+              also uses much less disk space than
+              <option>--recover</option>. Normally, you should repair
+              first using <option>--recover</option>, and then with
+              <option>--safe-recover</option> only if
+              <option>--recover</option> fails.
             </para>
 
             <para>
@@ -1354,8 +1354,8 @@
             </para>
 
             <para>
-              Change the collation used to sort table indexes. The
-              character set name is implied by the first part of the
+              Specify the collation to use for sorting table indexes.
+              The character set name is implied by the first part of the
               collation name. This option was added in MySQL 4.1.11.
             </para>
           </listitem>
@@ -1425,13 +1425,13 @@
             </para>
 
             <para>
-              Analyze the distribution of keys. This improves join
+              Analyze the distribution of key values. This improves join
               performance by enabling the join optimizer to better
               choose the order in which to join the tables and which
-              keys it should use. To obtain information about the
+              indexes it should use. To obtain information about the key
               distribution, use a <command>myisamchk --description
               --verbose <replaceable>tbl_name</replaceable></command>
-              command or the <literal>SHOW KEYS FROM
+              command or the <literal>SHOW INDEX FROM
               <replaceable>tbl_name</replaceable></literal> statement.
             </para>
           </listitem>
@@ -1458,8 +1458,8 @@
               are existing records with
               <literal>AUTO_INCREMENT</literal> values this large). If
               <replaceable>value</replaceable> is not specified,
-              <literal>AUTO_INCREMENT</literal> number for new records
-              begins with the largest value currently in the table, plus
+              <literal>AUTO_INCREMENT</literal> numbers for new records
+              begin with the largest value currently in the table, plus
               one.
             </para>
           </listitem>
@@ -1471,7 +1471,8 @@
 
             <para>
               Sort the index tree blocks in high-low order. This
-              optimizes seeks and makes table scanning by key faster.
+              optimizes seeks and makes table scans that use indexes
+              faster.
             </para>
           </listitem>
 
@@ -1488,7 +1489,7 @@
               operations that use this index. (The first time you use
               this option to sort a table, it may be very slow.) To
               determine a table's index numbers, use <literal>SHOW
-              KEYS</literal>, which displays a table's indexes in the
+              INDEX</literal>, which displays a table's indexes in the
               same order that <command>myisamchk</command> sees them.
               Indexes are numbered beginning with 1.
             </para>
@@ -1522,34 +1523,35 @@
         <para>
           Memory allocation is important when you run
           <command>myisamchk</command>. <command>myisamchk</command>
-          uses no more memory than you specify with the
-          <option>-O</option> options. If you are going to use
-          <command>myisamchk</command> on very large tables, you should
-          first decide how much memory you want it to use. The default
-          is to use only about 3MB to perform repairs. By using larger
-          values, you can get <command>myisamchk</command> to operate
-          faster. For example, if you have more than 32MB RAM, you could
-          use options such as these (in addition to any other options
-          you might specify):
+          uses no more memory than its memory-related variables are set
+          to. If you are going to use <command>myisamchk</command> on
+          very large tables, you should first decide how much memory you
+          want it to use. The default is to use only about 3MB to
+          perform repairs. By using larger values, you can get
+          <command>myisamchk</command> to operate faster. For example,
+          if you have more than 32MB RAM, you could use options such as
+          these (in addition to any other options you might specify):
         </para>
 
 <programlisting>
-shell&gt; <userinput>myisamchk -O sort=16M -O key=16M -O read=1M -O write=1M ...</userinput>
+shell&gt; <userinput>myisamchk --sort_buffer_size=16M --key_buffer_size=16M \</userinput>
+           <userinput>--read_buffer_size=1M --write_buffer_size=1M ...</userinput>
 </programlisting>
 
         <para>
-          Using <option>-O sort=16M</option> should probably be enough
-          for most cases.
+          Using <option>--sort_buffer_size=16M</option> should probably
+          be enough for most cases.
         </para>
 
         <para>
           Be aware that <command>myisamchk</command> uses temporary
           files in <literal>TMPDIR</literal>. If
           <literal>TMPDIR</literal> points to a memory filesystem, you
-          may easily get out of memory errors. If this happens, set
-          <literal>TMPDIR</literal> to point at some directory located
-          on a filesystem with more space and run
-          <command>myisamchk</command> again.
+          may easily get out of memory errors. If this happens, run
+          <command>myisamchk</command> with the
+          <option>--tmpdir=<replaceable>path</replaceable></option>
+          option to specify some directory located on a filesystem that
+          has more space.
         </para>
 
         <para>
@@ -1561,7 +1563,7 @@
 
           <listitem>
             <para>
-              Double the size of the data file (the original one and a
+              Double the size of the data file (the original file and a
               copy). This space is not needed if you do a repair with
               <option>--quick</option>; in this case, only the index
               file is re-created. <emphasis>This space must be available
@@ -1586,11 +1588,12 @@
               When using <option>--recover</option> or
               <option>--sort-recover</option> (but not when using
               <option>--safe-recover</option>), you need space for a
-              sort buffer. The amount of space required is:
+              sort buffer. The following formula yields the amount of
+              space required:
             </para>
 
 <programlisting>
-(<replaceable>largest_key</replaceable> + <replaceable>row_pointer_length</replaceable>) * <replaceable>number_of_rows</replaceable> * 2
+(<replaceable>largest_key</replaceable> + <replaceable>row_pointer_length</replaceable>) &times; <replaceable>number_of_rows</replaceable> &times; 2
 </programlisting>
 
             <para>
@@ -1608,7 +1611,7 @@
 
         <para>
           If you have a problem with disk space during repair, you can
-          try to use <option>--safe-recover</option> instead of
+          try <option>--safe-recover</option> instead of
           <option>--recover</option>.
         </para>
 

Modified: trunk/refman-4.1/database-administration.xml
===================================================================
--- trunk/refman-4.1/database-administration.xml	2006-01-23 02:34:40 UTC (rev 993)
+++ trunk/refman-4.1/database-administration.xml	2006-01-23 02:35:01 UTC (rev 994)
@@ -4722,7 +4722,7 @@
               own thread) during the <literal>Repair by
               sorting</literal> process. The default value is 1.
               <emphasis role="bold">Note</emphasis>: Multi-threaded
-              repair is still <emphasis>alpha</emphasis> quality code.
+              repair is still <emphasis>alpha-quality</emphasis> code.
               This variable was added in MySQL 4.0.13.
             </para>
           </listitem>
@@ -16447,7 +16447,7 @@
           </para>
 
 <programlisting>
-shell&gt; <userinput>mysqlbinlog hostname-bin.[0-9]* | mysql</userinput>
+shell&gt; <userinput>mysqlbinlog binlog.[0-9]* | mysql</userinput>
 </programlisting>
 
           <para>
@@ -16776,7 +16776,7 @@
 
 <programlisting>
 shell&gt; <userinput>mysqldump --single-transaction --flush-logs --master-data=2</userinput>
-           --all-databases &gt; backup_sunday_1_PM.sql
+           <userinput>--all-databases &gt; backup_sunday_1_PM.sql</userinput>
 </programlisting>
 
         <para>
@@ -16843,7 +16843,7 @@
 
 <programlisting>
 shell&gt; <userinput>mysqldump --single-transaction --flush-logs --master-data=2</userinput>
-           --all-databases --delete-master-logs &gt; backup_sunday_1_PM.sql
+           <userinput>--all-databases --delete-master-logs &gt; backup_sunday_1_PM.sql</userinput>
 </programlisting>
 
         <para>
@@ -17005,7 +17005,7 @@
       </para>
 
 <programlisting>
-mysql --user=<replaceable>root</replaceable> -p<replaceable>my_pwd</replaceable> -e 'SHOW BINLOG EVENTS \G'
+mysql --user=<replaceable>root</replaceable> -p<replaceable>my_pwd</replaceable> -E -e 'SHOW BINLOG EVENTS'
 </programlisting>
 
       <para>
@@ -17084,7 +17084,8 @@
         </para>
 
 <programlisting>
-mysqlbinlog --start-date="2005-04-20 9:55:00" --stop-date="2005-04-20 10:05:00" \
+mysqlbinlog --start-date="2005-04-20 9:55:00" \
+      --stop-date="2005-04-20 10:05:00" \
       /var/log/mysql/bin.123456 &gt; /tmp/mysql_restore.sql
 </programlisting>
 
@@ -17133,12 +17134,15 @@
       <para>
         The following sections discuss how to use
         <command>myisamchk</command> to check or repair
-        <literal>MyISAM</literal> tables (tables with
-        <filename>.MYI</filename> and <filename>.MYD</filename> files).
-        The same concepts apply to using <command>isamchk</command> to
-        check or repair <literal>ISAM</literal> tables (tables with
-        <filename>.ISM</filename> and <filename>.ISD</filename> files).
-        See <xref linkend="storage-engines"/>.
+        <literal>MyISAM</literal> tables (tables that have
+        <filename>.MYD</filename> and <filename>.MYI</filename> files
+        for storing data and indexes). The same concepts apply to using
+        <command>isamchk</command> to check or repair
+        <literal>ISAM</literal> tables (tables that have
+        <filename>.ISD</filename> and <filename>.ISM</filename> files
+        for storing data and indexes). For general
+        <command>myisamchk</command> or <command>isamchk</command>
+        background, see <xref linkend="myisamchk"/>.
       </para>
 
       <para>

Modified: trunk/refman-4.1/installing.xml
===================================================================
--- trunk/refman-4.1/installing.xml	2006-01-23 02:34:40 UTC (rev 993)
+++ trunk/refman-4.1/installing.xml	2006-01-23 02:35:01 UTC (rev 994)
@@ -4352,18 +4352,10 @@
 
       <remark>
         [MH] HOW LONG DO WE WANT TO SUPPORT DOCUMENTING THE INSTALLATION
-        OF
+        OF A DEPRECATED VERSION? CAN WE ASSSUME THAT WHEN OLDER VERSIONS
+        ARE NOT DOWNLOADABLE WE DROP THIS?
       </remark>
 
-      <remark>
-        A DEPRECATED VERSION? CAN WE ASSSUME THAT WHEN OLDER VERSIONS
-        ARE NO
-      </remark>
-
-      <remark>
-        DOWNLOADABLE WE DROP THIS?
-      </remark>
-
       <para>
         Starting with MySQL 3.23.38, the Windows distribution includes
         both the normal and the MySQL-Max server binaries.

Modified: trunk/refman-5.0/client-utility-programs.xml
===================================================================
--- trunk/refman-5.0/client-utility-programs.xml	2006-01-23 02:34:40 UTC (rev 993)
+++ trunk/refman-5.0/client-utility-programs.xml	2006-01-23 02:35:01 UTC (rev 994)
@@ -450,9 +450,9 @@
           The <command>myisamchk</command> utility gets information
           about your database tables or checks, repairs, or optimizes
           them. <command>myisamchk</command> works with
-          <literal>MyISAM</literal> tables (tables with
-          <filename>.MYI</filename> and <filename>.MYD</filename>
-          files).
+          <literal>MyISAM</literal> tables (tables that have
+          <filename>.MYD</filename> and <filename>.MYI</filename> files
+          for storing data and indexes).
         </para>
 
         <para>
@@ -676,10 +676,9 @@
               Instead of terminating with an error if the table is
               locked, wait until the table is unlocked before
               continuing. Note that if you are running
-              <command>mysqld</command> with the
-              <option>--skip-external-locking</option> option, the table
-              can be locked only by another <command>myisamchk</command>
-              command.
+              <command>mysqld</command> with external locking disabled,
+              the table can be locked only by another
+              <command>myisamchk</command> command.
             </para>
           </listitem>
 
@@ -1018,7 +1017,7 @@
               Do a repair operation automatically if
               <command>myisamchk</command> finds any errors in the
               table. The repair type is the same as that specified with
-              the <option>--repair</option> or <option>-r</option>
+              the <option>--recover</option> or <option>-r</option>
               option.
             </para>
           </listitem>
@@ -1056,8 +1055,8 @@
               Don't mark the table as checked. This is useful if you use
               <command>myisamchk</command> to check a table that is in
               use by some other application that doesn't use locking,
-              such as <command>mysqld</command> when run with the
-              <option>--skip-external-locking</option> option.
+              such as <command>mysqld</command> when run with external
+              locking disabled.
             </para>
           </listitem>
 
@@ -1072,8 +1071,8 @@
               crashed. This should be used to get full benefit of the
               <option>--check-only-changed</option> option, but you
               shouldn't use this option if the <command>mysqld</command>
-              server is using the table and you are running it with the
-              <option>--skip-external-locking</option> option.
+              server is using the table and you are running it with
+              external locking disabled.
             </para>
           </listitem>
 
@@ -1109,7 +1108,7 @@
 
             <para>
               Make a backup of the <filename>.MYD</filename> file as
-              <filename>file_name-time.BAK</filename>
+              <filename><replaceable>file_name</replaceable>-<replaceable>time</replaceable>.BAK</filename>
             </para>
           </listitem>
 
@@ -1142,7 +1141,7 @@
 
             <para>
               Maximum length of the data file (when re-creating data
-              file when it's <quote>full</quote>).
+              file when it is <quote>full</quote>).
             </para>
           </listitem>
 
@@ -1153,7 +1152,7 @@
 
             <para>
               Do a repair that tries to recover every possible row from
-              the data file. Normally this also finds a lot of garbage
+              the data file. Normally, this also finds a lot of garbage
               rows. Don't use this option unless you are desperate.
             </para>
           </listitem>
@@ -1178,31 +1177,17 @@
 
             <para>
               For <command>myisamchk</command>, the option value is a
-              bit-value indicates which indexes to update. Each binary
-              bit of the option value corresponds to a table index,
-              where the first index is bit 0. An option value of 0
-              disables updates to all indexes, which can be used to get
-              faster inserts. Deactivated indexes can be reactivated by
-              using <command>myisamchk -r</command>.
+              bit-value that indicates which indexes to update. Each
+              binary bit of the option value corresponds to a table
+              index, where the first index is bit 0. An option value of
+              0 disables updates to all indexes, which can be used to
+              get faster inserts. Deactivated indexes can be reactivated
+              by using <command>myisamchk -r</command>.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <option>--no-symlinks</option>, <option>-l</option>
-            </para>
-
-            <para>
-              Do not follow symbolic links. Normally
-              <command>myisamchk</command> repairs the table that a
-              symlink points to. This option doesn't exist as of MySQL
-              4.0, because versions from 4.0 on do not remove symlinks
-              during repair operations.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
               <option>--parallel-recover</option>, <option>-p</option>
             </para>
 
@@ -1215,7 +1200,7 @@
                 Is this still the case in 5.0?
               </remark>
 
-              <emphasis>This is alpha code. Use at your own
+              <emphasis>This is alpha-quality code. Use at your own
               risk!</emphasis>
             </para>
           </listitem>
@@ -1243,11 +1228,11 @@
               keys that aren't unique (which is an extremely unlikely
               error with <literal>MyISAM</literal> tables). If you want
               to recover a table, this is the option to try first. You
-              should try <option>-o</option> only if
+              should try <option>--safe-recover</option> only if
               <command>myisamchk</command> reports that the table can't
-              be recovered using <option>-r</option>. (In the unlikely
-              case that <option>-r</option> fails, the data file remains
-              intact.)
+              be recovered using <option>--recover</option>. (In the
+              unlikely case that <option>--recover</option> fails, the
+              data file remains intact.)
             </para>
 
             <para>
@@ -1265,12 +1250,14 @@
               Do a repair using an old recovery method that reads
               through all rows in order and updates all index trees
               based on the rows found. This is an order of magnitude
-              slower than <option>-r</option>, but can handle a couple
-              of very unlikely cases that <option>-r</option> cannot.
-              This recovery method also uses much less disk space than
-              <option>-r</option>. Normally, you should repair first
-              with <option>-r</option>, and then with
-              <option>-o</option> only if <option>-r</option> fails.
+              slower than <option>--recover</option>, but can handle a
+              couple of very unlikely cases that
+              <option>--recover</option> cannot. This recovery method
+              also uses much less disk space than
+              <option>--recover</option>. Normally, you should repair
+              first with <option>--recover</option>, and then with
+              <option>--safe-recover</option> only if
+              <option>--recover</option> fails.
             </para>
 
             <para>
@@ -1297,8 +1284,8 @@
             </para>
 
             <para>
-              Change the collation used to sort table indexes. The
-              character set name is implied by the first part of the
+              Specify the collation to use for sorting table indexes.
+              The character set name is implied by the first part of the
               collation name. This option was added in MySQL 5.0.3.
             </para>
           </listitem>
@@ -1367,13 +1354,13 @@
             </para>
 
             <para>
-              Analyze the distribution of keys. This improves join
+              Analyze the distribution of key values. This improves join
               performance by enabling the join optimizer to better
               choose the order in which to join the tables and which
-              keys it should use. To obtain information about the
+              indexes it should use. To obtain information about the key
               distribution, use a <command>myisamchk --description
               --verbose <replaceable>tbl_name</replaceable></command>
-              command or the <literal>SHOW KEYS FROM
+              command or the <literal>SHOW INDEX FROM
               <replaceable>tbl_name</replaceable></literal> statement.
             </para>
           </listitem>
@@ -1400,8 +1387,8 @@
               are existing records with
               <literal>AUTO_INCREMENT</literal> values this large). If
               <replaceable>value</replaceable> is not specified,
-              <literal>AUTO_INCREMENT</literal> number for new records
-              begins with the largest value currently in the table, plus
+              <literal>AUTO_INCREMENT</literal> numbers for new records
+              begin with the largest value currently in the table, plus
               one.
             </para>
           </listitem>
@@ -1413,7 +1400,8 @@
 
             <para>
               Sort the index tree blocks in high-low order. This
-              optimizes seeks and makes table scanning by key faster.
+              optimizes seeks and makes table scans that use indexes
+              faster.
             </para>
           </listitem>
 
@@ -1430,7 +1418,7 @@
               operations that use this index. (The first time you use
               this option to sort a table, it may be very slow.) To
               determine a table's index numbers, use <literal>SHOW
-              KEYS</literal>, which displays a table's indexes in the
+              INDEX</literal>, which displays a table's indexes in the
               same order that <command>myisamchk</command> sees them.
               Indexes are numbered beginning with 1.
             </para>
@@ -1464,34 +1452,35 @@
         <para>
           Memory allocation is important when you run
           <command>myisamchk</command>. <command>myisamchk</command>
-          uses no more memory than you specify with the
-          <option>-O</option> options. If you are going to use
-          <command>myisamchk</command> on very large tables, you should
-          first decide how much memory you want it to use. The default
-          is to use only about 3MB to perform repairs. By using larger
-          values, you can get <command>myisamchk</command> to operate
-          faster. For example, if you have more than 32MB RAM, you could
-          use options such as these (in addition to any other options
-          you might specify):
+          uses no more memory than its memory-related variables are set
+          to. If you are going to use <command>myisamchk</command> on
+          very large tables, you should first decide how much memory you
+          want it to use. The default is to use only about 3MB to
+          perform repairs. By using larger values, you can get
+          <command>myisamchk</command> to operate faster. For example,
+          if you have more than 32MB RAM, you could use options such as
+          these (in addition to any other options you might specify):
         </para>
 
 <programlisting>
-shell&gt; <userinput>myisamchk -O sort=16M -O key=16M -O read=1M -O write=1M ...</userinput>
+shell&gt; <userinput>myisamchk --sort_buffer_size=16M --key_buffer_size=16M \</userinput>
+           <userinput>--read_buffer_size=1M --write_buffer_size=1M ...</userinput>
 </programlisting>
 
         <para>
-          Using <option>-O sort=16M</option> should probably be enough
-          for most cases.
+          Using <option>--sort_buffer_size=16M</option> should probably
+          be enough for most cases.
         </para>
 
         <para>
           Be aware that <command>myisamchk</command> uses temporary
           files in <literal>TMPDIR</literal>. If
           <literal>TMPDIR</literal> points to a memory filesystem, you
-          may easily get out of memory errors. If this happens, set
-          <literal>TMPDIR</literal> to point at some directory located
-          on a filesystem with more space and run
-          <command>myisamchk</command> again.
+          may easily get out of memory errors. If this happens, run
+          <command>myisamchk</command> with the
+          <option>--tmpdir=<replaceable>path</replaceable></option>
+          option to specify some directory located on a filesystem that
+          has more space.
         </para>
 
         <para>
@@ -1503,7 +1492,7 @@
 
           <listitem>
             <para>
-              Double the size of the data file (the original one and a
+              Double the size of the data file (the original file and a
               copy). This space is not needed if you do a repair with
               <option>--quick</option>; in this case, only the index
               file is re-created. This space is needed on the same
@@ -1526,11 +1515,12 @@
               When using <option>--recover</option> or
               <option>--sort-recover</option> (but not when using
               <option>--safe-recover</option>), you need space for a
-              sort buffer. The amount of space required is:
+              sort buffer. The following formula yields the amount of
+              space required:
             </para>
 
 <programlisting>
-(<replaceable>largest_key</replaceable> + <replaceable>row_pointer_length</replaceable>) * <replaceable>number_of_rows</replaceable> * 2
+(<replaceable>largest_key</replaceable> + <replaceable>row_pointer_length</replaceable>) &times; <replaceable>number_of_rows</replaceable> &times; 2
 </programlisting>
 
             <para>
@@ -1548,7 +1538,7 @@
 
         <para>
           If you have a problem with disk space during repair, you can
-          try to use <option>--safe-recover</option> instead of
+          try <option>--safe-recover</option> instead of
           <option>--recover</option>.
         </para>
 

Modified: trunk/refman-5.0/database-administration.xml
===================================================================
--- trunk/refman-5.0/database-administration.xml	2006-01-23 02:34:40 UTC (rev 993)
+++ trunk/refman-5.0/database-administration.xml	2006-01-23 02:35:01 UTC (rev 994)
@@ -5370,7 +5370,7 @@
               own thread) during the <literal>Repair by
               sorting</literal> process. The default value is 1.
               <emphasis role="bold">Note</emphasis>: Multi-threaded
-              repair is still <emphasis>alpha</emphasis> quality code.
+              repair is still <emphasis>alpha-quality</emphasis> code.
             </para>
           </listitem>
 
@@ -18734,7 +18734,7 @@
           </para>
 
 <programlisting>
-shell&gt; <userinput>mysqlbinlog hostname-bin.[0-9]* | mysql</userinput>
+shell&gt; <userinput>mysqlbinlog binlog.[0-9]* | mysql</userinput>
 </programlisting>
 
           <para>
@@ -19042,7 +19042,7 @@
 
 <programlisting>
 shell&gt; <userinput>mysqldump --single-transaction --flush-logs --master-data=2</userinput>
-           --all-databases &gt; backup_sunday_1_PM.sql
+           <userinput>--all-databases &gt; backup_sunday_1_PM.sql</userinput>
 </programlisting>
 
         <para>
@@ -19109,7 +19109,7 @@
 
 <programlisting>
 shell&gt; <userinput>mysqldump --single-transaction --flush-logs --master-data=2</userinput>
-           --all-databases --delete-master-logs &gt; backup_sunday_1_PM.sql
+           <userinput>--all-databases --delete-master-logs &gt; backup_sunday_1_PM.sql</userinput>
 </programlisting>
 
         <para>
@@ -19271,7 +19271,7 @@
       </para>
 
 <programlisting>
-mysql --user=<replaceable>root</replaceable> -p<replaceable>my_pwd</replaceable> -e 'SHOW BINLOG EVENTS \G'
+mysql --user=<replaceable>root</replaceable> -p<replaceable>my_pwd</replaceable> -E -e 'SHOW BINLOG EVENTS'
 </programlisting>
 
       <para>
@@ -19349,7 +19349,8 @@
         </para>
 
 <programlisting>
-mysqlbinlog --start-date="2005-04-20 9:55:00" --stop-date="2005-04-20 10:05:00" \
+mysqlbinlog --start-date="2005-04-20 9:55:00" \
+      --stop-date="2005-04-20 10:05:00" \
       /var/log/mysql/bin.123456 &gt; /tmp/mysql_restore.sql
 </programlisting>
 
@@ -19396,10 +19397,12 @@
       <title>&title-table-maintenance;</title>
 
       <para>
-        The following sections discuss how to use
-        <command>myisamchk</command> to check or repair
-        <literal>MyISAM</literal> tables (tables with
-        <filename>.MYI</filename> and <filename>.MYD</filename> files).
+        This section discusses how to use <command>myisamchk</command>
+        to check or repair <literal>MyISAM</literal> tables (tables that
+        have <filename>.MYD</filename> and <filename>.MYI</filename>
+        files for storing data and indexes). For general
+        <command>myisamchk</command> background, see
+        <xref linkend="myisamchk"/>.
       </para>
 
       <para>

Modified: trunk/refman-5.1/client-utility-programs.xml
===================================================================
--- trunk/refman-5.1/client-utility-programs.xml	2006-01-23 02:34:40 UTC (rev 993)
+++ trunk/refman-5.1/client-utility-programs.xml	2006-01-23 02:35:01 UTC (rev 994)
@@ -466,9 +466,9 @@
           The <command>myisamchk</command> utility gets information
           about your database tables or checks, repairs, or optimizes
           them. <command>myisamchk</command> works with
-          <literal>MyISAM</literal> tables (tables with
-          <filename>.MYI</filename> and <filename>.MYD</filename>
-          files).
+          <literal>MyISAM</literal> tables (tables that have
+          <filename>.MYD</filename> and <filename>.MYI</filename> files
+          for storing data and indexes).
         </para>
 
         <para>
@@ -692,10 +692,9 @@
               Instead of terminating with an error if the table is
               locked, wait until the table is unlocked before
               continuing. Note that if you are running
-              <command>mysqld</command> with the
-              <option>--skip-external-locking</option> option, the table
-              can be locked only by another <command>myisamchk</command>
-              command.
+              <command>mysqld</command> with external locking disabled,
+              the table can be locked only by another
+              <command>myisamchk</command> command.
             </para>
           </listitem>
 
@@ -1031,7 +1030,7 @@
               Do a repair operation automatically if
               <command>myisamchk</command> finds any errors in the
               table. The repair type is the same as that specified with
-              the <option>--repair</option> or <option>-r</option>
+              the <option>--recover</option> or <option>-r</option>
               option.
             </para>
           </listitem>
@@ -1069,8 +1068,8 @@
               Don't mark the table as checked. This is useful if you use
               <command>myisamchk</command> to check a table that is in
               use by some other application that doesn't use locking,
-              such as <command>mysqld</command> when run with the
-              <option>--skip-external-locking</option> option.
+              such as <command>mysqld</command> when run with external
+              locking disabled.
             </para>
           </listitem>
 
@@ -1085,8 +1084,8 @@
               crashed. This should be used to get full benefit of the
               <option>--check-only-changed</option> option, but you
               shouldn't use this option if the <command>mysqld</command>
-              server is using the table and you are running it with the
-              <option>--skip-external-locking</option> option.
+              server is using the table and you are running it with
+              external locking disabled.
             </para>
           </listitem>
 
@@ -1122,7 +1121,7 @@
 
             <para>
               Make a backup of the <filename>.MYD</filename> file as
-              <filename>file_name-time.BAK</filename>
+              <filename><replaceable>file_name</replaceable>-<replaceable>time</replaceable>.BAK</filename>
             </para>
           </listitem>
 
@@ -1155,7 +1154,7 @@
 
             <para>
               Maximum length of the data file (when re-creating data
-              file when it's <quote>full</quote>).
+              file when it is <quote>full</quote>).
             </para>
           </listitem>
 
@@ -1166,7 +1165,7 @@
 
             <para>
               Do a repair that tries to recover every possible row from
-              the data file. Normally this also finds a lot of garbage
+              the data file. Normally, this also finds a lot of garbage
               rows. Don't use this option unless you are desperate.
             </para>
           </listitem>
@@ -1191,31 +1190,17 @@
 
             <para>
               For <command>myisamchk</command>, the option value is a
-              bit-value indicates which indexes to update. Each binary
-              bit of the option value corresponds to a table index,
-              where the first index is bit 0. An option value of 0
-              disables updates to all indexes, which can be used to get
-              faster inserts. Deactivated indexes can be reactivated by
-              using <command>myisamchk -r</command>.
+              bit-value that indicates which indexes to update. Each
+              binary bit of the option value corresponds to a table
+              index, where the first index is bit 0. An option value of
+              0 disables updates to all indexes, which can be used to
+              get faster inserts. Deactivated indexes can be reactivated
+              by using <command>myisamchk -r</command>.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <option>--no-symlinks</option>, <option>-l</option>
-            </para>
-
-            <para>
-              Do not follow symbolic links. Normally
-              <command>myisamchk</command> repairs the table that a
-              symlink points to. This option doesn't exist as of MySQL
-              4.0, because versions from 4.0 on do not remove symlinks
-              during repair operations.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
               <option>--parallel-recover</option>, <option>-p</option>
             </para>
 
@@ -1228,7 +1213,7 @@
                 Is this still the case in 5.1?
               </remark>
 
-              <emphasis>This is alpha code. Use at your own
+              <emphasis>This is alpha-quality code. Use at your own
               risk!</emphasis>
             </para>
           </listitem>
@@ -1256,11 +1241,11 @@
               keys that aren't unique (which is an extremely unlikely
               error with <literal>MyISAM</literal> tables). If you want
               to recover a table, this is the option to try first. You
-              should try <option>-o</option> only if
+              should try <option>--safe-recover</option> only if
               <command>myisamchk</command> reports that the table can't
-              be recovered using <option>-r</option>. (In the unlikely
-              case that <option>-r</option> fails, the data file remains
-              intact.)
+              be recovered using <option>--recover</option>. (In the
+              unlikely case that <option>--recover</option> fails, the
+              data file remains intact.)
             </para>
 
             <para>
@@ -1278,12 +1263,14 @@
               Do a repair using an old recovery method that reads
               through all rows in order and updates all index trees
               based on the rows found. This is an order of magnitude
-              slower than <option>-r</option>, but can handle a couple
-              of very unlikely cases that <option>-r</option> cannot.
-              This recovery method also uses much less disk space than
-              <option>-r</option>. Normally, you should repair first
-              with <option>-r</option>, and then with
-              <option>-o</option> only if <option>-r</option> fails.
+              slower than <option>--recover</option>, but can handle a
+              couple of very unlikely cases that
+              <option>--recover</option> cannot. This recovery method
+              also uses much less disk space than
+              <option>--recover</option>. Normally, you should repair
+              first with <option>--recover</option>, and then with
+              <option>--safe-recover</option> only if
+              <option>--recover</option> fails.
             </para>
 
             <para>
@@ -1294,24 +1281,12 @@
 
           <listitem>
             <para>
-              <option>--set-character-set=<replaceable>name</replaceable></option>
-              (<emphasis>OBSOLETE</emphasis>)
-            </para>
-
-            <para>
-              Not used in MySQL &current-series;. See
-              <option>--set-collation</option>.
-            </para>
-          </listitem>
-
-          <listitem>
-            <para>
               <option>--set-collation=<replaceable>name</replaceable></option>
             </para>
 
             <para>
-              Change the collation used to sort table indexes. The
-              character set name is implied by the first part of the
+              Specify the collation to use for sorting table indexes.
+              The character set name is implied by the first part of the
               collation name.
             </para>
           </listitem>
@@ -1380,13 +1355,13 @@
             </para>
 
             <para>
-              Analyze the distribution of keys. This improves join
+              Analyze the distribution of key values. This improves join
               performance by enabling the join optimizer to better
               choose the order in which to join the tables and which
-              keys it should use. To obtain information about the
+              indexes it should use. To obtain information about the key
               distribution, use a <command>myisamchk --description
               --verbose <replaceable>tbl_name</replaceable></command>
-              command or the <literal>SHOW KEYS FROM
+              command or the <literal>SHOW INDEX FROM
               <replaceable>tbl_name</replaceable></literal> statement.
             </para>
           </listitem>
@@ -1413,8 +1388,8 @@
               are existing records with
               <literal>AUTO_INCREMENT</literal> values this large). If
               <replaceable>value</replaceable> is not specified,
-              <literal>AUTO_INCREMENT</literal> number for new records
-              begins with the largest value currently in the table, plus
+              <literal>AUTO_INCREMENT</literal> numbers for new records
+              begin with the largest value currently in the table, plus
               one.
             </para>
           </listitem>
@@ -1426,7 +1401,8 @@
 
             <para>
               Sort the index tree blocks in high-low order. This
-              optimizes seeks and makes table scanning by key faster.
+              optimizes seeks and makes table scans that use indexes
+              faster.
             </para>
           </listitem>
 
@@ -1443,7 +1419,7 @@
               operations that use this index. (The first time you use
               this option to sort a table, it may be very slow.) To
               determine a table's index numbers, use <literal>SHOW
-              KEYS</literal>, which displays a table's indexes in the
+              INDEX</literal>, which displays a table's indexes in the
               same order that <command>myisamchk</command> sees them.
               Indexes are numbered beginning with 1.
             </para>
@@ -1477,34 +1453,35 @@
         <para>
           Memory allocation is important when you run
           <command>myisamchk</command>. <command>myisamchk</command>
-          uses no more memory than you specify with the
-          <option>-O</option> options. If you are going to use
-          <command>myisamchk</command> on very large tables, you should
-          first decide how much memory you want it to use. The default
-          is to use only about 3MB to perform repairs. By using larger
-          values, you can get <command>myisamchk</command> to operate
-          faster. For example, if you have more than 32MB RAM, you could
-          use options such as these (in addition to any other options
-          you might specify):
+          uses no more memory than its memory-related variables are set
+          to. If you are going to use <command>myisamchk</command> on
+          very large tables, you should first decide how much memory you
+          want it to use. The default is to use only about 3MB to
+          perform repairs. By using larger values, you can get
+          <command>myisamchk</command> to operate faster. For example,
+          if you have more than 32MB RAM, you could use options such as
+          these (in addition to any other options you might specify):
         </para>
 
 <programlisting>
-shell&gt; <userinput>myisamchk -O sort=16M -O key=16M -O read=1M -O write=1M ...</userinput>
+shell&gt; <userinput>myisamchk --sort_buffer_size=16M --key_buffer_size=16M \</userinput>
+           <userinput>--read_buffer_size=1M --write_buffer_size=1M ...</userinput>
 </programlisting>
 
         <para>
-          Using <option>-O sort=16M</option> should probably be enough
-          for most cases.
+          Using <option>--sort_buffer_size=16M</option> should probably
+          be enough for most cases.
         </para>
 
         <para>
           Be aware that <command>myisamchk</command> uses temporary
           files in <literal>TMPDIR</literal>. If
           <literal>TMPDIR</literal> points to a memory filesystem, you
-          may easily get out of memory errors. If this happens, set
-          <literal>TMPDIR</literal> to point at some directory located
-          on a filesystem with more space and run
-          <command>myisamchk</command> again.
+          may easily get out of memory errors. If this happens, run
+          <command>myisamchk</command> with the
+          <option>--tmpdir=<replaceable>path</replaceable></option>
+          option to specify some directory located on a filesystem that
+          has more space.
         </para>
 
         <para>
@@ -1516,7 +1493,7 @@
 
           <listitem>
             <para>
-              Double the size of the data file (the original one and a
+              Double the size of the data file (the original file and a
               copy). This space is not needed if you do a repair with
               <option>--quick</option>; in this case, only the index
               file is re-created. This space is needed on the same
@@ -1539,11 +1516,12 @@
               When using <option>--recover</option> or
               <option>--sort-recover</option> (but not when using
               <option>--safe-recover</option>), you need space for a
-              sort buffer. The amount of space required is:
+              sort buffer. The following formula yields the amount of
+              space required:
             </para>
 
 <programlisting>
-(<replaceable>largest_key</replaceable> + <replaceable>row_pointer_length</replaceable>) * <replaceable>number_of_rows</replaceable> * 2
+(<replaceable>largest_key</replaceable> + <replaceable>row_pointer_length</replaceable>) &times; <replaceable>number_of_rows</replaceable> &times; 2
 </programlisting>
 
             <para>
@@ -1561,7 +1539,7 @@
 
         <para>
           If you have a problem with disk space during repair, you can
-          try to use <option>--safe-recover</option> instead of
+          try <option>--safe-recover</option> instead of
           <option>--recover</option>.
         </para>
 

Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml	2006-01-23 02:34:40 UTC (rev 993)
+++ trunk/refman-5.1/database-administration.xml	2006-01-23 02:35:01 UTC (rev 994)
@@ -5373,7 +5373,7 @@
               own thread) during the <literal>Repair by
               sorting</literal> process. The default value is 1.
               <emphasis role="bold">Note</emphasis>: Multi-threaded
-              repair is still <emphasis>alpha</emphasis> quality code.
+              repair is still <emphasis>alpha-quality</emphasis> code.
             </para>
           </listitem>
 
@@ -18744,7 +18744,7 @@
           </para>
 
 <programlisting>
-shell&gt; <userinput>mysqlbinlog hostname-bin.[0-9]* | mysql</userinput>
+shell&gt; <userinput>mysqlbinlog binlog.[0-9]* | mysql</userinput>
 </programlisting>
 
           <para>
@@ -19052,7 +19052,7 @@
 
 <programlisting>
 shell&gt; <userinput>mysqldump --single-transaction --flush-logs --master-data=2</userinput>
-           --all-databases &gt; backup_sunday_1_PM.sql
+           <userinput>--all-databases &gt; backup_sunday_1_PM.sql</userinput>
 </programlisting>
 
         <para>
@@ -19119,7 +19119,7 @@
 
 <programlisting>
 shell&gt; <userinput>mysqldump --single-transaction --flush-logs --master-data=2</userinput>
-           --all-databases --delete-master-logs &gt; backup_sunday_1_PM.sql
+           <userinput>--all-databases --delete-master-logs &gt; backup_sunday_1_PM.sql</userinput>
 </programlisting>
 
         <para>
@@ -19281,7 +19281,7 @@
       </para>
 
 <programlisting>
-mysql --user=<replaceable>root</replaceable> -p<replaceable>my_pwd</replaceable> -e 'SHOW BINLOG EVENTS \G'
+mysql --user=<replaceable>root</replaceable> -p<replaceable>my_pwd</replaceable> -E -e 'SHOW BINLOG EVENTS'
 </programlisting>
 
       <para>
@@ -19359,7 +19359,8 @@
         </para>
 
 <programlisting>
-mysqlbinlog --start-date="2005-04-20 9:55:00" --stop-date="2005-04-20 10:05:00" \
+mysqlbinlog --start-date="2005-04-20 9:55:00" \
+      --stop-date="2005-04-20 10:05:00" \
       /var/log/mysql/bin.123456 &gt; /tmp/mysql_restore.sql
 </programlisting>
 
@@ -19406,10 +19407,12 @@
       <title>&title-table-maintenance;</title>
 
       <para>
-        The following sections discuss how to use
-        <command>myisamchk</command> to check or repair
-        <literal>MyISAM</literal> tables (tables with
-        <filename>.MYI</filename> and <filename>.MYD</filename> files).
+        This section discusses how to use <command>myisamchk</command>
+        to check or repair <literal>MyISAM</literal> tables (tables that
+        have <filename>.MYD</filename> and <filename>.MYI</filename>
+        files for storing data and indexes). For general
+        <command>myisamchk</command> background, see
+        <xref linkend="myisamchk"/>.
       </para>
 
       <para>

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