svn commit - mysqldoc@docsrva: r6603 - in trunk: dynamic-docs/command-optvars refman-5.0

[plavin]

Author: plavin
Date: 2007-05-28 22:07:19 +0200 (Mon, 28 May 2007)
New Revision: 6603

Log:
Add mysql commands

Modified:
   trunk/dynamic-docs/command-optvars/mysql.xml
   trunk/refman-5.0/client-utility-programs.xml


Modified: trunk/dynamic-docs/command-optvars/mysql.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/mysql.xml	2007-05-28 14:50:00 UTC (rev 6602)
+++ trunk/dynamic-docs/command-optvars/mysql.xml	2007-05-28 20:07:19 UTC (rev 6603)
Changed blocks: 11, Lines Added: 377, Lines Deleted: 14; 17355 bytes

@@ -60,8 +60,7 @@
             <optype class="cmdline" format="--character-sets-dir=name" />
             <optype class="mycnf"/>
         </types>
-        <values vartype="filename" platform="all">
-        </values>
+        <values vartype="filename" platform="all"/>        
         <versions>
             <manual version="4.1"/>
             <manual version="5.0"/>

@@ -170,7 +169,7 @@
         </types>   
         <values vartype="string" platform="all">
             <value default="d:t:o,/tmp/mysql.trace"/>
-        </values>
+        </values>        
         <versions>
             <manual version="4.1"/>
             <manual version="5.0"/>

@@ -504,10 +503,10 @@
             <optype class="cmdline" format="--pager[=command]"/>
             <optype class="mycnf"/>
         </types>  
-        <values vartype="string" platform="linux"></values>
-        <values vartype="string" platform="macosx"></values>
-        <values vartype="string" platform="solaris"></values>
-        <values vartype="string" platform="hpux"></values>
+        <values vartype="string" platform="linux"/>
+        <values vartype="string" platform="macosx"/>
+        <values vartype="string" platform="solaris"/>
+        <values vartype="string" platform="hpux"/>
         <versions>
             <manual version="4.1"/>
             <manual version="5.0"/>

@@ -524,7 +523,11 @@
         <types>
             <optype class="cmdline" format="--skip-pager"/>
             <optype class="mycnf"/>
-        </types>        
+        </types> 
+        <values vartype="string" platform="linux"/>
+        <values vartype="string" platform="macosx"/>
+        <values vartype="string" platform="solaris"/>
+        <values vartype="string" platform="hpux"/>
         <versions>
             <manual version="4.1"/>
             <manual version="5.0"/>

@@ -862,7 +865,7 @@
             <optype class="cmdline" format="--ssl-cipher=cipher_list"/>
             <optype class="mycnf"/>
         </types> 
-        <values vartype="string" platform="all"></values>
+        <values vartype="string" platform="all"/>
         <versions>
             <manual version="4.1"/>
             <manual version="5.0"/>

@@ -1057,7 +1060,7 @@
     </option>
     <!-- all the following are variables and use the optvar xref id -->
     <option command="mysql" section="server" id="connect_timeout">
-        <xrefto id="option_mysqld_connect_timeout"/>
+        <xrefto id="option_mysql_connect_timeout"/>
         <name>connect_timeout</name>
         <shortdescription lang="en">
             The number of seconds before connection timeout

@@ -1076,7 +1079,7 @@
         </versions>
     </option>
     <option command="mysql" section="server" id="max_allowed_packet">
-        <xrefto id="option_mysqld_max_allowed_packet"/>
+        <xrefto id="option_mysql_max_allowed_packet"/>
         <name>max_allowed_packet</name>
         <shortdescription lang="en">
             The maximum packet length to send to or receive from the server   

@@ -1095,7 +1098,7 @@
         </versions>
     </option>
     <option command="mysql" section="server" id="max_join_size">
-        <xrefto id="option_mysqld_max_join_size"/>
+        <xrefto id="option_mysql_max_join_size"/>
         <name>max_join_size</name>
         <shortdescription lang="en">
             The automatic limit for rows in a join when using --safe-updates 

@@ -1114,7 +1117,7 @@
         </versions>
     </option>
     <option command="mysql" section="server" id="net_buffer_length">
-        <xrefto id="option_mysqld_net_buffer_length"/>
+        <xrefto id="option_mysql_net_buffer_length"/>
         <name>net_buffer_length</name>
         <shortdescription lang="en">
             The buffer size for TCP/IP and socket communication

@@ -1133,7 +1136,7 @@
         </versions>
     </option>
     <option command="mysql" section="server" id="select_limit">
-        <xrefto id="option_mysqld_select_limit"/>
+        <xrefto id="option_mysql_select_limit"/>
         <name>select_limit</name>
         <shortdescription lang="en">
             The automatic limit for SELECT  statements when using --safe-updates 

@@ -1151,4 +1154,364 @@
             <manual version="5.1"/>
         </versions>
     </option>
+    <option command="mysql" section="server" id="command-help">
+        <!--xrefto id="command_mysql_help"/-->
+        <name>help</name>
+        <shortdescription lang="en">
+            Display help for commands and for SQL syntax
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="\h [str_syntax]"/>
+            <optype class="cmdline" format="? [str_syntax]"/>
+            <optype class="cmdline" format="help [str_syntax]"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-connect">
+        <!--xrefto id="command_mysql_connect"/-->
+        <name>connect</name>
+        <shortdescription lang="en">
+            Reconnect to the server. Optional arguments are db and host
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="connect [str_host] [str_db]"/>
+            <optype class="cmdline" format="\r [str_host] [str_db]"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-charset">
+        <!--xrefto id="command_mysql_"/-->
+        <name>charset</name>
+        <shortdescription lang="en">
+            Switch to another charset. Might be needed for processing
+            binlog with multi-byte charsets
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="charset strcharset"/>
+            <optype class="cmdline" format="\C str_charset"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-clear">
+        <!--xrefto id="command_mysql_clear"/-->
+        <name>clear</name>
+        <shortdescription lang="en">
+            Clear the screen
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="clear"/>
+            <optype class="cmdline" format="\c"/>
+        </types>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-delimiter">
+        <!--xrefto id="command_mysql_delimiter"/-->
+        <name>delimiter</name>
+        <shortdescription lang="en">
+            Set statement delimiter
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="delimiter str_delimiter"/>
+            <optype class="cmdline" format="\d str_delimiter"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-edit">
+        <!--xrefto id="command_mysql_"/-->
+        <name>edit</name>
+        <shortdescription lang="en">
+            Edit command with $EDITOR.
+        </shortdescription>
+        <platforms applies="hpux"/>
+        <platforms applies="linux"/>
+        <platforms applies="macosx"/>
+        <platforms applies="solaris"/>
+        <types>
+            <optype class="cmdline" format="edit"/>
+            <optype class="cmdline" format="\e"/>
+        </types>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-ego">
+        <!--xrefto id="command_mysql_ego"/-->
+        <name>ego</name>
+        <shortdescription lang="en">
+            Send command to mysql server, display result vertically
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="ego"/>
+            <optype class="cmdline" format="\G"/>
+        </types>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-exit">
+        <!--xrefto id="command_mysql_exit"/-->
+        <name>exit</name>
+        <shortdescription lang="en">
+            Exit mysql
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="exit"/>
+            <optype class="cmdline" format="quit"/>
+            <optype class="cmdline" format="\g"/>
+        </types>  
+        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-nopager">
+        <!--xrefto id="command_mysql_nopager"/-->
+        <name>nopager</name>
+        <shortdescription lang="en">
+            Disable pager, print to stdout
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="nopager"/>
+            <optype class="cmdline" format="\P"/>
+        </types> 
+        <values vartype="string" platform="linux"/>
+        <values vartype="string" platform="macosx"/>
+        <values vartype="string" platform="solaris"/>
+        <values vartype="string" platform="hpux"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-notee">
+        <!--xrefto id="command_mysql_"/-->
+        <name>notee</name>
+        <shortdescription lang="en">
+            Disable pager, print to stdout
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="notee"/>
+            <optype class="cmdline" format="\t"/>
+        </types>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-tee">
+        <!--xrefto id="command_mysql_"/-->
+        <name>tee</name>
+        <shortdescription lang="en">
+            Append everything into given
+            outfile.
+        </shortdescription>
+        <disabledby xref="command-notee"/>
+        <types>
+            <optype class="cmdline" format="tee [outfile]"/>
+            <optype class="cmdline" format="\t [outfile]"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-print">
+        <!--xrefto id="command_mysql_print"/-->
+        <name>print</name>
+        <shortdescription lang="en">
+            Print current command 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="print"/>
+            <optype class="cmdline" format="/p"/>
+        </types>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-prompt">
+        <!--xrefto id="command_mysql_prompt"/-->
+        <name>prompt</name>
+        <shortdescription lang="en">
+            Change your mysql prompt
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="prompt str_prompt"/>
+            <optype class="cmdline" format="\R str_prompt"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-rehash">
+        <!--xrefto id="command_mysql_rehash"/-->
+        <name>rehash</name>
+        <shortdescription lang="en">
+            Rebuild completion hash 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="rehash "/>
+            <optype class="cmdline" format="\#"/>
+        </types> 
+        <values vartype="string" platform="linux"/>
+        <values vartype="string" platform="macosx"/>
+        <values vartype="string" platform="solaris"/>
+        <values vartype="string" platform="hpux"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-source">
+        <!--xrefto id="command_mysql_source"/-->
+        <name>source</name>
+        <shortdescription lang="en">
+            Execute an SQL script file
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="source filename"/>
+            <optype class="cmdline" format="\. filename"/>
+        </types> 
+        <values vartype="string" platform="linux"/>
+        <values vartype="string" platform="macosx"/>
+        <values vartype="string" platform="solaris"/>
+        <values vartype="string" platform="hpux"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-status">
+        <!--xrefto id="command_mysql_status"/-->
+        <name>status</name>
+        <shortdescription lang="en">
+            Get status information from the server
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="status"/>
+            <optype class="cmdline" format="\s"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-system">
+        <!--xrefto id="command_mysql_system"/-->
+        <name>system</name>
+        <shortdescription lang="en">
+            Execute a system shell command
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="system"/>
+            <optype class="cmdline" format="\!"/>
+        </types>  
+        <values vartype="string" platform="linux"/>
+        <values vartype="string" platform="macosx"/>
+        <values vartype="string" platform="solaris"/>
+        <values vartype="string" platform="hpux"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-use">
+        <!--xrefto id="command_mysql_use"/-->
+        <name>use</name>
+        <shortdescription lang="en">
+            Use another database
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="use db_name"/>
+            <optype class="cmdline" format="\u db_name"/>
+        </types>  
+        <values vartype="string" platform="all"/>        
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-warnings">
+        <!--xrefto id="command_mysql_warnings"/-->
+        <name>warnings</name>
+        <shortdescription lang="en">
+            Show warnings after every statement
+        </shortdescription>
+        <disabledby xref="command-nowarnings"/>
+        <types>
+            <optype class="cmdline" format="warnings"/>
+            <optype class="cmdline" format="\W"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysql" section="server" id="command-nowarnings">
+        <!--xrefto id="command_mysql_command-nowarnings"/-->
+        <name>command-nowarnings</name>
+        <shortdescription lang="en">
+            Don't show warnings after every statement
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="nowarnings"/>
+            <optype class="cmdline" format="\w"/>
+        </types>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
 </options>


Modified: trunk/refman-5.0/client-utility-programs.xml
===================================================================
--- trunk/refman-5.0/client-utility-programs.xml	2007-05-28 14:50:00 UTC (rev 6602)
+++ trunk/refman-5.0/client-utility-programs.xml	2007-05-28 20:07:19 UTC (rev 6603)
Changed blocks: 1, Lines Added: 0, Lines Deleted: 4; 465 bytes

@@ -6103,10 +6103,6 @@
 </programlisting>
           </listitem>
 
-          <listitem>
-            <para></para>
-          </listitem>
-
         </itemizedlist>
 
       </refsection>