List:Commits« Previous MessageNext Message »
From:paul.dubois Date:September 28 2010 6:37pm
Subject:svn commit - mysqldoc@docsrva: r22888 - in trunk: . dynamic-docs/command-optvars refman-common
View as plain text  
Author: paul
Date: 2010-09-28 20:37:31 +0200 (Tue, 28 Sep 2010)
New Revision: 22888

Log:
 r63579@frost:  paul | 2010-09-28 13:36:52 -0500
 MySQL Proxy general edits


Modified:
   trunk/dynamic-docs/command-optvars/mysql-proxy.xml
   trunk/refman-common/mysql-proxy-core.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/mysqldoc/trunk:35498
07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/trunk:42410
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/trunk:44480
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:63577
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:39036
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/trunk:39546
   + 07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/mysqldoc/trunk:35498
07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/trunk:42410
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/trunk:44480
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:63579
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:39036
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/trunk:39546


Modified: trunk/dynamic-docs/command-optvars/mysql-proxy.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/mysql-proxy.xml	2010-09-28 16:19:06 UTC (rev 22887)
+++ trunk/dynamic-docs/command-optvars/mysql-proxy.xml	2010-09-28 18:37:31 UTC (rev 22888)
Changed blocks: 5, Lines Added: 11, Lines Deleted: 11; 2266 bytes

@@ -29,7 +29,7 @@
     <types>
       <optype class="cmdline" format="--help"/>
       <optype class="mycnf" format="help"/>
-      <optype class="cmdline" format="-?"/>
+      <optype class="cmdline" format="-h"/>
     </types>
 
     <versions>

@@ -142,8 +142,8 @@
     </shortdescription>
 
     <types>
-      <optype class="cmdline" format="--admin-username=user"/>
-      <optype class="mycnf" format="admin-username=user"/>
+      <optype class="cmdline" format="--admin-username=user_name"/>
+      <optype class="mycnf" format="admin-username=user_name"/>
     </types>
 
     <values vartype="string" platform="all">

@@ -194,8 +194,8 @@
     </shortdescription>
 
     <types>
-      <optype class="cmdline" format="--admin-lua-script=script"/>
-      <optype class="mycnf" format="admin-lua-script=script"/>
+      <optype class="cmdline" format="--admin-lua-script=file_name"/>
+      <optype class="mycnf" format="admin-lua-script=file_name"/>
     </types>
 
     <values vartype="filename" platform="all">

@@ -272,9 +272,9 @@
     </shortdescription>
 
     <types>
-      <optype class="cmdline" format="--proxy-backend-addresses"/>
-      <optype class="mycnf" format="proxy-backend-addresses"/>
-      <optype class="cmdline" format="-b"/>
+      <optype class="cmdline" format="--proxy-backend-addresses=host:port"/>
+      <optype class="mycnf" format="proxy-backend-addresses=host:port"/>
+      <optype class="cmdline" format="-b host:port"/>
     </types>
 
     <values vartype="string" platform="all">

@@ -344,9 +344,9 @@
     </shortdescription>
 
     <types>
-      <optype class="cmdline" format="--proxy-lua-script"/>
-      <optype class="mycnf" format="proxy-lua-script"/>
-      <optype class="cmdline" format="-s"/>
+      <optype class="cmdline" format="--proxy-lua-script=file_name"/>
+      <optype class="mycnf" format="proxy-lua-script=file_name"/>
+      <optype class="cmdline" format="-s file_name"/>
     </types>
 
     <values vartype="filename" platform="all"></values>


Modified: trunk/refman-common/mysql-proxy-core.xml
===================================================================
--- trunk/refman-common/mysql-proxy-core.xml	2010-09-28 16:19:06 UTC (rev 22887)
+++ trunk/refman-common/mysql-proxy-core.xml	2010-09-28 18:37:31 UTC (rev 22888)
Changed blocks: 92, Lines Added: 237, Lines Deleted: 179; 42702 bytes

@@ -195,13 +195,13 @@
       </para>
 
       <para>
-        To install, unpack the archive into the desired directory, and
-        then modify your <literal>PATH</literal> environment variable so
-        that you can use the <command>mysql-proxy</command> command
-        directly:
+        To install, unpack the archive into the desired directory, then
+        modify your <literal>PATH</literal> environment variable so that
+        you can use the <command>mysql-proxy</command> command directly:
       </para>
 
-<programlisting>shell&gt; cd /usr/local
+<programlisting>
+shell&gt; cd /usr/local
 shell&gt; tar zxf mysql-proxy-<replaceable>0.7.2</replaceable>-<replaceable>osx10.5</replaceable>.tar.gz
 shell&gt; PATH=$PATH:/usr/local/<replaceable>mysql-proxy-0.7.2-osx10.5-x86</replaceable>/sbin
 </programlisting>

@@ -241,7 +241,7 @@
         <listitem>
           <para>
             Under <guilabel>System Variables</guilabel>, select
-            <guimenuitem>Path</guimenuitem>, and then click the
+            <guimenuitem>Path</guimenuitem>, then click the
             <guibutton>Edit</guibutton> button. The <guimenu>Edit System
             Variable</guimenu> dialogue should appear.
           </para>

@@ -316,17 +316,21 @@
         installed, configure and build MySQL Proxy:
       </para>
 
-<programlisting>shell&gt; tar zxf mysql-proxy-<replaceable>0.7.2</replaceable>.tar.gz
+<programlisting>
+shell&gt; tar zxf mysql-proxy-<replaceable>0.7.2</replaceable>.tar.gz
 shell&gt; cd mysql-proxy-<replaceable>0.7.2</replaceable>
 shell&gt; ./configure
-shell&gt; make</programlisting>
+shell&gt; make
+</programlisting>
 
       <para>
         If you want to test the build, use the <literal>check</literal>
         target to <command>make</command>:
       </para>
 
-<programlisting>shell&gt; make check</programlisting>
+<programlisting>
+shell&gt; make check
+</programlisting>
 
       <para>
         The tests try to connect to <literal>localhost</literal> using

@@ -335,13 +339,17 @@
         variable:
       </para>
 
-<programlisting>shell&gt; MYSQL_PASSWORD=root_pwd make check</programlisting>
+<programlisting>
+shell&gt; MYSQL_PASSWORD=root_pwd make check
+</programlisting>
 
       <para>
         You can install using the <literal>install</literal> target:
       </para>
 
-<programlisting>shell&gt; make install</programlisting>
+<programlisting>
+shell&gt; make install
+</programlisting>
 
       <para>
         By default, <command>mysql-proxy</command> is installed into

@@ -432,7 +440,9 @@
         use <command>bzr</command>:
       </para>
 
-<programlisting>shell&gt; bzr branch lp:mysql-proxy</programlisting>
+<programlisting>
+shell&gt; bzr branch lp:mysql-proxy
+</programlisting>
 
       <para>
         The preceding command downloads a complete version of the Bazaar

@@ -444,7 +454,9 @@
         configuration scripts for you:
       </para>
 
-<programlisting>shell&gt; sh ./autogen.sh</programlisting>
+<programlisting>
+shell&gt; sh ./autogen.sh
+</programlisting>
 
       <para>
         The <command>autogen.sh</command> script creates the standard

@@ -452,9 +464,11 @@
         configure and build with <command>make</command>:
       </para>
 
-<programlisting>shell&gt; ./configure
+<programlisting>
+shell&gt; ./configure
 shell&gt; make
-shell&gt; make install</programlisting>
+shell&gt; make install
+</programlisting>
 
       <para>
         If you want to create a standalone source distribution,

@@ -462,7 +476,9 @@
         this command:
       </para>
 
-<programlisting>shell&gt; make distcheck</programlisting>
+<programlisting>
+shell&gt; make distcheck
+</programlisting>
 
       <para>
         The preceding command creates the file

@@ -523,7 +539,7 @@
 
       <listitem>
         <para>
-          For options that are a simple toggle on the command-line (for
+          For options that are a simple toggle on the command line (for
           example <option>--proxy-skip-profiling</option>, you must use
           <literal>true</literal> or <literal>false</literal>. For
           example, the following is invalid:

@@ -607,7 +623,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_help">
-          <literal>--help</literal>
+          <option>--help</option>, <option>-h</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help"/>

@@ -619,7 +635,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_help-all">
-          <literal>--help-all</literal>
+          <option>--help-all</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-all"/>

@@ -631,7 +647,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_help-admin">
-          <literal>--help-admin </literal>
+          <option>--help-admin</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-admin"/>

@@ -643,7 +659,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_help-proxy">
-          <literal>--help-proxy</literal>
+          <option>--help-proxy</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-proxy"/>

@@ -655,7 +671,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_admin-address">
-          <literal>--admin-address=<replaceable>host</replaceable>:<replaceable>port</replaceable></literal>
+          <option>--admin-address=<replaceable>host</replaceable>:<replaceable>port</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-address"/>

@@ -668,7 +684,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_admin-lua-script">
-          <literal>--admin-lua-script=<replaceable>file_name</replaceable></literal>
+          <option>--admin-lua-script=<replaceable>file_name</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-lua-script"/>

@@ -680,7 +696,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_admin-password">
-          <literal>--admin-password=<replaceable>password</replaceable></literal>
+          <option>--admin-password=<replaceable>password</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-password"/>

@@ -696,7 +712,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_admin-username">
-          <literal>--admin-username=<replaceable>user</replaceable></literal>
+          <option>--admin-username=<replaceable>user_name</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-username"/>

@@ -713,7 +729,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_basedir">
-          <literal>--basedir=<replaceable>path</replaceable></literal>
+          <option>--basedir=<replaceable>path</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:basedir"/>

@@ -728,8 +744,20 @@
       </listitem>
 
       <listitem>
+        <para id="option_mysql-proxy_daemon">
+          <option>--daemon</option>
+        </para>
+
+        <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:daemon"/>
+
+        <para>
+          Starts the proxy in daemon mode.
+        </para>
+      </listitem>
+
+      <listitem>
         <para id="option_mysql-proxy_defaults-file">
-          <literal>--defaults-file=<replaceable>file_name</replaceable></literal>
+          <option>--defaults-file=<replaceable>file_name</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:defaults-file"/>

@@ -742,7 +770,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_event-threads">
-          <literal>--event-threads=<replaceable>count</replaceable></literal>
+          <option>--event-threads=<replaceable>count</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:event-threads"/>

@@ -755,7 +783,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_keepalive">
-          <literal>--keepalive</literal>
+          <option>--keepalive</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:keepalive"/>

@@ -779,7 +807,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_log-backtrace-on-crash">
-          <literal>--log-backtrace-on-crash</literal>
+          <option>--log-backtrace-on-crash</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-backtrace-on-crash"/>

@@ -792,7 +820,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_log-file">
-          <literal>--log-file=<replaceable>file_name</replaceable></literal>
+          <option>--log-file=<replaceable>file_name</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-file"/>

@@ -804,7 +832,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_log-level">
-          <literal>--log-level=<replaceable>level</replaceable></literal>
+          <option>--log-level=<replaceable>level</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-level"/>

@@ -821,7 +849,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_log-use-syslog">
-          <literal>--log-use-syslog</literal>
+          <option>--log-use-syslog</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-use-syslog"/>

@@ -833,7 +861,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_lua-cpath">
-          <literal>--lua-cpath=<replaceable>path</replaceable></literal>
+          <option>--lua-cpath=<replaceable>path</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:lua-cpath"/>

@@ -846,7 +874,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_lua-path">
-          <literal>--lua-path=<replaceable>path</replaceable></literal>
+          <option>--lua-path=<replaceable>path</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:lua-path"/>

@@ -859,7 +887,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_max-open-files">
-          <literal>--max-open-files=<replaceable>count</replaceable></literal>
+          <option>--max-open-files=<replaceable>count</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:max-open-files"/>

@@ -873,7 +901,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_no-proxy">
-          <literal>--no-proxy</literal>
+          <option>--no-proxy</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:no-proxy"/>

@@ -885,7 +913,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_plugin-dir">
-          <literal>--plugin-dir=<replaceable>path</replaceable></literal>
+          <option>--plugin-dir=<replaceable>path</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:plugin-dir"/>

@@ -898,7 +926,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_plugins">
-          <literal>--plugins=<replaceable>plugin</replaceable>,...</literal>
+          <option>--plugins=<replaceable>plugin</replaceable>,...</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:plugins"/>

@@ -910,7 +938,9 @@
 
       <listitem>
         <para id="option_mysql-proxy_proxy-address">
-          <literal>--proxy-address=<replaceable>host</replaceable>:<replaceable>port</replaceable></literal>
+          <option>--proxy-address=<replaceable>host</replaceable>:<replaceable>port</replaceable></option>,
+          <option>-P
+          <replaceable>host</replaceable>:<replaceable>port</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-address"/>

@@ -924,7 +954,9 @@
 
       <listitem>
         <para id="option_mysql-proxy_proxy-read-only-backend-addresses">
-          <literal>--proxy-read-only-backend-addresses=<replaceable>host</replaceable>:<replaceable>port</replaceable></literal>
+          <option>--proxy-read-only-backend-addresses=<replaceable>host</replaceable>:<replaceable>port</replaceable></option>,
+          <option>-r
+          <replaceable>host</replaceable>:<replaceable>port</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-read-only-backend-addresses"/>

@@ -952,7 +984,7 @@
         </note>
 
         <para>
-          When using this option on the command-line, you can specify
+          When using this option on the command line, you can specify
           the option and the server multiple times to specify multiple
           backends. For example:
         </para>

@@ -974,7 +1006,9 @@
 
       <listitem>
         <para id="option_mysql-proxy_proxy-backend-addresses">
-          <literal>--proxy-backend-addresses=<replaceable>host</replaceable>:<replaceable>port</replaceable></literal>
+          <option>--proxy-backend-addresses=<replaceable>host</replaceable>:<replaceable>port</replaceable></option>,
+          <option>-b
+          <replaceable>host</replaceable>:<replaceable>port</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:backend-addresses"/>

@@ -990,7 +1024,7 @@
         </para>
 
         <para>
-          When using this option on the command-line, you can specify
+          When using this option on the command line, you can specify
           the option and the server multiple times to specify multiple
           backends. For example:
         </para>

@@ -1012,7 +1046,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_proxy-pool-no-change-user">
-          <literal>--proxy-pool-no-change-user</literal>
+          <option>--proxy-pool-no-change-user</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-pool-no-change-user"/>

@@ -1027,7 +1061,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_proxy-skip-profiling">
-          <literal>--proxy-skip-profiling </literal>
+          <option>--proxy-skip-profiling</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-skip-profiling"/>

@@ -1040,7 +1074,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_proxy-fix-bug-25371">
-          <literal>--proxy-fix-bug-25371 </literal>
+          <option>--proxy-fix-bug-25371</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-fix-bug-25371"/>

@@ -1054,7 +1088,8 @@
 
       <listitem>
         <para id="option_mysql-proxy_proxy-lua-script">
-          <literal>--proxy-lua-script=<replaceable>file_name</replaceable></literal>
+          <option>--proxy-lua-script=<replaceable>file_name</replaceable></option>,
+          <option>-s <replaceable>file_name</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-lua-script"/>

@@ -1064,27 +1099,14 @@
           not physically loaded and parsed until a connection is made.
           Also note that the specified Lua script is reloaded for each
           connection; if the content of the Lua script changes while
-          <command>mysql-proxy</command> is running then the updated
-          content will automatically be used when a new connection is
-          made.
+          <command>mysql-proxy</command> is running, the updated content
+          is automatically used when a new connection is made.
         </para>
       </listitem>
 
       <listitem>
-        <para id="option_mysql-proxy_daemon">
-          <literal>--daemon</literal>
-        </para>
-
-        <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:daemon"/>
-
-        <para>
-          Starts the proxy in daemon mode.
-        </para>
-      </listitem>
-
-      <listitem>
         <para id="option_mysql-proxy_pid-file">
-          <literal>--pid-file=<replaceable>file_name</replaceable></literal>
+          <option>--pid-file=<replaceable>file_name</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:pid-file"/>

@@ -1096,7 +1118,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_user">
-          <literal>--user=<replaceable>user_name</replaceable></literal>
+          <option>--user=<replaceable>user_name</replaceable></option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:user"/>

@@ -1109,7 +1131,7 @@
 
       <listitem>
         <para id="option_mysql-proxy_version">
-          <literal>--version</literal>
+          <option>--version</option>, <option>-V</option>
         </para>
 
         <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:version"/>

@@ -1123,7 +1145,7 @@
 
     <para>
       The most common usage is as a simple proxy service (that is,
-      without addition scripting). For basic proxy operation you must
+      without additional scripting). For basic proxy operation, you must
       specify at least one <literal>proxy-backend-addresses</literal>
       option to specify the MySQL server to connect to by default:
     </para>

@@ -1143,10 +1165,10 @@
 </programlisting>
 
     <para>
-      If your server requires authentication information then this will
-      be passed through natively without alteration by
+      If your server requires authentication information, this will be
+      passed through natively without alteration by
       <command>mysql-proxy</command>, so you must also specify the
-      authentication information if required:
+      required authentication information:
     </para>
 
 <programlisting>

@@ -1161,7 +1183,7 @@
       the read-only port. By default the host name is the default, and
       the port is <literal>4042</literal>, but you can alter the
       host/port information by using the
-      <literal>--proxy-read-only-address</literal> command-line option.
+      <option>--proxy-read-only-address</option> command-line option.
     </para>
 
     <para>

@@ -1177,9 +1199,9 @@
 
       <para>
         The MySQL distribution on Windows includes the
-        <command>mysql-proxy-svc.exe</command> command, that enables a
+        <command>mysql-proxy-svc.exe</command> command that enables a
         MySQL Proxy instance to be managed by the Windows service
-        control manager. This allows you to control the service without
+        control manager. This enables you to control the service without
         separately running the MySQL Proxy application, and allows for
         automatically starting and stopping the MySQL Proxy service
         during boot, reboot and shutdown.

@@ -1188,12 +1210,11 @@
       <para>
         To set up a MySQL Proxy service, you must use the
         <command>sc</command> command to create a new service using the
-        MySQL Proxy service command. To create, use
-        <command>sc</command> to specify the MySQL Proxy options on the
-        command-line, and identify the service with a unique name. For
-        example, to configure a new MySQL Proxy instance that will
-        automatically start when your system boots, redirecting queries
-        to the local MySQL server:
+        MySQL Proxy service command. Specify the MySQL Proxy options on
+        the <command>sc</command> command line, and identify the service
+        with a unique name. For example, to configure a new MySQL Proxy
+        instance that will automatically start when your system boots,
+        redirecting queries to the local MySQL server:
       </para>
 
 <programlisting>

@@ -1204,17 +1225,17 @@
 
       <note>
         <para>
-          The spaces are the equals sign after each property is
-          required; failure to included it will result in an error.
+          The space following the equals sign after each property is
+          required; failure to include it results in an error.
         </para>
       </note>
 
       <para>
         The preceding command creates a new service called
         <literal>Proxy</literal>. You can start and stop the service
-        using the <literal>net start|stop</literal> with the service
-        name. The service is not automatically started after it has been
-        created. To start the service:
+        using the <literal>net start|stop</literal> command with the
+        service name. The service is not automatically started after it
+        has been created. To start the service:
       </para>
 
 <programlisting>

@@ -1231,7 +1252,7 @@
       </para>
 
       <para>
-        You can delete a service that you have created using:
+        You can delete a service that you have created:
       </para>
 
 <programlisting>

@@ -1262,8 +1283,8 @@
     </para>
 
     <para>
-      An overview of the classes exposed by MySQL Proxy is shown in the
-      following diagram.
+      The following diagram shows an overview of the classes exposed by
+      MySQL Proxy.
     </para>
 
     <mediaobject>

@@ -1341,10 +1362,10 @@
           <function>read_query_result()</function>: This function is
           called each time a result is returned from the server,
           providing you have manually injected queries into the query
-          queue. If you have not explicitly inject queries within the
-          <function>read_query()</function> function then this function
-          is not triggered. You can use this to edit the result set, or
-          to remove or filter the result sets generated from additional
+          queue. If you have not explicitly injected queries within the
+          <function>read_query()</function> function, this function is
+          not triggered. You can use this to edit the result set, or to
+          remove or filter the result sets generated from additional
           queries you injected into the queue when using
           <function>read_query()</function>.
         </para>

@@ -1353,8 +1374,8 @@
     </itemizedlist>
 
     <para>
-      The following table describes the direction of flow of information
-      at the point when the function is triggered.
+      The following table describes the direction of information flow at
+      the point when the function is triggered.
     </para>
 
     <informaltable>

@@ -1405,13 +1426,13 @@
     </informaltable>
 
     <para>
-      By default, all functions return a result that indicates that the
-      data should be passed on to the client or server (depending on the
-      direction of the information being transferred). This return value
-      can be overridden by explicitly returning a constant indicating
-      that a particular response should be sent. For example, it is
-      possible to construct result set information by hand within
-      <function>read_query()</function> and to return the resultset
+      By default, all functions return a result that indicates whether
+      the data should be passed on to the client or server (depending on
+      the direction of the information being transferred). This return
+      value can be overridden by explicitly returning a constant
+      indicating that a particular response should be sent. For example,
+      it is possible to construct result set information by hand within
+      <function>read_query()</function> and to return the result set
       directly to the client without ever sending the original query to
       the server.
     </para>

@@ -1433,10 +1454,10 @@
         used when injecting queries into the query queue. Because the
         proxy sits between the client and MySQL server, what the proxy
         sends to the server, and the information that the proxy
-        ultimately returns to the client do not have to match or
+        ultimately returns to the client, do not have to match or
         correlate. Once the client has connected to the proxy, the
-        following sequence occurs for each individual query sent by the
-        client.
+        sequence shown in the following diagram occurs for each
+        individual query sent by the client.
       </para>
 
       <mediaobject>

@@ -1452,7 +1473,7 @@
 
         <listitem>
           <para>
-            The client submits one query to the proxy, the
+            When the client submits one query to the proxy, the
             <function>read_query()</function> function within the proxy
             is triggered. The function adds the query to the query
             queue.

@@ -1486,15 +1507,19 @@
         the original query, changing the original query:
       </para>
 
-<programlisting>SELECT * FROM City;</programlisting>
+<programlisting>
+SELECT * FROM City;
+</programlisting>
 
       <para>
         Into a sequence of queries:
       </para>
 
-<programlisting>SELECT NOW();
+<programlisting>
+SELECT NOW();
 SELECT * FROM City;
-SELECT NOW();</programlisting>
+SELECT NOW();
+</programlisting>
 
       <para>
         You can also modify the original statement, for example to add

@@ -1504,8 +1529,10 @@
         statements:
       </para>
 
-<programlisting>SELECT * FROM City;
-EXPLAIN SELECT * FROM City;</programlisting>
+<programlisting>
+SELECT * FROM City;
+EXPLAIN SELECT * FROM City;
+</programlisting>
 
       <para>
         In both of these examples, the client would have received more

@@ -1524,8 +1551,8 @@
         additional result set information and return only the result set
         the client originally requested back to the client. You can
         achieve this by giving each query that you add to the query
-        queue a unique ID, and then filter out queries that do not match
-        the original query ID when processing them with
+        queue a unique ID, then filter out queries that do not match the
+        original query ID when processing them with
         <function>read_query_result()</function>.
       </para>
 

@@ -1617,11 +1644,11 @@
           <tbody>
             <row>
               <entry><literal>client.default_db</literal></entry>
-              <entry>Default database request by the client</entry>
+              <entry>Default database requested by the client</entry>
             </row>
             <row>
               <entry><literal>client.username</literal></entry>
-              <entry>Username used to authenticate</entry>
+              <entry>User name used to authenticate</entry>
             </row>
             <row>
               <entry><literal>client.scrambled_password</literal></entry>

@@ -1774,7 +1801,7 @@
         The <literal>proxy.queries</literal> object is a queue
         representing the list of queries to be sent to the server. The
         queue is not populated automatically, but if you do not
-        explicitly populate the queue then queries are passed on to the
+        explicitly populate the queue, queries are passed on to the
         backend server verbatim. Also, if you do not populate the query
         queue by hand, the <function>read_query_result()</function>
         function is not triggered.

@@ -1830,7 +1857,9 @@
         <function>append()</function>:
       </para>
 
-<programlisting>proxy.queries:append(1,packet)</programlisting>
+<programlisting>
+proxy.queries:append(1,packet)
+</programlisting>
 
       <para>
         The optional third argument to <function>append()</function>

@@ -1840,7 +1869,9 @@
         the <literal>resultset_is_needed</literal> flag to true:
       </para>
 
-<programlisting>proxy.queries:append( 1, packet, { resultset_is_needed = true } )</programlisting>
+<programlisting>
+proxy.queries:append( 1, packet, { resultset_is_needed = true } )
+</programlisting>
 
       <para>
         If that flag is false (the default), proxy will:

@@ -1850,14 +1881,13 @@
 
         <listitem>
           <para>
-            Send the resultset to the client as soon as the resultset is
-            received
+            Send the result set to the client as soon as it is received
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Reduce memory usage (because the resultset is not stored
+            Reduce memory usage (because the result set is not stored
             internally for processing)
           </para>
         </listitem>

@@ -1890,20 +1920,20 @@
 
         <listitem>
           <para>
-            Store the resultset so that it can be processed
+            Store the result set so that it can be processed
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Enable modification of the resultset before it is returned
+            Enable modification of the result set before it is returned
             to the client
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Enable you to discard the resultset in place of returning it
+            Enable you to discard the result set instead of returning it
             to the client
           </para>
         </listitem>

@@ -1966,9 +1996,10 @@
         want to return, or set <literal>proxy.response.type</literal> to
         <literal>proxy.MYSQLD_PACKET_ERR</literal> and set the
         <literal>proxy.response.errmsg</literal> to a string with the
-        error message. To send the completed resultset or error message,
-        you should return the <literal>proxy.PROXY_SEND_RESULT</literal>
-        to trigger the return of the packet information.
+        error message. To send the completed result set or error
+        message, you should return the
+        <literal>proxy.PROXY_SEND_RESULT</literal> to trigger the return
+        of the packet information.
       </para>
 
       <para>

@@ -1977,7 +2008,8 @@
         MySQL Proxy package:
       </para>
 
-<programlisting>if string.lower(command) == "show" and string.lower(option) == "querycounter" then
+<programlisting>
+if string.lower(command) == "show" and string.lower(option) == "querycounter" then
         ---
         -- proxy.PROXY_SEND_RESULT requires
         --

@@ -2045,7 +2077,7 @@
             </row>
             <row>
               <entry><literal>flags</literal></entry>
-              <entry>A number of flags related to the resultset. Valid flags include
+              <entry>A number of flags related to the result set. Valid flags include
                 <literal>auto_commit</literal> (whether an automatic
                 commit was triggered),
                 <literal>no_good_index_used</literal> (the query

@@ -2134,7 +2166,9 @@
         <literal>PROXY_IGNORE_RESULT:</literal>
       </para>
 
-<programlisting>return proxy.PROXY_IGNORE_RESULT</programlisting>
+<programlisting>
+return proxy.PROXY_IGNORE_RESULT
+</programlisting>
 
       <para id="mysql-proxy-scripting-structures-packet-states">
         <emphasis role="bold">Packet State Constants</emphasis>

@@ -2534,15 +2568,16 @@
       </para>
 
       <para>
-        For example, if you have multiple backend servers then you can
-        set the server to be used by that connection by setting the
-        value of <literal>proxy.connection.backend_ndx</literal> to a
-        valid server number. The following code will choose between two
+        For example, if you have multiple backend servers, you can set
+        the server to be used by that connection by setting the value of
+        <literal>proxy.connection.backend_ndx</literal> to a valid
+        server number. The following code will choose between two
         servers based on whether the current time in minutes is odd or
         even:
       </para>
 
-<programlisting>function connect_server()
+<programlisting>
+function connect_server()
         print("--> a client really wants to talk to a server")
         if (tonumber(os.date("%M")) % 2 == 0) then
                 proxy.connection.backend_ndx = 2

@@ -2552,7 +2587,8 @@
                 print("Choosing backend 1")
         end
         print("Using " .. proxy.global.backends[proxy.connection.backend_ndx].dst.name)
-end</programlisting>
+end
+</programlisting>
 
       <para>
         In this example the IP address/port combination is also

@@ -2621,7 +2657,8 @@
         clients by IP address with the following function:
       </para>
 
-<programlisting>function read_handshake()
+<programlisting>
+function read_handshake()
         print("&lt;-- let's send him some information about us")
         print("    mysqld-version: " .. proxy.connection.server.mysqld_version)
         print("    thread-id     : " .. proxy.connection.server.thread_id)

@@ -2637,7 +2674,8 @@
 
                 return proxy.PROXY_SEND_RESULT
         end
-end</programlisting>
+end
+</programlisting>
 
       <para>
         Note that you have to return an error packet to the client by

@@ -2673,10 +2711,12 @@
         during authorization using:
       </para>
 
-<programlisting>function read_auth()
+<programlisting>
+function read_auth()
         print("    username      : " .. proxy.connection.client.username)
         print("    password      : " .. string.format("%q", proxy.connection.client.scrambled_password))
-end</programlisting>
+end
+</programlisting>
 
       <para>
         You can interrupt the authentication process within this

@@ -2685,7 +2725,8 @@
         <literal>proxy.PROXY_SEND_RESULT</literal>:
       </para>
 
-<programlisting>proxy.response.type = proxy.MYSQLD_PACKET_ERR
+<programlisting>
+proxy.response.type = proxy.MYSQLD_PACKET_ERR
 proxy.response.errmsg = "Logins are not allowed"
 return proxy.PROXY_SEND_RESULT
 </programlisting>

@@ -2708,7 +2749,8 @@
         identify whether the authentication was successful:
       </para>
 
-<programlisting>function read_auth_result(auth)
+<programlisting>
+function read_auth_result(auth)
         local state = auth.packet:byte()
 
         if state == proxy.MYSQLD_PACKET_OK then

@@ -2718,7 +2760,8 @@
         else
                 print("&lt;-- auth ... don't know: " .. string.format("%q", auth.packet));
         end
-end</programlisting>
+end
+</programlisting>
 
       <para>
         If a long-password capable client tries to authenticate to a

@@ -2752,17 +2795,19 @@
         contents using the following function definition:
       </para>
 
-<programlisting>function read_query( packet )
+<programlisting>
+function read_query( packet )
         if packet:byte() == proxy.COM_QUERY then
                 print("we got a normal query: " .. packet:sub(2))
         end
-end</programlisting>
+end
+</programlisting>
 
       <para>
         This example checks the first byte of the packet to determine
         the type. If the type is <literal>COM_QUERY</literal> (see
         <xref linkend="mysql-proxy-scripting-structures-command-constants"/>),
-        then we extract the query from the packet and print it out. The
+        we extract the query from the packet and print it out. The
         structure of the packet type supplied is important. In the case
         of a <literal>COM_QUERY</literal> packet, the remaining contents
         of the packet are the text of the query string. In this example,

@@ -2772,8 +2817,8 @@
 
       <para>
         To modify a query, or add new queries, you must populate the
-        query queue (<literal>proxy.queries</literal>) and then execute
-        the queries that you have placed into the queue. If you do not
+        query queue (<literal>proxy.queries</literal>), then execute the
+        queries that you have placed into the queue. If you do not
         modify the original query or the queue, the query received from
         the client is sent to the MySQL server verbatim.
       </para>

@@ -2817,9 +2862,9 @@
             ID you specify is returned with the result set so that you
             identify each query and corresponding result set. The ID has
             no other purpose than as an identifier for correlating the
-            query and resultset. When operating in a passive mode,
+            query and result set. When operating in a passive mode,
             during profiling for example, you want to identify the
-            original query and the corresponding resultset so that the
+            original query and the corresponding result set so that the
             results expect by the client can be returned correctly.
           </para>
         </listitem>

@@ -2856,9 +2901,9 @@
         The <function>read_query_result()</function> is called for each
         result set returned by the server only if you have manually
         injected queries into the query queue. If you have not
-        manipulated the query queue then this function is not called.
-        The function supports a single argument, the result packet,
-        which provides a number of properties:
+        manipulated the query queue, this function is not called. The
+        function supports a single argument, the result packet, which
+        provides a number of properties:
       </para>
 
       <itemizedlist>

@@ -2870,7 +2915,7 @@
             submitted to the server when using
             <function>append(id)</function> on the query queue. You must
             have set the <literal>resultset_is_needed</literal> flag to
-            <function>append</function> to intercept the resultset
+            <function>append</function> to intercept the result set
             before it is returned to the client. See
             <xref linkend="mysql-proxy-scripting-structures-queries"/>.
           </para>

@@ -2919,7 +2964,8 @@
         query) for each query sent to the server:
       </para>
 
-<programlisting>function read_query( packet )
+<programlisting>
+function read_query( packet )
         if packet:byte() == proxy.COM_QUERY then
                 print("we got a normal query: " .. packet:sub(2))
 

@@ -2932,20 +2978,23 @@
 function read_query_result(inj)
         print("query-time: " .. (inj.query_time / 1000) .. "ms")
         print("response-time: " .. (inj.response_time / 1000) .. "ms")
-end</programlisting>
+end
+</programlisting>
 
       <para>
-        You can access the rows of returned results from the resultset
-        by accessing the rows property of the resultset property of the
-        result that is exposed through
-        <function>read_query_result()</function>. For example, you can
-        iterate over the results showing the first column from each row
-        using this Lua fragment:
+        You can access the rows of returned results from the result set
+        by accessing the <literal>rows</literal> property of the
+        <literal>resultset</literal> property of the result that is
+        exposed through <function>read_query_result()</function>. For
+        example, you can iterate over the results showing the first
+        column from each row using this Lua fragment:
       </para>
 
-<programlisting>for row in inj.resultset.rows do
+<programlisting>
+for row in inj.resultset.rows do
         print("injected query returned: " .. row[1])
-end</programlisting>
+end
+</programlisting>
 
       <para>
         Just like <function>read_query()</function>,

@@ -2972,7 +3021,8 @@
         MySQL client.
       </para>
 
-<programlisting>function read_query( packet )
+<programlisting>
+function read_query( packet )
         if packet:byte() == proxy.COM_QUERY then
                 proxy.queries:append(2, string.char(proxy.COM_QUERY) .. "SELECT NOW()", {resultset_is_needed = true} )
                 proxy.queries:append(1, packet, {resultset_is_needed = true})

@@ -2993,7 +3043,8 @@
                 print("query-time: " .. (inj.query_time / 1000) .. "ms")
                 print("response-time: " .. (inj.response_time / 1000) .. "ms")
         end
-end</programlisting>
+end
+</programlisting>
 
       <para>
         For further examples, see <xref linkend="mysql-proxy-using"/>.

@@ -3015,19 +3066,23 @@
       connect to on the command line:
     </para>
 
-<programlisting>shell&gt; mysql-proxy --proxy-backend-addresses=sakila:3306</programlisting>
+<programlisting>
+shell&gt; mysql-proxy --proxy-backend-addresses=sakila:3306
+</programlisting>
 
     <para>
-      If you specify multiple backend MySQL servers then the proxy will
-      connect each client to each server in a round-robin fashion. For
-      example, imagine you have two MySQL servers, A and B. The first
-      client to connect will be connected to server A, the second to
-      server B, the third to server A. For example:
+      If you specify multiple backend MySQL servers, the proxy connects
+      each client to each server in a round-robin fashion. For example,
+      imagine you have two MySQL servers, A and B. The first client to
+      connect is connected to server A, the second to server B, the
+      third to server A. For example:
     </para>
 
-<programlisting>shell&gt; mysql-proxy \
+<programlisting>
+shell&gt; mysql-proxy \
      --proxy-backend-addresses=narcissus:3306 \
-     --proxy-backend-addresses=nostromo:3306</programlisting>
+     --proxy-backend-addresses=nostromo:3306
+</programlisting>
 
     <para>
       When you have specified multiple servers in this way, the proxy

@@ -3114,7 +3169,7 @@
       Returning custom result sets can enable to combine or simplify
       information, and even to return custom information
       directly from a query. To achieve this you must construct your own
-      resultset information to be returned to the client. For an example
+      result set information to be returned to the client. For an example
       of this in action, see
       <xref linkend="mysql-proxy-using-customresultset"/>.
     </para>

@@ -3158,7 +3213,8 @@
         the following script, written by Diego Medina:
       </para>
 
-<programlisting>--[[
+<programlisting>
+--[[
 
    Copyright 2008, 2010, Oracle and/or its affiliates. All rights reserved.
    

@@ -3365,7 +3421,8 @@
         <filename>reporter.lua</filename>:
       </para>
 
-<programlisting>--[[
+<programlisting>
+--[[
 
    Copyright 2008, 2010, Oracle and/or its affiliates. All rights reserved.
    

@@ -3449,14 +3506,14 @@
       <para>
         To use the script, save the first script to a file
         (<filename>admin.lua</filename> in the following example) and
-        the other to <filename>reporter.lua</filename>, and then run
+        the other to <filename>reporter.lua</filename>, then run
         <command>mysql-proxy</command> specifying the admin script and a
         backend MySQL server:
       </para>
 
-<programlisting>shell&gt; mysql-proxy --admin-lua-script=admin.lua --admin-password=password \ &raquo;
+<programlisting>
+shell&gt; mysql-proxy --admin-lua-script=admin.lua --admin-password=password \ &raquo;
      --admin-username=root --proxy-backend-addresses=127.0.0.1:3306 -proxy-lua-script=reporter.lua
-
 </programlisting>
 
       <para>

@@ -3497,7 +3554,8 @@
         the current active processes:
       </para>
 
-<programlisting>mysql&gt;  show proxy processlist;
+<programlisting>
+mysql&gt;  show proxy processlist;
 +---------+---------------------+--------------------------+
 | Id      | IP Address          | Time                     |
 +---------+---------------------+--------------------------+


Thread
svn commit - mysqldoc@docsrva: r22888 - in trunk: . dynamic-docs/command-optvars refman-commonpaul.dubois28 Sep