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

[plavin]

Author: plavin
Date: 2007-04-03 17:16:24 +0200 (Tue, 03 Apr 2007)
New Revision: 5713

Log:
Add commands to mysqladmin

Modified:
   trunk/dynamic-docs/command-optvars/mysqladmin.xml


Modified: trunk/dynamic-docs/command-optvars/mysqladmin.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/mysqladmin.xml	2007-04-03 14:16:23 UTC (rev 5712)
+++ trunk/dynamic-docs/command-optvars/mysqladmin.xml	2007-04-03 15:16:24 UTC (rev 5713)
Changed blocks: 7, Lines Added: 381, Lines Deleted: 7; 15694 bytes

@@ -398,7 +398,7 @@
     </option>
     <option command="mysqladmin" section="ssl" id="ssl-ca">
         <!--xref for ssl vars may not be accurate-->
-        <!--xrefto id="optvar_ssl-ca"/-->
+        <xrefto id="optvar_ssl-ca"/>
         <name>optvar_ssl-ca</name>
         <shortdescription lang="en">
             The path to a file that contains a list of trusted SSL CAs

@@ -415,7 +415,7 @@
         </versions>
     </option>
     <option command="mysqladmin" section="ssl" id="ssl-capath">
-        <!--xrefto id="optvar_ssl-capath"/-->
+        <xrefto id="optvar_ssl-capath"/>
         <name>optvar_ssl-capath</name>
         <shortdescription lang="en">
             The path to a directory that contains trusted SSL CA certificates in PEM
format 

@@ -432,7 +432,7 @@
         </versions>
     </option>
     <option command="mysqladmin" section="ssl" id="ssl-cert">
-        <!--xrefto id="optvar_ssl-cert"/-->
+        <xrefto id="optvar_ssl-cert"/>
         <name>optvar_ssl-cert</name>
         <shortdescription lang="en">
             The name of the SSL certificate file to use for establishing a secure
connection  

@@ -449,7 +449,7 @@
         </versions>
     </option>
     <option command="mysqladmin" section="ssl" id="ssl-cipher">
-        <!--xrefto id="optvar_ssl-cipher"/-->
+        <xrefto id="optvar_ssl-cipher"/>
         <name>optvar_ssl-cipher</name>
         <shortdescription lang="en">
             A list of allowable ciphers to use for SSL encryption 

@@ -466,7 +466,7 @@
         </versions>
     </option>
     <option command="mysqladmin" section="ssl" id="ssl-key">
-        <!--xrefto id="optvar_ssl-key"/-->
+        <xrefto id="optvar_ssl-key"/>
         <name>optvar_ssl-key</name>
         <shortdescription lang="en">
             The name of the SSL key file to use for establishing a secure connection 

@@ -483,7 +483,7 @@
         </versions>
     </option>
     <option command="mysqladmin" section="ssl" id="ssl-verify-server-cert">
-        <!--xrefto id="optvar_mysql_ssl-verify-server-cert"/-->
+        <xrefto id="optvar_mysql_ssl-verify-server-cert"/>
         <name>ssl-verify-server-cert</name>
         <shortdescription lang="en">
             The server's Common Name value in its certificate is

@@ -499,5 +499,379 @@
             <manual version="5.1"/>
         </versions>
     </option>
-    
+    <!--comands follow-->
+    <option command="mysqladmin" section="server" id="cmd-create">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-create"/-->
+        <name>cmd-create</name>
+        <shortdescription lang="en">
+            Create a new database named db_name
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="create db_name"/>
+        </types> 
+        <values vartype="string" platform="all"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <!--already a debug id in use-->
+    <option command="mysqladmin" section="server" id="cmd-debug">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-debug"/-->
+        <name>cmd-debug</name>
+        <shortdescription lang="en">
+            Tell the server to write debug information to the error log  
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format=""/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-drop">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-drop"/-->
+        <name>cmd-drop</name>
+        <shortdescription lang="en">
+            Delete the database named db_name  
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="drop db_name"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-extended-status">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-extended-status"/-->
+        <name>cmd-extended-status</name>
+        <shortdescription lang="en">
+            Display the server status variables and their values
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="extended-status"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-flush-hosts">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-flush-hosts"/-->
+        <name>cmd-flush-hosts</name>
+        <shortdescription lang="en">
+            Flush all information in the host cache 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="flush-hosts"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-flush-logs">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-flush-logs"/-->
+        <name>cmd-flush-logs</name>
+        <shortdescription lang="en">
+            Flush all logs 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="flush-logs"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-flush-privileges">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-flush-privileges"/-->
+        <name>cmd-flush-privileges</name>
+        <shortdescription lang="en">
+            Reload the grant tables  
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="flush-privileges"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-flush-status">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-flush-status"/-->
+        <name>cmd-flush-status</name>
+        <shortdescription lang="en">
+            Clear status variables  
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="flush-status"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-flush-tables">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-flush-tables"/-->
+        <name>cmd-flush-tables</name>
+        <shortdescription lang="en">
+            Flush all tables 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="flush-tables"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-flush-threads">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-flush-threads"/-->
+        <name>cmd-flush-threads</name>
+        <shortdescription lang="en">
+            Flush threads
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="flush-threads"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-kill">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-kill"/-->
+        <name>cmd-kill</name>
+        <shortdescription lang="en">
+            Kill server threads 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="kill id,id,..."/>
+        </types>  
+        <values vartype="numeric" platform="all"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-old-password">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-old-password"/-->
+        <name>cmd-old-password</name>
+        <shortdescription lang="en">
+            This is like the password command but stores the 
+            password using the old (pre-4.1) password-hashing format 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="old-password new_password"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-password">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-password"/-->
+        <name>cmd-old-password</name>
+        <shortdescription lang="en">
+            Set a new password
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="password new-password"/>
+        </types>  
+        <values vartype="string" platform="all"/>
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-ping">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-ping"/-->
+        <name>cmd-ping</name>
+        <shortdescription lang="en">
+            Check whether the server is alive
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="ping"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-processlist">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-processlist"/-->
+        <name>cmd-processlist</name>
+        <shortdescription lang="en">
+            Show a list of active server threads
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="processlist"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-reload">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-"/-->
+        <name>cmd-reload</name>
+        <shortdescription lang="en">
+            Reload the grant tables
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format=""/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-refresh">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-refresh"/-->
+        <name>cmd-refresh</name>
+        <shortdescription lang="en">
+            Flush all tables and close and open log files
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="refresh"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-shutdown">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-shutdown"/-->
+        <name>cmd-shutdown</name>
+        <shortdescription lang="en">
+            Stop the server
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="shutdown"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="replication" id="cmd-start-slave">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-start-slave"/-->
+        <name>cmd-start-slave</name>
+        <shortdescription lang="en">
+            Start replication on a slave server
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="start-slave"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-status">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-status"/-->
+        <name>cmd-status</name>
+        <shortdescription lang="en">
+            Display a short server status message
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="status"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="replication" id="cmd-stop-slave">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-stop-slave"/-->
+        <name>cmd-stop-slave</name>
+        <shortdescription lang="en">
+            Stop replication on a slave server.
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="stop-slave"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-variables">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-variables"/-->
+        <name>cmd-variables</name>
+        <shortdescription lang="en">
+            Display the server system variables and their values 
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="variables"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
+    <option command="mysqladmin" section="server" id="cmd-version">
+        <!--command-->
+        <!--xrefto id="option_mysqladmin_cmd-version"/-->
+        <name>cmd-version</name>
+        <shortdescription lang="en">
+            Display version information from the server
+        </shortdescription>
+        <types>
+            <optype class="cmdline" format="version"/>
+        </types>  
+        <versions>
+            <manual version="4.1"/>
+            <manual version="5.0"/>
+            <manual version="5.1"/>
+        </versions>
+    </option>
 </options>