Author: paul
Date: 2007-02-22 17:00:22 +0100 (Thu, 22 Feb 2007)
New Revision: 5026
Log:
r16721@frost: paul | 2007-02-22 09:59:11 -0600
Convert ndb_desc section to use manpage markup.
Add indexterm entries.
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:20330
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16719
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:20330
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16721
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-22 15:36:13 UTC (rev 5025)
+++ trunk/refman-4.1/mysql-cluster.xml 2007-02-22 16:00:22 UTC (rev 5026)
Changed blocks: 3, Lines Added: 86, Lines Deleted: 43; 5029 bytes
@@ -13865,35 +13865,62 @@
</section>
- <section id="mysql-cluster-utilities-ndb-desc">
+ <section id="fake-id-for-ndb-desc-manpage-section-wrapper">
- <title><command>ndb_desc</command></title>
+ <title>fake title for ndb_desc manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_desc</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-desc">
- <para>
- <emphasis role="bold">Description</emphasis>: Provides a
- detailed description of one or more <literal>NDB</literal>
- tables.
- </para>
+ <indexterm>
+ <primary>ndb_desc</primary>
+ </indexterm>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_desc</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">Describe NDB Tables</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>ndb_desc</refname>
+
+ <refpurpose>describe NDB tables</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_desc <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection id="ndb-desc-description">
+
+ <title>Description</title>
+
+ <para>
+ <command>ndb_desc</command> provides a detailed description
+ of one or more <literal>NDB</literal> tables.
+ </para>
+
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
ndb_desc -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable>
</programlisting>
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Sample Output</emphasis>:
+ </para>
- <para>
- MySQL table creation and population statements:
- </para>
+ <para>
+ MySQL table creation and population statements:
+ </para>
<programlisting>
USE test;
@@ -13911,9 +13938,9 @@
('','manta ray'), ('','grouper'), ('','puffer');
</programlisting>
- <para>
- Output from <command>ndb_desc</command>:
- </para>
+ <para>
+ Output from <command>ndb_desc</command>:
+ </para>
<programlisting>
shell> <userinput>./ndb_desc -c localhost fish -d test -p</userinput>
@@ -13949,33 +13976,49 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
-
- <itemizedlist>
-
- <listitem>
<para>
- <option>-p</option>, <option>--extra-partition-info</option>
+ <emphasis role="bold">Additional Options</emphasis>:
</para>
- <para>
- Prints additional information about the table's partitions.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- Information about multiple tables can be obtained in a
- single invocation of <command>ndb_desc</command> by using
- their names, separated by spaces. All of the tables must be
- in the same database.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_desc</primary>
+ <secondary>extra-partition-info option</secondary>
+ </indexterm>
- </itemizedlist>
+ <indexterm>
+ <primary>extra-partition-info option</primary>
+ <secondary>ndb_desc</secondary>
+ </indexterm>
+ <option>--extra-partition-info</option>,
+ <option>-p</option>
+ </para>
+
+ <para>
+ Prints additional information about the table's
+ partitions.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Information about multiple tables can be obtained in a
+ single invocation of <command>ndb_desc</command> by
+ using their names, separated by spaces. All of the
+ tables must be in the same database.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-utilities-ndb-drop-index">
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2007-02-22 15:36:13 UTC (rev 5025)
+++ trunk/refman-5.0/mysql-cluster.xml 2007-02-22 16:00:22 UTC (rev 5026)
Changed blocks: 3, Lines Added: 86, Lines Deleted: 43; 5029 bytes
@@ -13978,35 +13978,62 @@
</section>
- <section id="mysql-cluster-utilities-ndb-desc">
+ <section id="fake-id-for-ndb-desc-manpage-section-wrapper">
- <title><command>ndb_desc</command></title>
+ <title>fake title for ndb_desc manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_desc</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-desc">
- <para>
- <emphasis role="bold">Description</emphasis>: Provides a
- detailed description of one or more <literal>NDB</literal>
- tables.
- </para>
+ <indexterm>
+ <primary>ndb_desc</primary>
+ </indexterm>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_desc</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">Describe NDB Tables</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>ndb_desc</refname>
+
+ <refpurpose>describe NDB tables</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_desc <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection id="ndb-desc-description">
+
+ <title>Description</title>
+
+ <para>
+ <command>ndb_desc</command> provides a detailed description
+ of one or more <literal>NDB</literal> tables.
+ </para>
+
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
ndb_desc -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable>
</programlisting>
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Sample Output</emphasis>:
+ </para>
- <para>
- MySQL table creation and population statements:
- </para>
+ <para>
+ MySQL table creation and population statements:
+ </para>
<programlisting>
USE test;
@@ -14024,9 +14051,9 @@
('','manta ray'), ('','grouper'), ('','puffer');
</programlisting>
- <para>
- Output from <command>ndb_desc</command>:
- </para>
+ <para>
+ Output from <command>ndb_desc</command>:
+ </para>
<programlisting>
shell> <userinput>./ndb_desc -c localhost fish -d test -p</userinput>
@@ -14062,33 +14089,49 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
-
- <itemizedlist>
-
- <listitem>
<para>
- <option>-p</option>, <option>--extra-partition-info</option>
+ <emphasis role="bold">Additional Options</emphasis>:
</para>
- <para>
- Prints additional information about the table's partitions.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- Information about multiple tables can be obtained in a
- single invocation of <command>ndb_desc</command> by using
- their names, separated by spaces. All of the tables must be
- in the same database.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_desc</primary>
+ <secondary>extra-partition-info option</secondary>
+ </indexterm>
- </itemizedlist>
+ <indexterm>
+ <primary>extra-partition-info option</primary>
+ <secondary>ndb_desc</secondary>
+ </indexterm>
+ <option>--extra-partition-info</option>,
+ <option>-p</option>
+ </para>
+
+ <para>
+ Prints additional information about the table's
+ partitions.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Information about multiple tables can be obtained in a
+ single invocation of <command>ndb_desc</command> by
+ using their names, separated by spaces. All of the
+ tables must be in the same database.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-utilities-ndb-drop-index">
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-02-22 15:36:13 UTC (rev 5025)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-02-22 16:00:22 UTC (rev 5026)
Changed blocks: 3, Lines Added: 86, Lines Deleted: 43; 5029 bytes
@@ -14052,35 +14052,62 @@
</section>
- <section id="mysql-cluster-utilities-ndb-desc">
+ <section id="fake-id-for-ndb-desc-manpage-section-wrapper">
- <title><command>ndb_desc</command></title>
+ <title>fake title for ndb_desc manpage section wrapper</title>
- <indexterm>
- <primary><command>ndb_desc</command></primary>
- </indexterm>
+ <refentry id="mysql-cluster-utilities-ndb-desc">
- <para>
- <emphasis role="bold">Description</emphasis>: Provides a
- detailed description of one or more <literal>NDB</literal>
- tables.
- </para>
+ <indexterm>
+ <primary>ndb_desc</primary>
+ </indexterm>
- <para>
- <emphasis role="bold">Usage</emphasis>:
- </para>
+ <refmeta>
+ <refentrytitle><command>ndb_desc</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">Describe NDB Tables</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>ndb_desc</refname>
+
+ <refpurpose>describe NDB tables</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ndb_desc <replaceable>options</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection id="ndb-desc-description">
+
+ <title>Description</title>
+
+ <para>
+ <command>ndb_desc</command> provides a detailed description
+ of one or more <literal>NDB</literal> tables.
+ </para>
+
+ <para>
+ <emphasis role="bold">Usage</emphasis>:
+ </para>
+
<programlisting>
ndb_desc -c <replaceable>connect_string</replaceable> <replaceable>tbl_name</replaceable> -d <replaceable>db_name</replaceable>
</programlisting>
- <para>
- <emphasis role="bold">Sample Output</emphasis>:
- </para>
+ <para>
+ <emphasis role="bold">Sample Output</emphasis>:
+ </para>
- <para>
- MySQL table creation and population statements:
- </para>
+ <para>
+ MySQL table creation and population statements:
+ </para>
<programlisting>
USE test;
@@ -14098,9 +14125,9 @@
('','manta ray'), ('','grouper'), ('','puffer');
</programlisting>
- <para>
- Output from <command>ndb_desc</command>:
- </para>
+ <para>
+ Output from <command>ndb_desc</command>:
+ </para>
<programlisting>
shell> <userinput>./ndb_desc -c localhost fish -d test -p</userinput>
@@ -14136,33 +14163,49 @@
NDBT_ProgramExit: 0 - OK
</programlisting>
- <para>
- <emphasis role="bold">Additional Options</emphasis>:
- </para>
-
- <itemizedlist>
-
- <listitem>
<para>
- <option>-p</option>, <option>--extra-partition-info</option>
+ <emphasis role="bold">Additional Options</emphasis>:
</para>
- <para>
- Prints additional information about the table's partitions.
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- Information about multiple tables can be obtained in a
- single invocation of <command>ndb_desc</command> by using
- their names, separated by spaces. All of the tables must be
- in the same database.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>ndb_desc</primary>
+ <secondary>extra-partition-info option</secondary>
+ </indexterm>
- </itemizedlist>
+ <indexterm>
+ <primary>extra-partition-info option</primary>
+ <secondary>ndb_desc</secondary>
+ </indexterm>
+ <option>--extra-partition-info</option>,
+ <option>-p</option>
+ </para>
+
+ <para>
+ Prints additional information about the table's
+ partitions.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Information about multiple tables can be obtained in a
+ single invocation of <command>ndb_desc</command> by
+ using their names, separated by spaces. All of the
+ tables must be in the same database.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </refsection>
+
+ </refentry>
+
</section>
<section id="mysql-cluster-utilities-ndb-drop-index">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5026 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 22 Feb |
