List:Commits« Previous MessageNext Message »
From:paul Date:January 23 2006 9:26pm
Subject:svn commit - mysqldoc@docsrva: r1003 - in trunk: . refman-5.0 refman-5.1 refman-common
View as plain text  
Author: paul
Date: 2006-01-23 22:26:18 +0100 (Mon, 23 Jan 2006)
New Revision: 1003

Log:
 r2446@kite-hub:  paul | 2006-01-23 14:14:47 -0600
 General revisions.


Modified:
   trunk/
   trunk/refman-5.0/database-administration.xml
   trunk/refman-5.0/renamed-nodes.txt
   trunk/refman-5.1/database-administration.xml
   trunk/refman-5.1/renamed-nodes.txt
   trunk/refman-common/titles.en.ent


Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6574
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2445
   + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6574
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2446

Modified: trunk/refman-5.0/database-administration.xml
===================================================================
--- trunk/refman-5.0/database-administration.xml	2006-01-23 21:26:06 UTC (rev 1002)
+++ trunk/refman-5.0/database-administration.xml	2006-01-23 21:26:18 UTC (rev 1003)
@@ -10657,22 +10657,22 @@
         <title>Description</title>
 
         <para>
-          The MySQL Instance Manager (IM) is a daemon running on a
-          TCP/IP port, which serves for monitoring and management of
-          MySQL Database Server instances. MySQL Instance Manager is
-          available for Unix-like operating systems, and also on Windows
-          as of MySQL 5.0.13.
+          <command>mysqlmanager</command> is the MySQL Instance Manager
+          (IM). This program is a daemon running on a TCP/IP port that
+          serves to monitor and manage MySQL Database Server instances.
+          MySQL Instance Manager is available for Unix-like operating
+          systems, and also on Windows as of MySQL 5.0.13.
         </para>
 
         <para>
           MySQL Instance Manager is included in MySQL distributions from
           version 5.0.3, and can be used in place of the
           <literal>mysqld_safe</literal> script to start and stop the
-          MySQL Server, <emphasis role="bold">even from a remote
-          host</emphasis>. MySQL Instance Manager also implements the
-          functionality (and most of the syntax) of the
-          <command>mysqld_multi</command> script. A more detailed
-          description of MySQL Instance Manager follows.
+          MySQL Server, <emphasis>even from a remote host</emphasis>.
+          MySQL Instance Manager also implements the functionality (and
+          most of the syntax) of the <command>mysqld_multi</command>
+          script. A more detailed description of MySQL Instance Manager
+          follows.
         </para>
 
       </refsection>
@@ -10682,20 +10682,20 @@
         <title>&title-instance-manager-startup-process;</title>
 
         <para>
-          Normally, the MySQL Database Server is started with the
-          <command>mysql.server</command> script, which usually resides
-          in the <literal>/etc/init.d/</literal> folder. In MySQL 5.0.3
-          this script invokes <command>mysqlmanager</command> (the MySQL
-          Instance Manager binary) to start MySQL. (In prior versions of
-          MySQL the <command>mysqld_safe</command> script is used for
-          this purpose.) Starting from MySQL 5.0.4 the behavior of the
-          init script was changed again to incorporate both setup
-          schemes. In version 5.0.4, the init startup script uses the
-          old scheme (invoking <command>mysqld_safe</command>) by
-          default, but one can set the
-          <literal>use_mysqld_safe</literal> variable in the script to
-          <literal>0</literal> (zero) in order to use the MySQL Instance
-          Manager to start a server.
+          Normally, the <command>mysqld</command> MySQL Database Server
+          is started with the <command>mysql.server</command> script,
+          which usually resides in the <literal>/etc/init.d/</literal>
+          folder. In MySQL 5.0.3 this script invokes
+          <command>mysqlmanager</command> (the MySQL Instance Manager
+          binary) to start MySQL. (In prior versions of MySQL the
+          <command>mysqld_safe</command> script is used for this
+          purpose.) Starting from MySQL 5.0.4 the behavior of the init
+          script was changed again to incorporate both setup schemes. In
+          version 5.0.4, the init startup script uses the old scheme
+          (invoking <command>mysqld_safe</command>) by default, but one
+          can set the <literal>use_mysqld_safe</literal> variable in the
+          script to <literal>0</literal> (zero) in order to use the
+          MySQL Instance Manager to start a server.
         </para>
 
         <remark role="todo">
@@ -10707,32 +10707,32 @@
         <para>
           The Instance Manager's behavior in this case depends on the
           options given in the MySQL configuration file. If there is no
-          configuration file, the MySQL Instance Manager creates an
-          instance named <literal>mysqld</literal> and attempts to start
-          it with default (compiled-in) configuration values. This means
-          that the IM cannot guess the placement of
+          configuration file, the MySQL Instance Manager creates a
+          server instance named <literal>mysqld</literal> and attempts
+          to start it with default (compiled-in) configuration values.
+          This means that the IM cannot guess the placement of
           <command>mysqld</command> if it is not installed in the
           default location. If you have installed the MySQL server in a
-          non-standard location you should use a configuration file. See
-          <xref linkend="installation-layouts"/>.
+          non-standard location, you should use a configuration file.
+          See <xref linkend="installation-layouts"/>.
         </para>
 
         <para>
-          If there is a configuration file, the IM will parse the
-          configuration file in search of <literal>[mysqld]</literal>
-          sections (E.g. <literal>[mysqld]</literal>,
-          <literal>[mysqld1]</literal>, <literal>[mysqld2]</literal>,
-          etc.) Each such section specifies an instance. At startup the
-          IM will start all found instances. The IM stops all instances
-          at shutdown by default.
+          If there is a configuration file, the IM reads it to find
+          <literal>[mysqld]</literal> sections (for example,
+          <literal>[mysqld]</literal>, <literal>[mysqld1]</literal>,
+          <literal>[mysqld2]</literal>, and so forth). Each such section
+          specifies an instance. When it starts, the Instance Manager
+          attempts to start all server instances that it finds. By
+          default, the Instance Manager stops all server instances when
+          it shuts down.
         </para>
 
         <para>
-          Note that there is a special option
-          <literal>mysqld-path</literal> (<literal>mysqld-path =
-          <replaceable>path-to-mysqld-binary</replaceable></literal>)
-          which is recognized only by the IM. Use this variable to let
-          the IM know where the <command>mysqld</command> binary
+          Note that there is a special
+          <option>--mysqld-path=<replaceable>path-to-mysqld-binary</replaceable></option>
+          option that is recognized only by the IM. Use this variable to
+          let the IM know where the <command>mysqld</command> binary
           resides. You should also set <literal>basedir</literal> and
           <literal>datadir</literal> options for the server.
         </para>
@@ -10742,7 +10742,7 @@
           MySQL Instance Manager enabled is as follows:
         </para>
 
-        <itemizedlist>
+        <orderedlist>
 
           <listitem>
             <para>
@@ -10774,7 +10774,7 @@
             </para>
           </listitem>
 
-        </itemizedlist>
+        </orderedlist>
 
       </refsection>
 
@@ -10788,7 +10788,7 @@
           the IM using the standard <command>mysql</command> client
           program, as well as the MySQL C API. The IM supports the
           version of the MySQL client-server protocol used by the client
-          tools and libraries distributed along with mysql-4.1 or later.
+          tools and libraries distributed along with MySQL 4.1 or later.
         </para>
 
         <refsection id="instance-manager-security-passwords">
@@ -10796,13 +10796,13 @@
           <title>Instance Manager Users and Passwords</title>
 
           <para>
-            The IM stores its user information in a password file.
-            Default placement for the password file is
-            <filename>/etc/mysqlmanager.passwd</filename>
+            The Instance Manager stores its user information in a
+            password file. The default name of the password file is
+            <filename>/etc/mysqlmanager.passwd</filename>.
           </para>
 
           <para>
-            Password entries look like the following:
+            Password entries have the following format:
           </para>
 
 <programlisting>
@@ -10810,36 +10810,36 @@
 </programlisting>
 
           <para>
-            To generate such an entry one should invoke IM with the
+            If there are no entries in the
+            <filename>/etc/mysqlmanager.passwd</filename> file, you
+            cannot connect to the Instance Manager.
+          </para>
+
+          <para>
+            To generate a new entry, invoke Instance Manager with the
             <command>--passwd</command> option. Then the output can be
-            redirected to the
+            appended to the
             <filename>/etc/mysqlmanager.passwd</filename> file to add a
-            new user. A sample command is given below.
+            new user. Here is an example:
           </para>
 
 <programlisting>
-./mysqlmanager --passwd &gt;&gt; /etc/mysqlmanager.passwd
+shell&gt; <userinput>mysqlmanager --passwd &gt;&gt; /etc/mysqlmanager.passwd</userinput>
 Creating record for new user.
-Enter user name: mike
-Enter password: &lt;password&gt;
-Re-type password: &lt;password&gt;
+Enter user name: <replaceable>mike</replaceable>
+Enter password: <replaceable>password</replaceable>
+Re-type password: <replaceable>password</replaceable>
 </programlisting>
 
           <para>
-            The following line is added to
-            <filename>/etc/mysqlmanager.passwd</filename>:
+            The preceding command causes the following line to be added
+            to <filename>/etc/mysqlmanager.passwd</filename>:
           </para>
 
 <programlisting>
 mike:*00A51F3F48415C7D4E8908980D443C29C69B60C9
 </programlisting>
 
-          <para>
-            If there are no entries in the
-            <filename>/etc/mysqlmanager.passwd</filename> file one
-            cannot connect to the IM.
-          </para>
-
         </refsection>
 
         <refsection id="instance-manager-security-monitoring">
@@ -10847,9 +10847,9 @@
           <title>MySQL Server Accounts for Status Monitoring</title>
 
           <para>
-            In order to monitor server status, the MySQL Instance
-            Manager will attempt to connect to the MySQL server instance
-            at regular intervals using the
+            To monitor server status, the MySQL Instance Manager will
+            attempt to connect to the MySQL server instance at regular
+            intervals using the
             <literal>MySQL_Instance_Manager@localhost</literal> user
             account with a password of
             <literal>check_connection</literal>.
@@ -10860,26 +10860,31 @@
             <literal>MySQL_Instance_M@localhost</literal> user account
             in order for the MySQL Instance Manager to monitor server
             status, as a login failure is sufficient to identify that
-            the server is operational. However; because the account does
-            not exist the failed connection attempts will be recorded to
-            the <link linkend="query-log">General Query Log</link>.
+            the server is operational. However, if the account does not
+            exist, failed connection attempts are logged by the server
+            to its general query log (see <xref linkend="query-log"/>).
           </para>
 
         </refsection>
 
       </refsection>
 
-      <refsection id="instance-manager-command-line-options">
+      <refsection id="instance-manager-command-options">
 
-        <title>&title-instance-manager-command-line-options;</title>
+        <title>&title-instance-manager-command-options;</title>
 
         <para>
           The MySQL Instance Manager supports a number of command line
-          options. A brief listing is available by executing the
-          <command>./mysqlmanager --help</command> command. The
-          following options are available:
+          options. For a brief listing, invoke
+          <command>mysqlmanager</command> with the
+          <option>--help</option> option.
         </para>
 
+        <para>
+          <command>mysqlmanager</command> supports the following
+          options:
+        </para>
+
         <itemizedlist>
 
           <listitem>
@@ -10888,13 +10893,13 @@
             </para>
 
             <para>
-              Display the help message and exit.
+              Display a help message and exit.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <option>--bind-address=<replaceable>name</replaceable></option>
+              <option>--bind-address=<replaceable>IP</replaceable></option>
             </para>
 
             <para>
@@ -10904,13 +10909,13 @@
 
           <listitem>
             <para>
-              <option>--default-mysqld-path=<replaceable>name</replaceable></option>
+              <option>--default-mysqld-path=<replaceable>path</replaceable></option>
             </para>
 
             <para>
-              On Unix, where to look for the MySQL Server binary, if no
+              On Unix, the pathname of the MySQL Server binary, if no
               path was provided in the instance section. Example:
-              <literal>default-mysqld-path = /usr/sbin/mysqld</literal>
+              <option>--default-mysqld-path=/usr/sbin/mysqld</option>
             </para>
           </listitem>
 
@@ -10955,15 +10960,14 @@
             </para>
 
             <para>
-              Interval to monitor instances in seconds. Instance manager
-              will try to connect to each of monitored instances to
-              check whether they are alive/not hanging. In the case of a
-              failure IM will perform several (in fact many) attempts to
-              restart the instance. One can disable this behavior for
-              particular instances with the
+              The interval in seconds for monitoring instances. The
+              default value is 20 seconds. Instance Manager tries to
+              connect to each monitored instance to check whether it is
+              alive/not hanging. In the case of a failure, IM performs
+              several attempts to restart the instance. The
               <literal>nonguarded</literal> option in the appropriate
-              instance section. If no value was given, the default of 20
-              seconds will be used.
+              instance section disables this behavior for a particular
+              instance.
             </para>
           </listitem>
 
@@ -10973,7 +10977,7 @@
             </para>
 
             <para>
-              Prepare entry for passwd file and exit.
+              Prepare an entry for the password file and exit.
             </para>
           </listitem>
 
@@ -11006,8 +11010,8 @@
             </para>
 
             <para>
-              The port number to use for connections. (The default port
-              number, assigned by IANA, is 2273).
+              The TCP/IP port number to use for connections. (The
+              default port number assigned by IANA is 2273).
             </para>
           </listitem>
 
@@ -11042,14 +11046,14 @@
 
             <para>
               Daemonize and start the angel process. The angel process
-              is simple and unlikely to crash. It will restart the IM
-              itself in case of a failure.
+              is simple and unlikely to crash. It will restart the
+              Instance Manager itself in case of a failure.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <option>--socket=<replaceable>name</replaceable></option>
+              <option>--socket=<replaceable>path</replaceable></option>
             </para>
 
             <para>
@@ -11072,7 +11076,7 @@
 
           <listitem>
             <para>
-              <option>--user=<replaceable>name</replaceable></option>
+              <option>--user=<replaceable>user_name</replaceable></option>
             </para>
 
             <para>
@@ -11106,8 +11110,9 @@
           file. It uses the <literal>[manager]</literal> section to read
           options for itself and the <literal>[mysqld]</literal>
           sections to create instances. The <literal>[manager]</literal>
-          section contains any of the options listed above. An example
-          <literal>[manager]</literal> section is given below:
+          section contains any of the options listed in
+          <xref linkend="instance-manager-command-options"/>. Here is an
+          example <literal>[manager]</literal> section:
         </para>
 
 <programlisting>
@@ -11148,11 +11153,12 @@
           <listitem>
             <para>
               <literal>mysqld-path =
-              &lt;path-to-mysqld-binary&gt;</literal>
+              <replaceable>path</replaceable></literal>
             </para>
 
             <para>
-              The path to the <command>mysqld</command> server binary.
+              The pathname to the <command>mysqld</command> server
+              binary.
             </para>
           </listitem>
 
@@ -11164,11 +11170,11 @@
 
             <para>
               The number of seconds IM should wait for the instance to
-              shut down. The default is 35 seconds. After the delay
-              expires, the IM assumes that the instance is hanging and
-              attempts to <literal>kill -9</literal> it. If you use
-              <literal>InnoDB</literal> with large tables, you should
-              increase this value.
+              shut down. The default value is 35 seconds. After the
+              delay expires, the IM assumes that the instance is hanging
+              and attempts to use <literal>kill -9</literal> to
+              terminate it. If you use <literal>InnoDB</literal> with
+              large tables, you should increase this value.
             </para>
           </listitem>
 
@@ -11178,7 +11184,7 @@
             </para>
 
             <para>
-              This option should be set if you want to disable IM
+              This option should be specified if you want to disable IM
               monitoring functionality for a certain instance.
             </para>
           </listitem>
@@ -11186,7 +11192,7 @@
         </itemizedlist>
 
         <para>
-          Several sample instance sections are given below.
+          Here are some sample instance sections:
         </para>
 
 <programlisting>
@@ -11234,11 +11240,12 @@
 
           <listitem>
             <para>
-              <literal>START INSTANCE &lt;instance_name&gt;</literal>
+              <literal>START INSTANCE
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              This command will attempt to start an instance:
+              This command attempts to start an instance.
             </para>
 
 <programlisting>
@@ -11249,11 +11256,12 @@
 
           <listitem>
             <para>
-              <literal>STOP INSTANCE &lt;instance_name&gt;</literal>
+              <literal>STOP INSTANCE
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              This will attempt to stop an instance:
+              This command attempts to stop an instance.
             </para>
 
 <programlisting>
@@ -11268,11 +11276,11 @@
             </para>
 
             <para>
-              Show the names of all loaded instances:
+              Shows the names of all loaded instances.
             </para>
 
 <programlisting>
-mysql&gt; <userinput>show instances;</userinput>
+mysql&gt; <userinput>SHOW INSTANCES;</userinput>
 +---------------+---------+
 | instance_name | status  |
 +---------------+---------+
@@ -11287,11 +11295,12 @@
           <listitem>
             <para>
               <literal>SHOW INSTANCE STATUS
-              &lt;instance_name&gt;</literal>
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              Show the status and the version info of selected instance:
+              Shows the status and the version information for an
+              instance.
             </para>
 
 <programlisting>
@@ -11308,11 +11317,11 @@
           <listitem>
             <para>
               <literal>SHOW INSTANCE OPTIONS
-              &lt;instance_name&gt;</literal>
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              Show options used by an instance:
+              Shows the options used by an instance.
             </para>
 
 <programlisting>
@@ -11334,18 +11343,20 @@
 
           <listitem>
             <para>
-              <literal>SHOW &lt;instance_name&gt; LOG FILES</literal>
+              <literal>SHOW <replaceable>instance_name</replaceable> LOG
+              FILES</literal>
             </para>
 
             <para>
-              The command provides a listing of all log files used by
-              the instance. The result set contains the path to the log
-              file and the log file size. If no log file path is
-              specified in the configuration file (i.e.
-              <literal>log=/var/mysql.log</literal>), the IM tries to
-              guess its placement. If the IM is unable to guess the
-              logfile placement you should specify the log file location
-              explicitly.
+              The command lists all log files used by the instance. The
+              result set contains the path to the log file and the log
+              file size. If no log file path is specified in the
+              configuration file (for example,
+              <literal>log=/var/mysql.log</literal>), the Instance
+              Manager tries to guess its placement. If the IM is unable
+              to guess the logfile placement you should specify the log
+              file location explicitly by using the appropriate log
+              option in the instance section of the configuration file.
             </para>
 
 <programlisting>
@@ -11363,18 +11374,19 @@
 
           <listitem>
             <para>
-              <literal>SHOW &lt;instance_name&gt; LOG {ERROR | SLOW |
-              GENERAL} size[,offset_from_end]</literal>
+              <literal>SHOW <replaceable>instance_name</replaceable> LOG
+              {ERROR | SLOW | GENERAL}
+              <replaceable>size</replaceable>[,<replaceable>offset_from_end</replaceable>]</literal>
             </para>
 
             <para>
               This command retrieves a portion of the specified log
               file. Because most users are interested in the latest log
-              messages, the <literal>size</literal> parameter defines
-              the number of bytes you would like to retrieve starting
-              from the log end. You can retrieve data from the middle of
-              the log file by specifying the optional
-              <literal>offset_from_end</literal> parameter. The
+              messages, the <replaceable>size</replaceable> parameter
+              defines the number of bytes you would like to retrieve
+              starting from the log end. You can retrieve data from the
+              middle of the log file by specifying the optional
+              <replaceable>offset_from_end</replaceable> parameter. The
               following example retrieves 21 bytes of data, starting 23
               bytes from the end of the log file and ending 2 bytes from
               the end of the log file:
@@ -11394,13 +11406,13 @@
           <listitem>
             <para>
               <literal>SET
-              instance_name.option_name=option_value</literal>
+              <replaceable>instance_name</replaceable>.<replaceable>option_name</replaceable>=<replaceable>option_value</replaceable></literal>
             </para>
 
             <para>
-              This commands edits the specified instance's configuration
-              file to change/add instance options. The IM assumes that
-              the configuration file is located at
+              This command edits the specified instance's configuration
+              file to change or add instance options. The IM assumes
+              that the configuration file is located at
               <filename>/etc/my.cnf</filename>. You should check that
               the file exists and has appropriate permissions.
             </para>
@@ -11411,17 +11423,18 @@
 </programlisting>
 
             <para>
-              Changes made to the configuration file will not take
-              effect until the MySQL server is restarted. In addition,
-              these changes are not stored in the instance manager's
-              local cache of instance settings until a <literal>FLUSH
+              Changes made to the configuration file do not take effect
+              until the MySQL server is restarted. In addition, these
+              changes are not stored in the instance manager's local
+              cache of instance settings until a <literal>FLUSH
               INSTANCES</literal> command is executed.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <literal>UNSET instance_name.option_name</literal>
+              <literal>UNSET
+              <replaceable>instance_name</replaceable>.<replaceable>option_name</replaceable></literal>
             </para>
 
             <para>
@@ -11435,10 +11448,10 @@
 </programlisting>
 
             <para>
-              Changes made to the configuration file will not take
-              effect until the MySQL server is restarted. In addition,
-              these changes are not stored in the instance manager's
-              local cache of instance settings until a <literal>FLUSH
+              Changes made to the configuration file do not take effect
+              until the MySQL server is restarted. In addition, these
+              changes are not stored in the instance manager's local
+              cache of instance settings until a <literal>FLUSH
               INSTANCES</literal> command is executed.
             </para>
           </listitem>
@@ -11451,8 +11464,8 @@
             <para>
               This command forces IM to reread the configuration file
               and to refresh internal structures. This command should be
-              performed after editing the configuration file. This
-              command does not restart instances:
+              performed after editing the configuration file. The
+              command does not restart instances.
             </para>
 
 <programlisting>
@@ -22268,7 +22281,7 @@
         <literal>CREATE</literal>/<literal>ALTER</literal>/<literal>DROP
         DATABASE</literal> statements. In those cases, the database
         being <emphasis>created, altered, or dropped</emphasis> replaces
-        the default database in the rules below.
+        the default database in the following rules.
       </para>
 
       <orderedlist>

Modified: trunk/refman-5.0/renamed-nodes.txt
===================================================================
--- trunk/refman-5.0/renamed-nodes.txt	2006-01-23 21:26:06 UTC (rev 1002)
+++ trunk/refman-5.0/renamed-nodes.txt	2006-01-23 21:26:18 UTC (rev 1003)
@@ -404,3 +404,4 @@
 gis-features-that-are-not-yet-implemented mysql-gis-conformance-and-compatibility
 parentheses operator-precedence
 server-side-scripts server-side-overview
+instance-manager-command-line-options instance-manager-command-options

Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml	2006-01-23 21:26:06 UTC (rev 1002)
+++ trunk/refman-5.1/database-administration.xml	2006-01-23 21:26:18 UTC (rev 1003)
@@ -10710,20 +10710,21 @@
         <title>Description</title>
 
         <para>
-          The MySQL Instance Manager (IM) is a daemon running on a
-          TCP/IP port, which serves for monitoring and management of
-          MySQL Database Server instances. MySQL Instance Manager is
-          available for Unix-like operating systems, as well as Windows.
+          <command>mysqlmanager</command> is the MySQL Instance Manager
+          (IM). This program is a daemon running on a TCP/IP port that
+          serves to monitor and manage MySQL Database Server instances.
+          MySQL Instance Manager is available for Unix-like operating
+          systems, as well as Windows.
         </para>
 
         <para>
           MySQL Instance Manager can be used in place of the
           <literal>mysqld_safe</literal> script to start and stop the
-          MySQL Server, <emphasis role="bold">even from a remote
-          host</emphasis>. MySQL Instance Manager also implements the
-          functionality (and most of the syntax) of the
-          <command>mysqld_multi</command> script. A more detailed
-          description of MySQL Instance Manager follows.
+          MySQL Server, <emphasis>even from a remote host</emphasis>.
+          MySQL Instance Manager also implements the functionality (and
+          most of the syntax) of the <command>mysqld_multi</command>
+          script. A more detailed description of MySQL Instance Manager
+          follows.
         </para>
 
       </refsection>
@@ -10733,13 +10734,14 @@
         <title>&title-instance-manager-startup-process;</title>
 
         <para>
-          Normally, the MySQL Database Server is started with the
-          <command>mysql.server</command> script, which usually resides
-          in the <literal>/etc/init.d/</literal> folder. This script
-          invokes the <command>mysqld_safe</command> script by default.
-          However, you can set the <literal>use_mysqld_safe</literal>
-          variable in the script to <literal>0</literal> (zero) in order
-          to use the MySQL Instance Manager to start a server.
+          Normally, the <command>mysqld</command> MySQL Database Server
+          is started with the <command>mysql.server</command> script,
+          which usually resides in the <literal>/etc/init.d/</literal>
+          folder. This script invokes the <command>mysqld_safe</command>
+          script by default. However, you can set the
+          <literal>use_mysqld_safe</literal> variable in the script to
+          <literal>0</literal> (zero) in order to use the MySQL Instance
+          Manager to start a server.
         </para>
 
         <remark role="todo">
@@ -10751,32 +10753,32 @@
         <para>
           The Instance Manager's behavior in this case depends on the
           options given in the MySQL configuration file. If there is no
-          configuration file, the MySQL Instance Manager creates an
-          instance named <literal>mysqld</literal> and attempts to start
-          it with default (compiled-in) configuration values. This means
-          that the IM cannot guess the placement of
+          configuration file, the MySQL Instance Manager creates a
+          server instance named <literal>mysqld</literal> and attempts
+          to start it with default (compiled-in) configuration values.
+          This means that the IM cannot guess the placement of
           <command>mysqld</command> if it is not installed in the
           default location. If you have installed the MySQL server in a
-          non-standard location you should use a configuration file. See
-          <xref linkend="installation-layouts"/>.
+          non-standard location, you should use a configuration file.
+          See <xref linkend="installation-layouts"/>.
         </para>
 
         <para>
-          If there is a configuration file, the IM will parse the
-          configuration file in search of <literal>[mysqld]</literal>
-          sections (E.g. <literal>[mysqld]</literal>,
-          <literal>[mysqld1]</literal>, <literal>[mysqld2]</literal>,
-          etc.) Each such section specifies an instance. At startup the
-          IM will start all found instances. The IM stops all instances
-          at shutdown by default.
+          If there is a configuration file, the IM reads it to find
+          <literal>[mysqld]</literal> sections (for example,
+          <literal>[mysqld]</literal>, <literal>[mysqld1]</literal>,
+          <literal>[mysqld2]</literal>, and so forth). Each such section
+          specifies an instance. When it starts, the Instance Manager
+          attempts to start all server instances that it finds. By
+          default, the Instance Manager stops all server instances when
+          it shuts down.
         </para>
 
         <para>
-          Note that there is a special option
-          <literal>mysqld-path</literal> (<literal>mysqld-path =
-          <replaceable>path-to-mysqld-binary</replaceable></literal>)
-          which is recognized only by the IM. Use this variable to let
-          the IM know where the <command>mysqld</command> binary
+          Note that there is a special
+          <option>--mysqld-path=<replaceable>path-to-mysqld-binary</replaceable></option>
+          option that is recognized only by the IM. Use this variable to
+          let the IM know where the <command>mysqld</command> binary
           resides. You should also set <literal>basedir</literal> and
           <literal>datadir</literal> options for the server.
         </para>
@@ -10786,7 +10788,7 @@
           MySQL Instance Manager enabled is as follows:
         </para>
 
-        <itemizedlist>
+        <orderedlist>
 
           <listitem>
             <para>
@@ -10818,7 +10820,7 @@
             </para>
           </listitem>
 
-        </itemizedlist>
+        </orderedlist>
 
       </refsection>
 
@@ -10832,7 +10834,7 @@
           the IM using the standard <command>mysql</command> client
           program, as well as the MySQL C API. The IM supports the
           version of the MySQL client-server protocol used by the client
-          tools and libraries distributed along with mysql-4.1 or later.
+          tools and libraries distributed along with MySQL 4.1 or later.
         </para>
 
         <refsection id="instance-manager-security-passwords">
@@ -10840,13 +10842,13 @@
           <title>Instance Manager Users and Passwords</title>
 
           <para>
-            The IM stores its user information in a password file.
-            Default placement for the password file is
-            <filename>/etc/mysqlmanager.passwd</filename>
+            The Instance Manager stores its user information in a
+            password file. The default name of the password file is
+            <filename>/etc/mysqlmanager.passwd</filename>.
           </para>
 
           <para>
-            Password entries look like the following:
+            Password entries have the following format:
           </para>
 
 <programlisting>
@@ -10854,36 +10856,36 @@
 </programlisting>
 
           <para>
-            To generate such an entry one should invoke IM with the
+            If there are no entries in the
+            <filename>/etc/mysqlmanager.passwd</filename> file, you
+            cannot connect to the Instance Manager.
+          </para>
+
+          <para>
+            To generate a new entry, invoke Instance Manager with the
             <command>--passwd</command> option. Then the output can be
-            redirected to the
+            appended to the
             <filename>/etc/mysqlmanager.passwd</filename> file to add a
-            new user. A sample command is given below.
+            new user. Here is an example:
           </para>
 
 <programlisting>
-./mysqlmanager --passwd &gt;&gt; /etc/mysqlmanager.passwd
+shell&gt; <userinput>mysqlmanager --passwd &gt;&gt; /etc/mysqlmanager.passwd</userinput>
 Creating record for new user.
-Enter user name: mike
-Enter password: &lt;password&gt;
-Re-type password: &lt;password&gt;
+Enter user name: <replaceable>mike</replaceable>
+Enter password: <replaceable>password</replaceable>
+Re-type password: <replaceable>password</replaceable>
 </programlisting>
 
           <para>
-            The following line is added to
-            <filename>/etc/mysqlmanager.passwd</filename>:
+            The preceding command causes the following line to be added
+            to <filename>/etc/mysqlmanager.passwd</filename>:
           </para>
 
 <programlisting>
 mike:*00A51F3F48415C7D4E8908980D443C29C69B60C9
 </programlisting>
 
-          <para>
-            If there are no entries in the
-            <filename>/etc/mysqlmanager.passwd</filename> file one
-            cannot connect to the IM.
-          </para>
-
         </refsection>
 
         <refsection id="instance-manager-security-monitoring">
@@ -10891,9 +10893,9 @@
           <title>MySQL Server Accounts for Status Monitoring</title>
 
           <para>
-            In order to monitor server status, the MySQL Instance
-            Manager will attempt to connect to the MySQL server instance
-            at regular intervals using the
+            To monitor server status, the MySQL Instance Manager will
+            attempt to connect to the MySQL server instance at regular
+            intervals using the
             <literal>MySQL_Instance_Manager@localhost</literal> user
             account with a password of
             <literal>check_connection</literal>.
@@ -10904,26 +10906,31 @@
             <literal>MySQL_Instance_M@localhost</literal> user account
             in order for the MySQL Instance Manager to monitor server
             status, as a login failure is sufficient to identify that
-            the server is operational. However; because the account does
-            not exist the failed connection attempts will be recorded to
-            the <link linkend="query-log">General Query Log</link>.
+            the server is operational. However, if the account does not
+            exist, failed connection attempts are logged by the server
+            to its general query log (see <xref linkend="query-log"/>).
           </para>
 
         </refsection>
 
       </refsection>
 
-      <refsection id="instance-manager-command-line-options">
+      <refsection id="instance-manager-command-options">
 
-        <title>&title-instance-manager-command-line-options;</title>
+        <title>&title-instance-manager-command-options;</title>
 
         <para>
           The MySQL Instance Manager supports a number of command line
-          options. A brief listing is available by executing the
-          <command>./mysqlmanager --help</command> command. The
-          following options are available:
+          options. For a brief listing, invoke
+          <command>mysqlmanager</command> with the
+          <option>--help</option> option.
         </para>
 
+        <para>
+          <command>mysqlmanager</command> supports the following
+          options:
+        </para>
+
         <itemizedlist>
 
           <listitem>
@@ -10932,13 +10939,13 @@
             </para>
 
             <para>
-              Display the help message and exit.
+              Display a help message and exit.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <option>--bind-address=<replaceable>name</replaceable></option>
+              <option>--bind-address=<replaceable>IP</replaceable></option>
             </para>
 
             <para>
@@ -10948,13 +10955,13 @@
 
           <listitem>
             <para>
-              <option>--default-mysqld-path=<replaceable>name</replaceable></option>
+              <option>--default-mysqld-path=<replaceable>path</replaceable></option>
             </para>
 
             <para>
-              On Unix, where to look for the MySQL Server binary, if no
+              On Unix, the pathname of the MySQL Server binary, if no
               path was provided in the instance section. Example:
-              <literal>default-mysqld-path = /usr/sbin/mysqld</literal>
+              <option>--default-mysqld-path=/usr/sbin/mysqld</option>
             </para>
           </listitem>
 
@@ -10998,15 +11005,14 @@
             </para>
 
             <para>
-              Interval to monitor instances in seconds. Instance manager
-              will try to connect to each of monitored instances to
-              check whether they are alive/not hanging. In the case of a
-              failure IM will perform several (in fact many) attempts to
-              restart the instance. One can disable this behavior for
-              particular instances with the
+              The interval in seconds for monitoring instances. The
+              default value is 20 seconds. Instance Manager tries to
+              connect to each monitored instance to check whether it is
+              alive/not hanging. In the case of a failure, IM performs
+              several attempts to restart the instance. The
               <literal>nonguarded</literal> option in the appropriate
-              instance section. If no value was given, the default of 20
-              seconds will be used.
+              instance section disables this behavior for a particular
+              instance.
             </para>
           </listitem>
 
@@ -11016,7 +11022,7 @@
             </para>
 
             <para>
-              Prepare entry for passwd file and exit.
+              Prepare an entry for the password file and exit.
             </para>
           </listitem>
 
@@ -11049,8 +11055,8 @@
             </para>
 
             <para>
-              The port number to use for connections. (The default port
-              number, assigned by IANA, is 2273).
+              The TCP/IP port number to use for connections. (The
+              default port number assigned by IANA is 2273).
             </para>
           </listitem>
 
@@ -11084,14 +11090,14 @@
 
             <para>
               Daemonize and start the angel process. The angel process
-              is simple and unlikely to crash. It will restart the IM
-              itself in case of a failure.
+              is simple and unlikely to crash. It will restart the
+              Instance Manager itself in case of a failure.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <option>--socket=<replaceable>name</replaceable></option>
+              <option>--socket=<replaceable>path</replaceable></option>
             </para>
 
             <para>
@@ -11113,7 +11119,7 @@
 
           <listitem>
             <para>
-              <option>--user=<replaceable>name</replaceable></option>
+              <option>--user=<replaceable>user_name</replaceable></option>
             </para>
 
             <para>
@@ -11147,8 +11153,9 @@
           file. It uses the <literal>[manager]</literal> section to read
           options for itself and the <literal>[mysqld]</literal>
           sections to create instances. The <literal>[manager]</literal>
-          section contains any of the options listed above. An example
-          <literal>[manager]</literal> section is given below:
+          section contains any of the options listed in
+          <xref linkend="instance-manager-command-options"/>. Here is an
+          example <literal>[manager]</literal> section:
         </para>
 
 <programlisting>
@@ -11185,11 +11192,12 @@
           <listitem>
             <para>
               <literal>mysqld-path =
-              &lt;path-to-mysqld-binary&gt;</literal>
+              <replaceable>path</replaceable></literal>
             </para>
 
             <para>
-              The path to the <command>mysqld</command> server binary.
+              The pathname to the <command>mysqld</command> server
+              binary.
             </para>
           </listitem>
 
@@ -11201,11 +11209,11 @@
 
             <para>
               The number of seconds IM should wait for the instance to
-              shut down. The default is 35 seconds. After the delay
-              expires, the IM assumes that the instance is hanging and
-              attempts to <literal>kill -9</literal> it. If you use
-              <literal>InnoDB</literal> with large tables, you should
-              increase this value.
+              shut down. The default value is 35 seconds. After the
+              delay expires, the IM assumes that the instance is hanging
+              and attempts to use <literal>kill -9</literal> to
+              terminate it. If you use <literal>InnoDB</literal> with
+              large tables, you should increase this value.
             </para>
           </listitem>
 
@@ -11215,7 +11223,7 @@
             </para>
 
             <para>
-              This option should be set if you want to disable IM
+              This option should be specified if you want to disable IM
               monitoring functionality for a certain instance.
             </para>
           </listitem>
@@ -11223,7 +11231,7 @@
         </itemizedlist>
 
         <para>
-          Several sample instance sections are given below.
+          Here are some sample instance sections:
         </para>
 
 <programlisting>
@@ -11271,11 +11279,12 @@
 
           <listitem>
             <para>
-              <literal>START INSTANCE &lt;instance_name&gt;</literal>
+              <literal>START INSTANCE
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              This command will attempt to start an instance:
+              This command attempts to start an instance.
             </para>
 
 <programlisting>
@@ -11286,11 +11295,12 @@
 
           <listitem>
             <para>
-              <literal>STOP INSTANCE &lt;instance_name&gt;</literal>
+              <literal>STOP INSTANCE
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              This will attempt to stop an instance:
+              This command attempts to stop an instance.
             </para>
 
 <programlisting>
@@ -11305,11 +11315,11 @@
             </para>
 
             <para>
-              Show the names of all loaded instances:
+              Shows the names of all loaded instances.
             </para>
 
 <programlisting>
-mysql&gt; <userinput>show instances;</userinput>
+mysql&gt; <userinput>SHOW INSTANCES;</userinput>
 +---------------+---------+
 | instance_name | status  |
 +---------------+---------+
@@ -11324,11 +11334,12 @@
           <listitem>
             <para>
               <literal>SHOW INSTANCE STATUS
-              &lt;instance_name&gt;</literal>
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              Show the status and the version info of selected instance:
+              Shows the status and the version information for an
+              instance.
             </para>
 
 <programlisting>
@@ -11345,11 +11356,11 @@
           <listitem>
             <para>
               <literal>SHOW INSTANCE OPTIONS
-              &lt;instance_name&gt;</literal>
+              <replaceable>instance_name</replaceable></literal>
             </para>
 
             <para>
-              Show options used by an instance:
+              Shows the options used by an instance.
             </para>
 
 <programlisting>
@@ -11371,18 +11382,20 @@
 
           <listitem>
             <para>
-              <literal>SHOW &lt;instance_name&gt; LOG FILES</literal>
+              <literal>SHOW <replaceable>instance_name</replaceable> LOG
+              FILES</literal>
             </para>
 
             <para>
-              The command provides a listing of all log files used by
-              the instance. The result set contains the path to the log
-              file and the log file size. If no log file path is
-              specified in the configuration file (i.e.
-              <literal>log=/var/mysql.log</literal>), the IM tries to
-              guess its placement. If the IM is unable to guess the
-              logfile placement you should specify the log file location
-              explicitly.
+              The command lists all log files used by the instance. The
+              result set contains the path to the log file and the log
+              file size. If no log file path is specified in the
+              configuration file (for example,
+              <literal>log=/var/mysql.log</literal>), the Instance
+              Manager tries to guess its placement. If the IM is unable
+              to guess the logfile placement you should specify the log
+              file location explicitly by using the appropriate log
+              option in the instance section of the configuration file.
             </para>
 
 <programlisting>
@@ -11400,18 +11413,19 @@
 
           <listitem>
             <para>
-              <literal>SHOW &lt;instance_name&gt; LOG {ERROR | SLOW |
-              GENERAL} size[,offset_from_end]</literal>
+              <literal>SHOW <replaceable>instance_name</replaceable> LOG
+              {ERROR | SLOW | GENERAL}
+              <replaceable>size</replaceable>[,<replaceable>offset_from_end</replaceable>]</literal>
             </para>
 
             <para>
               This command retrieves a portion of the specified log
               file. Because most users are interested in the latest log
-              messages, the <literal>size</literal> parameter defines
-              the number of bytes you would like to retrieve starting
-              from the log end. You can retrieve data from the middle of
-              the log file by specifying the optional
-              <literal>offset_from_end</literal> parameter. The
+              messages, the <replaceable>size</replaceable> parameter
+              defines the number of bytes you would like to retrieve
+              starting from the log end. You can retrieve data from the
+              middle of the log file by specifying the optional
+              <replaceable>offset_from_end</replaceable> parameter. The
               following example retrieves 21 bytes of data, starting 23
               bytes from the end of the log file and ending 2 bytes from
               the end of the log file:
@@ -11431,13 +11445,13 @@
           <listitem>
             <para>
               <literal>SET
-              instance_name.option_name=option_value</literal>
+              <replaceable>instance_name</replaceable>.<replaceable>option_name</replaceable>=<replaceable>option_value</replaceable></literal>
             </para>
 
             <para>
-              This commands edits the specified instance's configuration
-              file to change/add instance options. The IM assumes that
-              the configuration file is located at
+              This command edits the specified instance's configuration
+              file to change or add instance options. The IM assumes
+              that the configuration file is located at
               <filename>/etc/my.cnf</filename>. You should check that
               the file exists and has appropriate permissions.
             </para>
@@ -11448,17 +11462,18 @@
 </programlisting>
 
             <para>
-              Changes made to the configuration file will not take
-              effect until the MySQL server is restarted. In addition,
-              these changes are not stored in the instance manager's
-              local cache of instance settings until a <literal>FLUSH
+              Changes made to the configuration file do not take effect
+              until the MySQL server is restarted. In addition, these
+              changes are not stored in the instance manager's local
+              cache of instance settings until a <literal>FLUSH
               INSTANCES</literal> command is executed.
             </para>
           </listitem>
 
           <listitem>
             <para>
-              <literal>UNSET instance_name.option_name</literal>
+              <literal>UNSET
+              <replaceable>instance_name</replaceable>.<replaceable>option_name</replaceable></literal>
             </para>
 
             <para>
@@ -11472,10 +11487,10 @@
 </programlisting>
 
             <para>
-              Changes made to the configuration file will not take
-              effect until the MySQL server is restarted. In addition,
-              these changes are not stored in the instance manager's
-              local cache of instance settings until a <literal>FLUSH
+              Changes made to the configuration file do not take effect
+              until the MySQL server is restarted. In addition, these
+              changes are not stored in the instance manager's local
+              cache of instance settings until a <literal>FLUSH
               INSTANCES</literal> command is executed.
             </para>
           </listitem>
@@ -11488,8 +11503,8 @@
             <para>
               This command forces IM to reread the configuration file
               and to refresh internal structures. This command should be
-              performed after editing the configuration file. This
-              command does not restart instances:
+              performed after editing the configuration file. The
+              command does not restart instances.
             </para>
 
 <programlisting>
@@ -22278,7 +22293,7 @@
         <literal>CREATE</literal>/<literal>ALTER</literal>/<literal>DROP
         DATABASE</literal> statements. In those cases, the database
         being <emphasis>created, altered, or dropped</emphasis> replaces
-        the default database in the rules below.
+        the default database in the following rules.
       </para>
 
       <orderedlist>

Modified: trunk/refman-5.1/renamed-nodes.txt
===================================================================
--- trunk/refman-5.1/renamed-nodes.txt	2006-01-23 21:26:06 UTC (rev 1002)
+++ trunk/refman-5.1/renamed-nodes.txt	2006-01-23 21:26:18 UTC (rev 1003)
@@ -108,3 +108,4 @@
 gis-features-that-are-not-yet-implemented mysql-gis-conformance-and-compatibility
 parentheses operator-precedence
 server-side-scripts server-side-overview
+instance-manager-command-line-options instance-manager-command-options

Modified: trunk/refman-common/titles.en.ent
===================================================================
--- trunk/refman-common/titles.en.ent	2006-01-23 21:26:06 UTC (rev 1002)
+++ trunk/refman-common/titles.en.ent	2006-01-23 21:26:18 UTC (rev 1003)
@@ -561,7 +561,7 @@
 <!ENTITY title-installing-myodbc "How to Install MyODBC">
 <!ENTITY title-installing-source "MySQL Installation Using a Source Distribution">
 <!ENTITY title-installing-source-tree "Installing from the Development Source Tree">
-<!ENTITY title-instance-manager-command-line-options "MySQL Instance Manager Command Options">
+<!ENTITY title-instance-manager-command-options "MySQL Instance Manager Command Options">
 <!ENTITY title-instance-manager-commands "Commands Recognized by the MySQL Instance Manager">
 <!ENTITY title-instance-manager-configuration-files "MySQL Instance Manager Configuration Files">
 <!ENTITY title-instance-manager-for-manpage "the MySQL Instance Manager">

Thread
svn commit - mysqldoc@docsrva: r1003 - in trunk: . refman-5.0 refman-5.1 refman-commonpaul23 Jan