Author: paul
Date: 2007-02-27 22:32:41 +0100 (Tue, 27 Feb 2007)
New Revision: 5099
Log:
r20597@polar: paul | 2007-02-27 15:18:14 -0600
Convert ndb_waiter section to use manpage markup.
Modified:
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:20593
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16743
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:14593
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:20597
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16743
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:14593
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2007-02-27 20:29:20 UTC (rev 5098)
+++ trunk/refman-4.1/mysql-cluster.xml 2007-02-27 21:32:41 UTC (rev 5099)
Changed blocks: 2, Lines Added: 155, Lines Deleted: 120; 11449 bytes
@@ -15018,155 +15018,186 @@
-->
- <section id="mysql-cluster-utilities-ndb-waiter">
+ <section id="fake-id-for-ndb-waiter-manpage-section-wrapper">
- <title><command>ndb_waiter</command></title>
+ <title>fake title for ndb_waiter manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_waiter</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-waiter">
- <para>
- <emphasis role="bold">Description</emphasis>: Repeatedly (each
- 100 milliseconds) prints out the status of all cluster data
- nodes until either the cluster reaches a given status or the
- <option>--timeout</option> limit is exceeded, then exits. By
- default, it waits for the cluster to achieve
- <literal>STARTED</literal> status, in which all nodes have
- started and connected to the cluster. This can be overridden
- using the <option>--no-contact</option> and
- <option>--not-started</option> options (see
- <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
- Options</link>).
- </para>
+ <indexterm>
+ <primary>ndb_waiter</primary>
+ </indexterm>
- <para>
- The node states reported by this utility are as follows:
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_waiter</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Wait for Cluster to Reach a Given Status</refmiscinfo>
+ </refmeta>
- <itemizedlist>
+ <refnamediv>
+ <refname>ndb_waiter</refname>
+
+ <refpurpose>wait for cluster to reach a given status</refpurpose>
+ </refnamediv>
- <listitem>
- <para>
- <literal>NO_CONTACT</literal>: The node cannot be contacted.
- </para>
- </listitem>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_waiter <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <listitem>
- <para>
- <literal>UNKNOWN</literal>: The node can be contacted, but
- its status is not yet known. Usually, this means that the
- node has received a <literal>START</literal> or
- <literal>RESTART</literal> command from the management
- server, but has not yet acted on it.
- </para>
- </listitem>
+ <refsection id="ndb-waiter-description">
- <listitem>
- <para>
- <literal>NOT_STARTED</literal>: The node has stopped, but
- remains in contact with the cluster. This is seen when
- restarting the node using the management client's
- <literal>RESTART</literal> command.
- </para>
- </listitem>
+ <title>Description</title>
- <listitem>
<para>
- <literal>STARTING</literal>: The node's
- <command>ndbd</command> process has started, but the node
- has not yet joined the cluster.
+ <command>ndb_waiter</command> repeatedly (each 100
+ milliseconds) prints out the status of all cluster data
+ nodes until either the cluster reaches a given status or the
+ <option>--timeout</option> limit is exceeded, then exits. By
+ default, it waits for the cluster to achieve
+ <literal>STARTED</literal> status, in which all nodes have
+ started and connected to the cluster. This can be overridden
+ using the <option>--no-contact</option> and
+ <option>--not-started</option> options (see
+ <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
+ Options</link>).
</para>
- </listitem>
- <listitem>
<para>
- <literal>STARTED</literal>: The node is operational, and has
- joined the cluster.
+ The node states reported by this utility are as follows:
</para>
- </listitem>
- <listitem>
- <para>
- <literal>SHUTTING_DOWN</literal>: The node is shutting down.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>SINGLE USER MODE</literal>: This is shown for all
- cluster data nodes when the cluster is in single user mode.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>NO_CONTACT</literal>: The node cannot be
+ contacted.
+ </para>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <literal>UNKNOWN</literal>: The node can be contacted,
+ but its status is not yet known. Usually, this means
+ that the node has received a <literal>START</literal> or
+ <literal>RESTART</literal> command from the management
+ server, but has not yet acted on it.
+ </para>
+ </listitem>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <listitem>
+ <para>
+ <literal>NOT_STARTED</literal>: The node has stopped,
+ but remains in contact with the cluster. This is seen
+ when restarting the node using the management client's
+ <literal>RESTART</literal> command.
+ </para>
+ </listitem>
-<programlisting>
-ndb_waiter [-c <replaceable>connect_string</replaceable>]
-</programlisting>
+ <listitem>
+ <para>
+ <literal>STARTING</literal>: The node's
+ <command>ndbd</command> process has started, but the
+ node has not yet joined the cluster.
+ </para>
+ </listitem>
- <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <listitem>
+ <para>
+ <literal>STARTED</literal>: The node is operational, and
+ has joined the cluster.
+ </para>
+ </listitem>
- <itemizedlist>
+ <listitem>
+ <para>
+ <literal>SHUTTING_DOWN</literal>: The node is shutting
+ down.
+ </para>
+ </listitem>
- <listitem>
- <para>
- -n, --no-contact
- </para>
+ <listitem>
+ <para>
+ <literal>SINGLE USER MODE</literal>: This is shown for
+ all cluster data nodes when the cluster is in single
+ user mode.
+ </para>
+ </listitem>
- <para>
- Instead of waiting for the <literal>STARTED</literal> state,
- <command>ndb_waiter</command> continues running until the
- cluster reaches <literal>NO_CONTACT</literal> status before
- exiting.
- </para>
- </listitem>
+ </itemizedlist>
- <listitem>
<para>
- --not-started
+ <emphasis role="bold">Usage</emphasis>:
</para>
- <para>
- Instead of waiting for the <literal>STARTED</literal> state,
- <command>ndb_waiter</command> continues running until the
- cluster reaches <literal>NOT_STARTED</literal> status before
- exiting.
+<programlisting>
+ndb_waiter [-c <replaceable>connect_string</replaceable>]
+</programlisting>
+
+ <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
+ <emphasis role="bold">Additional Options</emphasis>:
</para>
- </listitem>
- <listitem>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ -n, --no-contact
+ </para>
+
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NO_CONTACT</literal>
+ status before exiting.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ --not-started
+ </para>
+
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NOT_STARTED</literal>
+ status before exiting.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ -t, --timeout=#
+ </para>
+
+ <para>
+ Time to wait. The program exits if the desired state is
+ not achieved within this number of seconds. The default
+ is 120 seconds (1200 reporting cycles).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<para>
- -t, --timeout=#
+ <emphasis role="bold">Sample Output</emphasis>:
</para>
<para>
- Time to wait. The program exits if the desired state is not
- achieved within this number of seconds. The default is 120
- seconds (1200 reporting cycles).
+ Shown here is the output from <command>ndb_waiter</command>
+ when run against a 4-node cluster in which two nodes have
+ been shut down and then started again manually. Duplicate
+ reports (indicated by <quote><literal>...</literal></quote>)
+ are omitted.
</para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
-
- <para>
- Shown here is the output from <command>ndb_waiter</command> when
- run against a 4-node cluster in which two nodes have been shut
- down and then started again manually. Duplicate reports
- (indicated by <quote><literal>...</literal></quote>) are
- omitted.
- </para>
-
<programlisting>
shell> <userinput>./ndb_waiter -c localhost</userinput>
@@ -15228,13 +15259,17 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- <emphasis role="bold">Note</emphasis>: If no connectstring is
- specified, then <command>ndb_waiter</command> tries to connect
- to a management on <literal>localhost</literal>, and reports
- <literal>Connecting to mgmsrv at (null)</literal>.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>: If no connectstring
+ is specified, then <command>ndb_waiter</command> tries to
+ connect to a management on <literal>localhost</literal>, and
+ reports <literal>Connecting to mgmsrv at (null)</literal>.
+ </para>
+ </refsection>
+
+ </refentry>
+
</section>
</section>
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2007-02-27 20:29:20 UTC (rev 5098)
+++ trunk/refman-5.0/mysql-cluster.xml 2007-02-27 21:32:41 UTC (rev 5099)
Changed blocks: 2, Lines Added: 155, Lines Deleted: 120; 11449 bytes
@@ -15131,155 +15131,186 @@
-->
- <section id="mysql-cluster-utilities-ndb-waiter">
+ <section id="fake-id-for-ndb-waiter-manpage-section-wrapper">
- <title><command>ndb_waiter</command></title>
+ <title>fake title for ndb_waiter manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_waiter</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-waiter">
- <para>
- <emphasis role="bold">Description</emphasis>: Repeatedly (each
- 100 milliseconds) prints out the status of all cluster data
- nodes until either the cluster reaches a given status or the
- <option>--timeout</option> limit is exceeded, then exits. By
- default, it waits for the cluster to achieve
- <literal>STARTED</literal> status, in which all nodes have
- started and connected to the cluster. This can be overridden
- using the <option>--no-contact</option> and
- <option>--not-started</option> options (see
- <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
- Options</link>).
- </para>
+ <indexterm>
+ <primary>ndb_waiter</primary>
+ </indexterm>
- <para>
- The node states reported by this utility are as follows:
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_waiter</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Wait for Cluster to Reach a Given Status</refmiscinfo>
+ </refmeta>
- <itemizedlist>
+ <refnamediv>
+ <refname>ndb_waiter</refname>
+
+ <refpurpose>wait for cluster to reach a given status</refpurpose>
+ </refnamediv>
- <listitem>
- <para>
- <literal>NO_CONTACT</literal>: The node cannot be contacted.
- </para>
- </listitem>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_waiter <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <listitem>
- <para>
- <literal>UNKNOWN</literal>: The node can be contacted, but
- its status is not yet known. Usually, this means that the
- node has received a <literal>START</literal> or
- <literal>RESTART</literal> command from the management
- server, but has not yet acted on it.
- </para>
- </listitem>
+ <refsection id="ndb-waiter-description">
- <listitem>
- <para>
- <literal>NOT_STARTED</literal>: The node has stopped, but
- remains in contact with the cluster. This is seen when
- restarting the node using the management client's
- <literal>RESTART</literal> command.
- </para>
- </listitem>
+ <title>Description</title>
- <listitem>
<para>
- <literal>STARTING</literal>: The node's
- <command>ndbd</command> process has started, but the node
- has not yet joined the cluster.
+ <command>ndb_waiter</command> repeatedly (each 100
+ milliseconds) prints out the status of all cluster data
+ nodes until either the cluster reaches a given status or the
+ <option>--timeout</option> limit is exceeded, then exits. By
+ default, it waits for the cluster to achieve
+ <literal>STARTED</literal> status, in which all nodes have
+ started and connected to the cluster. This can be overridden
+ using the <option>--no-contact</option> and
+ <option>--not-started</option> options (see
+ <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
+ Options</link>).
</para>
- </listitem>
- <listitem>
<para>
- <literal>STARTED</literal>: The node is operational, and has
- joined the cluster.
+ The node states reported by this utility are as follows:
</para>
- </listitem>
- <listitem>
- <para>
- <literal>SHUTTING_DOWN</literal>: The node is shutting down.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>SINGLE USER MODE</literal>: This is shown for all
- cluster data nodes when the cluster is in single user mode.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>NO_CONTACT</literal>: The node cannot be
+ contacted.
+ </para>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <literal>UNKNOWN</literal>: The node can be contacted,
+ but its status is not yet known. Usually, this means
+ that the node has received a <literal>START</literal> or
+ <literal>RESTART</literal> command from the management
+ server, but has not yet acted on it.
+ </para>
+ </listitem>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <listitem>
+ <para>
+ <literal>NOT_STARTED</literal>: The node has stopped,
+ but remains in contact with the cluster. This is seen
+ when restarting the node using the management client's
+ <literal>RESTART</literal> command.
+ </para>
+ </listitem>
-<programlisting>
-ndb_waiter [-c <replaceable>connect_string</replaceable>]
-</programlisting>
+ <listitem>
+ <para>
+ <literal>STARTING</literal>: The node's
+ <command>ndbd</command> process has started, but the
+ node has not yet joined the cluster.
+ </para>
+ </listitem>
- <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <listitem>
+ <para>
+ <literal>STARTED</literal>: The node is operational, and
+ has joined the cluster.
+ </para>
+ </listitem>
- <itemizedlist>
+ <listitem>
+ <para>
+ <literal>SHUTTING_DOWN</literal>: The node is shutting
+ down.
+ </para>
+ </listitem>
- <listitem>
- <para>
- -n, --no-contact
- </para>
+ <listitem>
+ <para>
+ <literal>SINGLE USER MODE</literal>: This is shown for
+ all cluster data nodes when the cluster is in single
+ user mode.
+ </para>
+ </listitem>
- <para>
- Instead of waiting for the <literal>STARTED</literal> state,
- <command>ndb_waiter</command> continues running until the
- cluster reaches <literal>NO_CONTACT</literal> status before
- exiting.
- </para>
- </listitem>
+ </itemizedlist>
- <listitem>
<para>
- --not-started
+ <emphasis role="bold">Usage</emphasis>:
</para>
- <para>
- Instead of waiting for the <literal>STARTED</literal> state,
- <command>ndb_waiter</command> continues running until the
- cluster reaches <literal>NOT_STARTED</literal> status before
- exiting.
+<programlisting>
+ndb_waiter [-c <replaceable>connect_string</replaceable>]
+</programlisting>
+
+ <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
+ <emphasis role="bold">Additional Options</emphasis>:
</para>
- </listitem>
- <listitem>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ -n, --no-contact
+ </para>
+
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NO_CONTACT</literal>
+ status before exiting.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ --not-started
+ </para>
+
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NOT_STARTED</literal>
+ status before exiting.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ -t, --timeout=#
+ </para>
+
+ <para>
+ Time to wait. The program exits if the desired state is
+ not achieved within this number of seconds. The default
+ is 120 seconds (1200 reporting cycles).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<para>
- -t, --timeout=#
+ <emphasis role="bold">Sample Output</emphasis>:
</para>
<para>
- Time to wait. The program exits if the desired state is not
- achieved within this number of seconds. The default is 120
- seconds (1200 reporting cycles).
+ Shown here is the output from <command>ndb_waiter</command>
+ when run against a 4-node cluster in which two nodes have
+ been shut down and then started again manually. Duplicate
+ reports (indicated by <quote><literal>...</literal></quote>)
+ are omitted.
</para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
-
- <para>
- Shown here is the output from <command>ndb_waiter</command> when
- run against a 4-node cluster in which two nodes have been shut
- down and then started again manually. Duplicate reports
- (indicated by <quote><literal>...</literal></quote>) are
- omitted.
- </para>
-
<programlisting>
shell> <userinput>./ndb_waiter -c localhost</userinput>
@@ -15341,13 +15372,17 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- <emphasis role="bold">Note</emphasis>: If no connectstring is
- specified, then <command>ndb_waiter</command> tries to connect
- to a management on <literal>localhost</literal>, and reports
- <literal>Connecting to mgmsrv at (null)</literal>.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>: If no connectstring
+ is specified, then <command>ndb_waiter</command> tries to
+ connect to a management on <literal>localhost</literal>, and
+ reports <literal>Connecting to mgmsrv at (null)</literal>.
+ </para>
+ </refsection>
+
+ </refentry>
+
</section>
</section>
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-02-27 20:29:20 UTC (rev 5098)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-02-27 21:32:41 UTC (rev 5099)
Changed blocks: 2, Lines Added: 155, Lines Deleted: 120; 11449 bytes
@@ -15238,155 +15238,186 @@
-->
- <section id="mysql-cluster-utilities-ndb-waiter">
+ <section id="fake-id-for-ndb-waiter-manpage-section-wrapper">
- <title><command>ndb_waiter</command></title>
+ <title>fake title for ndb_waiter manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_waiter</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-waiter">
- <para>
- <emphasis role="bold">Description</emphasis>: Repeatedly (each
- 100 milliseconds) prints out the status of all cluster data
- nodes until either the cluster reaches a given status or the
- <option>--timeout</option> limit is exceeded, then exits. By
- default, it waits for the cluster to achieve
- <literal>STARTED</literal> status, in which all nodes have
- started and connected to the cluster. This can be overridden
- using the <option>--no-contact</option> and
- <option>--not-started</option> options (see
- <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
- Options</link>).
- </para>
+ <indexterm>
+ <primary>ndb_waiter</primary>
+ </indexterm>
- <para>
- The node states reported by this utility are as follows:
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_waiter</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Wait for Cluster to Reach a Given Status</refmiscinfo>
+ </refmeta>
- <itemizedlist>
+ <refnamediv>
+ <refname>ndb_waiter</refname>
+
+ <refpurpose>wait for cluster to reach a given status</refpurpose>
+ </refnamediv>
- <listitem>
- <para>
- <literal>NO_CONTACT</literal>: The node cannot be contacted.
- </para>
- </listitem>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_waiter <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <listitem>
- <para>
- <literal>UNKNOWN</literal>: The node can be contacted, but
- its status is not yet known. Usually, this means that the
- node has received a <literal>START</literal> or
- <literal>RESTART</literal> command from the management
- server, but has not yet acted on it.
- </para>
- </listitem>
+ <refsection id="ndb-waiter-description">
- <listitem>
- <para>
- <literal>NOT_STARTED</literal>: The node has stopped, but
- remains in contact with the cluster. This is seen when
- restarting the node using the management client's
- <literal>RESTART</literal> command.
- </para>
- </listitem>
+ <title>Description</title>
- <listitem>
<para>
- <literal>STARTING</literal>: The node's
- <command>ndbd</command> process has started, but the node
- has not yet joined the cluster.
+ <command>ndb_waiter</command> repeatedly (each 100
+ milliseconds) prints out the status of all cluster data
+ nodes until either the cluster reaches a given status or the
+ <option>--timeout</option> limit is exceeded, then exits. By
+ default, it waits for the cluster to achieve
+ <literal>STARTED</literal> status, in which all nodes have
+ started and connected to the cluster. This can be overridden
+ using the <option>--no-contact</option> and
+ <option>--not-started</option> options (see
+ <link linkend="mysql-cluster-utilities-ndb-waiter-additional-options">Additional
+ Options</link>).
</para>
- </listitem>
- <listitem>
<para>
- <literal>STARTED</literal>: The node is operational, and has
- joined the cluster.
+ The node states reported by this utility are as follows:
</para>
- </listitem>
- <listitem>
- <para>
- <literal>SHUTTING_DOWN</literal>: The node is shutting down.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <literal>SINGLE USER MODE</literal>: This is shown for all
- cluster data nodes when the cluster is in single user mode.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <literal>NO_CONTACT</literal>: The node cannot be
+ contacted.
+ </para>
+ </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <literal>UNKNOWN</literal>: The node can be contacted,
+ but its status is not yet known. Usually, this means
+ that the node has received a <literal>START</literal> or
+ <literal>RESTART</literal> command from the management
+ server, but has not yet acted on it.
+ </para>
+ </listitem>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <listitem>
+ <para>
+ <literal>NOT_STARTED</literal>: The node has stopped,
+ but remains in contact with the cluster. This is seen
+ when restarting the node using the management client's
+ <literal>RESTART</literal> command.
+ </para>
+ </listitem>
-<programlisting>
-ndb_waiter [-c <replaceable>connect_string</replaceable>]
-</programlisting>
+ <listitem>
+ <para>
+ <literal>STARTING</literal>: The node's
+ <command>ndbd</command> process has started, but the
+ node has not yet joined the cluster.
+ </para>
+ </listitem>
- <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
+ <listitem>
+ <para>
+ <literal>STARTED</literal>: The node is operational, and
+ has joined the cluster.
+ </para>
+ </listitem>
- <itemizedlist>
+ <listitem>
+ <para>
+ <literal>SHUTTING_DOWN</literal>: The node is shutting
+ down.
+ </para>
+ </listitem>
- <listitem>
- <para>
- -n, --no-contact
- </para>
+ <listitem>
+ <para>
+ <literal>SINGLE USER MODE</literal>: This is shown for
+ all cluster data nodes when the cluster is in single
+ user mode.
+ </para>
+ </listitem>
- <para>
- Instead of waiting for the <literal>STARTED</literal> state,
- <command>ndb_waiter</command> continues running until the
- cluster reaches <literal>NO_CONTACT</literal> status before
- exiting.
- </para>
- </listitem>
+ </itemizedlist>
- <listitem>
<para>
- --not-started
+ <emphasis role="bold">Usage</emphasis>:
</para>
- <para>
- Instead of waiting for the <literal>STARTED</literal> state,
- <command>ndb_waiter</command> continues running until the
- cluster reaches <literal>NOT_STARTED</literal> status before
- exiting.
+<programlisting>
+ndb_waiter [-c <replaceable>connect_string</replaceable>]
+</programlisting>
+
+ <para id="mysql-cluster-utilities-ndb-waiter-additional-options">
+ <emphasis role="bold">Additional Options</emphasis>:
</para>
- </listitem>
- <listitem>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ -n, --no-contact
+ </para>
+
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NO_CONTACT</literal>
+ status before exiting.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ --not-started
+ </para>
+
+ <para>
+ Instead of waiting for the <literal>STARTED</literal>
+ state, <command>ndb_waiter</command> continues running
+ until the cluster reaches <literal>NOT_STARTED</literal>
+ status before exiting.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ -t, --timeout=#
+ </para>
+
+ <para>
+ Time to wait. The program exits if the desired state is
+ not achieved within this number of seconds. The default
+ is 120 seconds (1200 reporting cycles).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<para>
- -t, --timeout=#
+ <emphasis role="bold">Sample Output</emphasis>:
</para>
<para>
- Time to wait. The program exits if the desired state is not
- achieved within this number of seconds. The default is 120
- seconds (1200 reporting cycles).
+ Shown here is the output from <command>ndb_waiter</command>
+ when run against a 4-node cluster in which two nodes have
+ been shut down and then started again manually. Duplicate
+ reports (indicated by <quote><literal>...</literal></quote>)
+ are omitted.
</para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
-
- <para>
- Shown here is the output from <command>ndb_waiter</command> when
- run against a 4-node cluster in which two nodes have been shut
- down and then started again manually. Duplicate reports
- (indicated by <quote><literal>...</literal></quote>) are
- omitted.
- </para>
-
<programlisting>
shell> <userinput>./ndb_waiter -c localhost</userinput>
@@ -15448,13 +15479,17 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- <emphasis role="bold">Note</emphasis>: If no connectstring is
- specified, then <command>ndb_waiter</command> tries to connect
- to a management on <literal>localhost</literal>, and reports
- <literal>Connecting to mgmsrv at (null)</literal>.
- </para>
+ <para>
+ <emphasis role="bold">Note</emphasis>: If no connectstring
+ is specified, then <command>ndb_waiter</command> tries to
+ connect to a management on <literal>localhost</literal>, and
+ reports <literal>Connecting to mgmsrv at (null)</literal>.
+ </para>
+ </refsection>
+
+ </refentry>
+
</section>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5099 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 27 Feb |