svn commit - mysqldoc@docsrva: r6426 - trunk/userguide

[plavin]

Author: plavin
Date: 2007-05-11 00:34:32 +0200 (Fri, 11 May 2007)
New Revision: 6426

Log:
Start section on  mysqladmin

Added:
   trunk/userguide/mysqladmin.xml
Modified:
   trunk/userguide/excel-mysql.xml


Modified: trunk/userguide/excel-mysql.xml
===================================================================
--- trunk/userguide/excel-mysql.xml	2007-05-10 18:12:28 UTC (rev 6425)
+++ trunk/userguide/excel-mysql.xml	2007-05-10 22:34:32 UTC (rev 6426)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 572 bytes

@@ -1272,7 +1272,7 @@
       TABLE</literal> statements &mdash; making it much easier to reuse
       the database that's already there. This script can be run from the
       command line as described in the previous section or you can open
-      it within Query browser.
+      it within Query Browser.
     </para>
 
     <para>


Added: trunk/userguide/mysqladmin.xml
===================================================================
--- trunk/userguide/mysqladmin.xml	                        (rev 0)
+++ trunk/userguide/mysqladmin.xml	2007-05-10 22:34:32 UTC (rev 6426)
Changed blocks: 1, Lines Added: 129, Lines Deleted: 0; 3905 bytes

@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[ 
+  <!ENTITY % all.entities SYSTEM "all-entities.ent">
+  %all.entities;
+]>
+<chapter id="user-guide-mysqladmin">
+
+  <title>Using <command>mysqladmin</command></title>
+
+  <para>
+    The <command>mysqladmin</command> utility is a client utility for
+    administering a MySQL seerver.
+  </para>
+
+  <para>
+    As is the case with most MySQL utilities, there are often other
+    alternatives to using mysqladmin. The GUI Tool, MySQL Administrator,
+    for example, can do most of the tasks performed by mysqladmin. This
+    is an especially useful administrative tool especially if you are
+    new to MySQL. This application is examined in detail in &lt;xref&gt;.
+    Likewise, many of the capabilities of mysqladmin are also available
+    when using the MySQL client program. 
+  </para>
+  
+  <para>
+    
+    approach to administrative
+    tasks if you use <literal>ssh</literal> to sometimes no access to
+  </para>
+
+  <para>
+    This chapter shows how to make to use mysqladmin for
+    essential tasks. It is not meant as a definite treatment of
+    <literal>mysqladmin</literal>; for complete coverage of this utility
+    see <ulink url="&base-url-refman;5.0/en/mysqladmin.html"/>.
+  </para>
+
+<!-- start options -->
+
+  <section id="mysqladmin-options-commands">
+
+    <title>Options and Commands</title>
+
+    <para>
+      Unlike other utilities, <literal>mysqladmin</literal> supports
+      both commands and options. This section identifies the most
+      commonly used options and briefly describes each one. Examples of
+      using these options are given in subsequent sections.
+    </para>
+
+    <para>
+      The essential commands are as follows:
+    </para>
+
+    <itemizedlist>
+
+      <listitem>
+        <para>
+          create <replaceable>db_name</replaceable> &ndash; create a
+          database
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          drop <replaceable>db_name</replaceable> &ndash; drop a
+          database
+        </para>
+      </listitem>
+
+      <listitem>
+        <para>
+          ping &ndash; check that the MySQL server is running
+        </para>
+      </listitem>
+      
+      <listitem>
+        <para>
+          <command>shutdown</command> &ndash; bring down the MySQL
+          server
+        </para>
+      </listitem>
+
+    </itemizedlist>
+
+    <para>
+      Since the <command>mysqladmin</command> utility gives access to a
+      specific MySQL server, you must have credentials on that server;
+      you must explicitly or implicitly provide a
+      <option>--user</option> and <option>--password</option>. Likewise
+      you must provide <option>--host</option> and
+      <option>--port</option> options. In this respect,
+      <command>mysqladmin</command> does not differ from the MySQL
+      client program, <command>mysql</command>.
+    </para>
+
+    <para>
+      Other essential mysqladmin options are as follows:
+
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            <option>--help, -?</option> &ndash; display the help message
+            and exit
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <option>--force, -f</option> &ndash; do not ask for
+            confirmation when dropping a database
+          </para>
+        </listitem>
+
+      </itemizedlist>
+    </para>
+
+    <para>
+      For a complete list of all the available options see
+      <ulink url="&base-url-refman;5.0/en/mysqladmin.html"/>.
+    </para>
+
+  </section>
+
+</chapter>
+<!-- END mysqladmin CHAPTER -->