svn commit - mysqldoc@docsrva: r6149 - trunk/dynamic-docs/command-optvars

[plavin]

Author: plavin
Date: 2007-04-24 17:50:51 +0200 (Tue, 24 Apr 2007)
New Revision: 6149

Log:
Add mysql_tableinfo options

Added:
   trunk/dynamic-docs/command-optvars/mysql_tableinfo.xml


Added: trunk/dynamic-docs/command-optvars/mysql_tableinfo.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/mysql_tableinfo.xml	                        (rev 0)
+++ trunk/dynamic-docs/command-optvars/mysql_tableinfo.xml	2007-04-24 15:50:51 UTC (rev
6149)
Changed blocks: 1, Lines Added: 214, Lines Deleted: 0; 7832 bytes

@@ -0,0 +1,214 @@
+<!DOCTYPE options SYSTEM "options.dtd">
+<options>
+    <option command="mysql_tableinfo" section="server" id="help">
+        <xrefto id="mysql_tableinfo_help"/>
+        <name>help</name>
+        <shortdescription lang="en">
+            Display help message and exit
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--help"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option> 
+    <option command="mysql_tableinfo" section="server" id="clear">
+        <xrefto id="mysql_tableinfo_clear"/>
+        <name>clear</name>
+        <shortdescription lang="en">
+            Before populating each metadata table, drop it if it exists
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--clear"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="clear-only">
+        <xrefto id="mysql_tableinfo_clear-only"/>
+        <name>clear-only</name>
+        <shortdescription lang="en">
+            Similar to --clear, but exits after dropping 
+            the metadata tables to be populated.
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--clear-only"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="col">
+        <xrefto id="mysql_tableinfo_col"/>
+        <name>col</name>
+        <shortdescription lang="en">
+            Generate column metadata into the col table
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--col"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="idx">
+        <xrefto id="mysql_tableinfo_idx"/>
+        <name>idx</name>
+        <shortdescription lang="en">
+            Generate index metadata into the idx table
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--idx"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="prefix">
+        <xrefto id="mysql_tableinfo_prefix"/>
+        <name>prefix</name>
+        <shortdescription lang="en">
+            Add prefix_str at the beginning of each metadata table name
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--prefix=prefix_str"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="quiet">
+        <xrefto id="mysql_tableinfo_quiet"/>
+        <name></name>
+        <shortdescription lang="en">
+            Be silent except for errors
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--quiet"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="tbl-status">
+        <xrefto id="mysql_tableinfo_tbl-status"/>
+        <name>tbl-status</name>
+        <shortdescription lang="en">
+            Use SHOW TABLE STATUS instead of SHOW TABLES
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--tbl-status"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="user">
+        <xrefto id="mysql_tableinfo_user"/>
+        <name>user</name>
+        <shortdescription lang="en">
+            The mysql_tableinfo username to use when connecting to the server 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--user=user_name,"/>
+            <optype class="mycnf"/>
+        </types> 
+        <values vartype="string" platform="all"/> 
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql_tableinfo" section="server" id="password">
+        <xrefto id="mysql_tableinfo_password"/>
+        <name>password</name>
+        <shortdescription lang="en">
+            The password to use when connecting to the server -- not optional
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--password=password"/>
+            <optype class="cmdline" format="-ppassword"/>
+            <optype class="mycnf"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option> 
+    <option command="mysql_tableinfo" section="server" id="port">
+        <xrefto id="mysql_tableinfo_port"/>
+        <name>port</name>
+        <shortdescription lang="en">
+            The TCP/IP port number to use for the connection
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--port=port_num"/>
+            <optype class="mycnf"/>
+        </types> 
+        <values vartype="numeric" platform="all">
+            <value default="3306"/>
+        </values>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>  
+    <option command="mysql_tableinfo" section="server" id="host">
+        <xrefto id="mysql_tableinfo_host"/>
+        <name>host</name>
+        <shortdescription lang="en">
+            Connect to the MySQL server on the given host
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--host=host_name"/>
+            <optype class="mycnf"/>
+        </types>   
+        <values vartype="string" platform="all">
+            <value default="localhost"/>
+        </values>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option> 
+    <option command="mysql_tableinfo" section="server" id="socket">
+        <xrefto id="mysql_tableinfo_socket"/>
+        <name>socket</name>
+        <shortdescription lang="en">
+            Display version information and exit 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="--socket=path"/>
+        </types> 
+        <values vartype="filename" platform="all"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    
+</options>