Author: mcbrown
Date: 2010-01-22 12:30:46 +0100 (Fri, 22 Jan 2010)
New Revision: 18790
Log:
Minor reformat
Modified:
trunk/refman-common/mysql-proxy-core.xml
Modified: trunk/refman-common/mysql-proxy-core.xml
===================================================================
--- trunk/refman-common/mysql-proxy-core.xml 2010-01-22 11:04:21 UTC (rev 18789)
+++ trunk/refman-common/mysql-proxy-core.xml 2010-01-22 11:30:46 UTC (rev 18790)
Changed blocks: 23, Lines Added: 69, Lines Deleted: 67; 15631 bytes
@@ -53,7 +53,9 @@
communicating with anything but a genuine MySQL server.
</para>
- <para>This documentation covers MySQL Proxy &mysql-proxy-current-version;.</para>
+ <para>
+ This documentation covers MySQL Proxy &mysql-proxy-current-version;.
+ </para>
<warning>
<para>
@@ -583,60 +585,60 @@
<itemizedlist>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help"/>
-
<para id="option_mysql-proxy_help">
<literal>--help</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help"/>
+
<para>
Show available help options.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-all"/>
-
<para id="option_mysql-proxy_help-all">
<literal>--help-all</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-all"/>
+
<para>
Show all help options.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-admin"/>
-
<para id="option_mysql-proxy_help-admin">
<literal>--help-admin </literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-admin"/>
+
<para>
Show options for the admin-module.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-proxy"/>
-
<para id="option_mysql-proxy_help-proxy">
<literal>--help-proxy</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:help-proxy"/>
+
<para>
Show options for the proxy-module.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-address"/>
-
<para id="option_mysql-proxy_admin-address">
<literal>--admin-address=host:port</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-address"/>
+
<para>
The host name (or IP address) and port for the administration
port. The default is <literal>localhost:4041</literal>.
@@ -644,24 +646,24 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-lua-script"/>
-
<para id="option_mysql-proxy_admin-lua-script">
<literal>--admin-lua-script=script</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-lua-script"/>
+
<para>
The script to use for the administration module for the proxy.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-password"/>
-
<para id="option_mysql-proxy_admin-password">
<literal>--admin-password=pass</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-password"/>
+
<para>
The password to use to authenticate users wanting to connect
to the administration module of
@@ -672,12 +674,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-username"/>
-
<para id="option_mysql-proxy_admin-username">
<literal>--admin-username=user</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:admin-username"/>
+
<para>
The username to use to authenticate users wanting to connect
to the administration module of
@@ -689,12 +691,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:basedir"/>
-
<para id="option_mysql-proxy_basedir">
<literal>--basedir</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:basedir"/>
+
<para>
The base directory that will be prepended to all other
filename configuration options. The base name should be an
@@ -705,12 +707,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:defaults-file"/>
-
<para id="option_mysql-proxy_defaults-file">
<literal>--defaults-file</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:defaults-file"/>
+
<para>
The file to use as the file with configuration information. If
not specified, configuration options are only taken from the
@@ -719,12 +721,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:event-threads"/>
-
<para id="option_mysql-proxy_event-threads">
<literal>--event-threads=#</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:event-threads"/>
+
<para>
The number of event threads reserved to handle incoming
requests.
@@ -732,12 +734,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:keepalive"/>
-
<para id="option_mysql-proxy_keepalive">
<literal>--keepalive</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:keepalive"/>
+
<para>
Creates a process surrounding the main
<command>mysql-proxy</command> which will attempt to restart
@@ -747,12 +749,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-backtrace-on-crash"/>
-
<para id="option_mysql-proxy_log-backtrace-on-crash">
<literal>--log-backtrace-on-crash</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-backtrace-on-crash"/>
+
<para>
Logs the backtrace to the error log and tries to initialize
the debugger in the event of a failure.
@@ -760,24 +762,24 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-file"/>
-
<para id="option_mysql-proxy_log-file">
<literal>--log-file=filename</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-file"/>
+
<para>
The name of a file to be used to record log information.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-level"/>
-
<para id="option_mysql-proxy_log-level">
<literal>--log-file=filename</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-level"/>
+
<para>
The log level to be used when outputting error messages. The
specification will output that level (or lower) of a given
@@ -789,24 +791,24 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-use-syslog"/>
-
<para id="option_mysql-proxy_log-use-syslog">
<literal>--log-use-syslog</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:log-use-syslog"/>
+
<para>
Causes errors to be sent to the syslog (Unix/Linux only).
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:lua-cpath"/>
-
<para id="option_mysql-proxy_lua-cpath">
<literal>--lua-cpath=path</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:lua-cpath"/>
+
<para>
The <literal>LUA_CPATH</literal> to be used when loading
compiled modules or libraries for Lua scripts.
@@ -814,12 +816,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:lua-path"/>
-
<para id="option_mysql-proxy_lua-path">
<literal>--lua-path=path</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:lua-path"/>
+
<para>
The <literal>LUA_CPATH</literal> to be used when loading
modules for Lua.
@@ -827,12 +829,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:max-open-files"/>
-
<para id="option_mysql-proxy_max-open-files">
<literal>--max-open-files=#</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:max-open-files"/>
+
<para>
The maximum number of open files and sockets supported by the
<command>mysql-proxy</command> process. You may need to
@@ -841,24 +843,24 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:no-proxy"/>
-
<para id="option_mysql-proxy_no-proxy">
<literal>--no-proxy</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:no-proxy"/>
+
<para>
Disable the proxy module.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:plugin-dir"/>
-
<para id="option_mysql-proxy_plugin-dir">
<literal>--plugin-dir=path</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:plugin-dir"/>
+
<para>
The directory to use when loading plugins for
<command>mysql-proxy</command>.
@@ -866,24 +868,24 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:plugins"/>
-
<para id="option_mysql-proxy_plugins">
<literal>--plugins=plugin,...</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:plugins"/>
+
<para>
A comma-separated list of the plugins to be loaded.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-address"/>
-
<para id="option_mysql-proxy_proxy-address">
<literal>--proxy-address=host:port</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-address"/>
+
<para>
The listening host name (or IP address) and port of the proxy
server. The default is <literal>:4040</literal> (all IPs on
@@ -892,12 +894,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-read-only-backend-addresses"/>
-
<para id="option_mysql-proxy_proxy-read-only-backend-addresses">
<literal>--proxy-read-only-backend-addresses=host:port</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-read-only-backend-addresses"/>
+
<para>
The listening host name (or IP address) and port of the proxy
server for read-only connections. The default is for this
@@ -906,12 +908,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:backend-addresses"/>
-
<para id="option_mysql-proxy_proxy-backend-addresses">
<literal>--proxy-backend-addresses=host:port</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:backend-addresses"/>
+
<para>
The host name (or IP address) and port of the MySQL server to
connect to. You can specify multiple backend servers by
@@ -924,12 +926,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-pool-no-change-user"/>
-
<para id="option_mysql-proxy_proxy-pool-no-change-user">
<literal>--proxy-pool-no-change-user</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-pool-no-change-user"/>
+
<para>
Disables the use of the MySQL protocol
<literal>CHANGE_USER</literal> when reusing a connection from
@@ -939,12 +941,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-skip"/>
-
<para id="option_mysql-proxy_proxy-skip-profiling">
<literal>--proxy-skip-profiling </literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-skip"/>
+
<para>
Disables profiling of queries (tracking time statistics). The
default is for tracking to be enabled.
@@ -952,12 +954,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-fix-bug-25371"/>
-
<para id="option_mysql-proxy_proxy-fix-bug-25371">
<literal>--proxy-fix-bug-25371 </literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-fix-bug-25371"/>
+
<para>
Gets round an issue when connecting to a MySQL server later
than 5.1.12 when using a MySQL client library of any earlier
@@ -966,12 +968,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-lua-script"/>
-
<para id="option_mysql-proxy_proxy-lua-script">
<literal>--proxy-lua-script=file </literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:proxy-lua-script"/>
+
<para>
The Lua script file to be loaded. Note that the script file is
not physically loaded and parsed until a connection is made.
@@ -984,36 +986,36 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:daemon"/>
-
<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 condition="dynamic:optvar:item" role="0.8:mysql-proxy:pid-file"/>
-
<para id="option_mysql-proxy_pid-file">
<literal>--pid-file=file</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:pid-file"/>
+
<para>
Sets the name of the file to be used to store the process ID.
</para>
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:user"/>
-
<para id="option_mysql-proxy_user">
<literal>--user=user</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:user"/>
+
<para>
Run <command>mysql-proxy</command> as the specified
<literal>user</literal>.
@@ -1021,12 +1023,12 @@
</listitem>
<listitem>
- <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:version"/>
-
<para id="option_mysql-proxy_version">
<literal>--version</literal>
</para>
+ <para condition="dynamic:optvar:item" role="0.8:mysql-proxy:version"/>
+
<para>
Show the version number.
</para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r18790 - trunk/refman-common | martin.brown | 22 Jan |
