| List: | Commits | « Previous MessageNext Message » | |
| From: | paul | Date: | February 28 2007 10:23pm |
| Subject: | svn commit - mysqldoc@docsrva: r5115 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | ||
| View as plain text | |||
Author: paul Date: 2007-02-28 22:23:21 +0100 (Wed, 28 Feb 2007) New Revision: 5115 Log: r20699@polar: paul | 2007-02-28 14:27:22 -0600 Convert ndb_error_reporter, ndb_print_backup_file sections 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:20697 7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16997 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:20699 7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:16997 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-28 19:33:58 UTC (rev 5114) +++ trunk/refman-4.1/mysql-cluster.xml 2007-02-28 21:23:21 UTC (rev 5115) Changed blocks: 1, Lines Added: 151, Lines Deleted: 85; 11047 bytes @@ -14208,118 +14208,184 @@ </section> - <section id="mysql-cluster-utilities-ndb-error-reporter"> + <section id="fake-id-for-ndb-error-reporter-manpage-section-wrapper"> - <title><command>ndb_error_reporter</command></title> + <title>fake title for ndb_error_reporter manpage section wrapper</title> - <indexterm> - <primary><command>ndb_error_reporter</command></primary> - </indexterm> + <refentry id="mysql-cluster-utilities-ndb-error-reporter"> - <indexterm> - <primary>bugs</primary> - <secondary>MySQL Cluster</secondary> - <tertiary>reporting</tertiary> - </indexterm> + <indexterm> + <primary>ndb_error_reporter</primary> + </indexterm> - <para> - <emphasis role="bold">Description</emphasis>: Creates an archive - from data node and management node log files that can be used to - help diagnose bugs or other problems with a cluster. - <emphasis>It is highly recommended that you make use of this - utility when filing reports of bugs in MySQL Cluster</emphasis>. - </para> + <indexterm> + <primary>bugs</primary> + <secondary>MySQL Cluster</secondary> + <tertiary>reporting</tertiary> + </indexterm> - <para> - <emphasis role="bold">Usage</emphasis>: - </para> + <refmeta> + <refentrytitle><command>ndb_error_reporter</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">NDB Error-Reporting Utility</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ndb_error_reporter</refname> + + <refpurpose>NDB error-reporting utility</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ndb_error_reporter <replaceable>options</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="ndb-error-reporter-description"> + + <title>Description</title> + + <para> + <command>ndb_error_reporter</command> creates an archive + from data node and management node log files that can be + used to help diagnose bugs or other problems with a cluster. + <emphasis>It is highly recommended that you make use of this + utility when filing reports of bugs in MySQL + Cluster</emphasis>. + </para> + + <para> + <emphasis role="bold">Usage</emphasis>: + </para> + <programlisting> ndb_error_reporter <replaceable>path/to/config-file</replaceable> [<replaceable>username</replaceable>] [--fs] </programlisting> - <para> - This utility is intended for use on a management node host, and - requires the path to the management host configuration file - (<filename>config.ini</filename>). Optionally, you can supply - the name of a user that is able to access the cluster's data - nodes via SSH, in order to copy the data node log files. - ndb_error_reporter then includes all of these files in archive - that is created in the same directory in which it is run. The - archive is named - <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>, - where <replaceable>YYYYMMDDHHMMSS</replaceable> is a datetime - string. - </para> + <para> + This utility is intended for use on a management node host, + and requires the path to the management host configuration + file (<filename>config.ini</filename>). Optionally, you can + supply the name of a user that is able to access the + cluster's data nodes via SSH, in order to copy the data node + log files. ndb_error_reporter then includes all of these + files in archive that is created in the same directory in + which it is run. The archive is named + <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>, + where <replaceable>YYYYMMDDHHMMSS</replaceable> is a + datetime string. + </para> - <para> - If the <option>--fs</option> is used, then the data node - filesystems are also copied to the management host and included - in the archive that is produced by this script. As data node - filesystems can be extremely large even after being compressed, - we ask that you please do <emphasis>not</emphasis> send archives - created using this option to MySQL AB unless you are - specifically requested to do so. - </para> + <para> + If the <option>--fs</option> is used, then the data node + filesystems are also copied to the management host and + included in the archive that is produced by this script. As + data node filesystems can be extremely large even after + being compressed, we ask that you please do + <emphasis>not</emphasis> send archives created using this + option to MySQL AB unless you are specifically requested to + do so. + </para> + </refsection> + + </refentry> + </section> - <section id="mysql-cluster-utilities-ndb-print-backup-file"> + <section id="fake-id-for-ndb-print-backup-file-manpage-section-wrapper"> - <title><command>ndb_print_backup_file</command></title> + <title>fake title for ndb_print_backup_file manpage section wrapper</title> - <indexterm> - <primary><command>ndb_print_backup_file</command></primary> - </indexterm> + <refentry id="mysql-cluster-utilities-ndb-print-backup-file"> - <para> - <emphasis role="bold">Description</emphasis>: Obtains diagnostic - information from a cluster backup file. - </para> + <indexterm> + <primary>ndb_print_backup_file</primary> + </indexterm> - <para> - <emphasis role="bold">Usage</emphasis>: - </para> + <refmeta> + <refentrytitle><command>ndb_print_backup_file</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">Print NDB Backup File Contents</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ndb_print_backup_file</refname> + + <refpurpose>print NDB backup file contents</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ndb_print_backup_file <replaceable>file_name</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="ndb-print-backup-file-description"> + + <title>Description</title> + + <para> + <command>ndb_print_backup_file</command> obtains diagnostic + information from a cluster backup file. + </para> + + <para> + <emphasis role="bold">Usage</emphasis>: + </para> + <programlisting> ndb_print_backup_file <replaceable>file_name</replaceable> </programlisting> - <para> - <replaceable>file_name</replaceable> is the name of a cluster - backup file. This can be any of the files - (<filename>.Data</filename>, <filename>.ctl</filename>, or - <filename>.log</filename> file) found in a cluster backup - directory. These files are found in the data node's backup - directory under the subdirectory - <filename>BACKUP-<replaceable>#</replaceable></filename>, where - <replaceable>#</replaceable> is the sequence number for the - backup. For more information about cluster backup files and - their contents, see - <xref linkend="mysql-cluster-backup-concepts"/>. - </para> + <para> + <replaceable>file_name</replaceable> is the name of a + cluster backup file. This can be any of the files + (<filename>.Data</filename>, <filename>.ctl</filename>, or + <filename>.log</filename> file) found in a cluster backup + directory. These files are found in the data node's backup + directory under the subdirectory + <filename>BACKUP-<replaceable>#</replaceable></filename>, + where <replaceable>#</replaceable> is the sequence number + for the backup. For more information about cluster backup + files and their contents, see + <xref linkend="mysql-cluster-backup-concepts"/>. + </para> - <para> - Like <command>ndb_print_schema_file</command> and - <command>ndb_print_sys_file</command> (and unlike most of the - other <literal>NDB</literal> utilities that are intended to be - run on a management server host or to connect to a management - server) <command>ndb_print_backup_file</command> must be run on - a cluster data node, since it accesses the data node filesystem - directly. Because it does not make use of the management server, - this utility can be used when the management server is not - running, and even when the cluster has been completely shut - down. - </para> + <para> + Like <command>ndb_print_schema_file</command> and + <command>ndb_print_sys_file</command> (and unlike most of + the other <literal>NDB</literal> utilities that are intended + to be run on a management server host or to connect to a + management server) <command>ndb_print_backup_file</command> + must be run on a cluster data node, since it accesses the + data node filesystem directly. Because it does not make use + of the management server, this utility can be used when the + management server is not running, and even when the cluster + has been completely shut down. + </para> - <remark role="todo"> - [js] Add sample output with explanation. - </remark> + <remark role="todo"> + [js] Add sample output with explanation. + </remark> - <para> - <emphasis role="bold">Additional Options</emphasis>: None. - </para> + <para> + <emphasis role="bold">Additional Options</emphasis>: None. + </para> + </refsection> + + </refentry> + </section> <section id="mysql-cluster-utilities-ndb-print-schema-file"> Modified: trunk/refman-5.0/mysql-cluster.xml =================================================================== --- trunk/refman-5.0/mysql-cluster.xml 2007-02-28 19:33:58 UTC (rev 5114) +++ trunk/refman-5.0/mysql-cluster.xml 2007-02-28 21:23:21 UTC (rev 5115) Changed blocks: 1, Lines Added: 151, Lines Deleted: 85; 11047 bytes @@ -14321,118 +14321,184 @@ </section> - <section id="mysql-cluster-utilities-ndb-error-reporter"> + <section id="fake-id-for-ndb-error-reporter-manpage-section-wrapper"> - <title><command>ndb_error_reporter</command></title> + <title>fake title for ndb_error_reporter manpage section wrapper</title> - <indexterm> - <primary><command>ndb_error_reporter</command></primary> - </indexterm> + <refentry id="mysql-cluster-utilities-ndb-error-reporter"> - <indexterm> - <primary>bugs</primary> - <secondary>MySQL Cluster</secondary> - <tertiary>reporting</tertiary> - </indexterm> + <indexterm> + <primary>ndb_error_reporter</primary> + </indexterm> - <para> - <emphasis role="bold">Description</emphasis>: Creates an archive - from data node and management node log files that can be used to - help diagnose bugs or other problems with a cluster. - <emphasis>It is highly recommended that you make use of this - utility when filing reports of bugs in MySQL Cluster</emphasis>. - </para> + <indexterm> + <primary>bugs</primary> + <secondary>MySQL Cluster</secondary> + <tertiary>reporting</tertiary> + </indexterm> - <para> - <emphasis role="bold">Usage</emphasis>: - </para> + <refmeta> + <refentrytitle><command>ndb_error_reporter</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">NDB Error-Reporting Utility</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ndb_error_reporter</refname> + + <refpurpose>NDB error-reporting utility</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ndb_error_reporter <replaceable>options</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="ndb-error-reporter-description"> + + <title>Description</title> + + <para> + <command>ndb_error_reporter</command> creates an archive + from data node and management node log files that can be + used to help diagnose bugs or other problems with a cluster. + <emphasis>It is highly recommended that you make use of this + utility when filing reports of bugs in MySQL + Cluster</emphasis>. + </para> + + <para> + <emphasis role="bold">Usage</emphasis>: + </para> + <programlisting> ndb_error_reporter <replaceable>path/to/config-file</replaceable> [<replaceable>username</replaceable>] [--fs] </programlisting> - <para> - This utility is intended for use on a management node host, and - requires the path to the management host configuration file - (<filename>config.ini</filename>). Optionally, you can supply - the name of a user that is able to access the cluster's data - nodes via SSH, in order to copy the data node log files. - ndb_error_reporter then includes all of these files in archive - that is created in the same directory in which it is run. The - archive is named - <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>, - where <replaceable>YYYYMMDDHHMMSS</replaceable> is a datetime - string. - </para> + <para> + This utility is intended for use on a management node host, + and requires the path to the management host configuration + file (<filename>config.ini</filename>). Optionally, you can + supply the name of a user that is able to access the + cluster's data nodes via SSH, in order to copy the data node + log files. ndb_error_reporter then includes all of these + files in archive that is created in the same directory in + which it is run. The archive is named + <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>, + where <replaceable>YYYYMMDDHHMMSS</replaceable> is a + datetime string. + </para> - <para> - If the <option>--fs</option> is used, then the data node - filesystems are also copied to the management host and included - in the archive that is produced by this script. As data node - filesystems can be extremely large even after being compressed, - we ask that you please do <emphasis>not</emphasis> send archives - created using this option to MySQL AB unless you are - specifically requested to do so. - </para> + <para> + If the <option>--fs</option> is used, then the data node + filesystems are also copied to the management host and + included in the archive that is produced by this script. As + data node filesystems can be extremely large even after + being compressed, we ask that you please do + <emphasis>not</emphasis> send archives created using this + option to MySQL AB unless you are specifically requested to + do so. + </para> + </refsection> + + </refentry> + </section> - <section id="mysql-cluster-utilities-ndb-print-backup-file"> + <section id="fake-id-for-ndb-print-backup-file-manpage-section-wrapper"> - <title><command>ndb_print_backup_file</command></title> + <title>fake title for ndb_print_backup_file manpage section wrapper</title> - <indexterm> - <primary><command>ndb_print_backup_file</command></primary> - </indexterm> + <refentry id="mysql-cluster-utilities-ndb-print-backup-file"> - <para> - <emphasis role="bold">Description</emphasis>: Obtains diagnostic - information from a cluster backup file. - </para> + <indexterm> + <primary>ndb_print_backup_file</primary> + </indexterm> - <para> - <emphasis role="bold">Usage</emphasis>: - </para> + <refmeta> + <refentrytitle><command>ndb_print_backup_file</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">Print NDB Backup File Contents</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ndb_print_backup_file</refname> + + <refpurpose>print NDB backup file contents</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ndb_print_backup_file <replaceable>file_name</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="ndb-print-backup-file-description"> + + <title>Description</title> + + <para> + <command>ndb_print_backup_file</command> obtains diagnostic + information from a cluster backup file. + </para> + + <para> + <emphasis role="bold">Usage</emphasis>: + </para> + <programlisting> ndb_print_backup_file <replaceable>file_name</replaceable> </programlisting> - <para> - <replaceable>file_name</replaceable> is the name of a cluster - backup file. This can be any of the files - (<filename>.Data</filename>, <filename>.ctl</filename>, or - <filename>.log</filename> file) found in a cluster backup - directory. These files are found in the data node's backup - directory under the subdirectory - <filename>BACKUP-<replaceable>#</replaceable></filename>, where - <replaceable>#</replaceable> is the sequence number for the - backup. For more information about cluster backup files and - their contents, see - <xref linkend="mysql-cluster-backup-concepts"/>. - </para> + <para> + <replaceable>file_name</replaceable> is the name of a + cluster backup file. This can be any of the files + (<filename>.Data</filename>, <filename>.ctl</filename>, or + <filename>.log</filename> file) found in a cluster backup + directory. These files are found in the data node's backup + directory under the subdirectory + <filename>BACKUP-<replaceable>#</replaceable></filename>, + where <replaceable>#</replaceable> is the sequence number + for the backup. For more information about cluster backup + files and their contents, see + <xref linkend="mysql-cluster-backup-concepts"/>. + </para> - <para> - Like <command>ndb_print_schema_file</command> and - <command>ndb_print_sys_file</command> (and unlike most of the - other <literal>NDB</literal> utilities that are intended to be - run on a management server host or to connect to a management - server) <command>ndb_print_backup_file</command> must be run on - a cluster data node, since it accesses the data node filesystem - directly. Because it does not make use of the management server, - this utility can be used when the management server is not - running, and even when the cluster has been completely shut - down. - </para> + <para> + Like <command>ndb_print_schema_file</command> and + <command>ndb_print_sys_file</command> (and unlike most of + the other <literal>NDB</literal> utilities that are intended + to be run on a management server host or to connect to a + management server) <command>ndb_print_backup_file</command> + must be run on a cluster data node, since it accesses the + data node filesystem directly. Because it does not make use + of the management server, this utility can be used when the + management server is not running, and even when the cluster + has been completely shut down. + </para> - <remark role="todo"> - [js] Add sample output with explanation. - </remark> + <remark role="todo"> + [js] Add sample output with explanation. + </remark> - <para> - <emphasis role="bold">Additional Options</emphasis>: None. - </para> + <para> + <emphasis role="bold">Additional Options</emphasis>: None. + </para> + </refsection> + + </refentry> + </section> <section id="mysql-cluster-utilities-ndb-print-schema-file"> Modified: trunk/refman-5.1/mysql-cluster.xml =================================================================== --- trunk/refman-5.1/mysql-cluster.xml 2007-02-28 19:33:58 UTC (rev 5114) +++ trunk/refman-5.1/mysql-cluster.xml 2007-02-28 21:23:21 UTC (rev 5115) Changed blocks: 1, Lines Added: 151, Lines Deleted: 85; 11047 bytes @@ -14395,118 +14395,184 @@ </section> - <section id="mysql-cluster-utilities-ndb-error-reporter"> + <section id="fake-id-for-ndb-error-reporter-manpage-section-wrapper"> - <title><command>ndb_error_reporter</command></title> + <title>fake title for ndb_error_reporter manpage section wrapper</title> - <indexterm> - <primary><command>ndb_error_reporter</command></primary> - </indexterm> + <refentry id="mysql-cluster-utilities-ndb-error-reporter"> - <indexterm> - <primary>bugs</primary> - <secondary>MySQL Cluster</secondary> - <tertiary>reporting</tertiary> - </indexterm> + <indexterm> + <primary>ndb_error_reporter</primary> + </indexterm> - <para> - <emphasis role="bold">Description</emphasis>: Creates an archive - from data node and management node log files that can be used to - help diagnose bugs or other problems with a cluster. - <emphasis>It is highly recommended that you make use of this - utility when filing reports of bugs in MySQL Cluster</emphasis>. - </para> + <indexterm> + <primary>bugs</primary> + <secondary>MySQL Cluster</secondary> + <tertiary>reporting</tertiary> + </indexterm> - <para> - <emphasis role="bold">Usage</emphasis>: - </para> + <refmeta> + <refentrytitle><command>ndb_error_reporter</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">NDB Error-Reporting Utility</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ndb_error_reporter</refname> + + <refpurpose>NDB error-reporting utility</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ndb_error_reporter <replaceable>options</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="ndb-error-reporter-description"> + + <title>Description</title> + + <para> + <command>ndb_error_reporter</command> creates an archive + from data node and management node log files that can be + used to help diagnose bugs or other problems with a cluster. + <emphasis>It is highly recommended that you make use of this + utility when filing reports of bugs in MySQL + Cluster</emphasis>. + </para> + + <para> + <emphasis role="bold">Usage</emphasis>: + </para> + <programlisting> ndb_error_reporter <replaceable>path/to/config-file</replaceable> [<replaceable>username</replaceable>] [--fs] </programlisting> - <para> - This utility is intended for use on a management node host, and - requires the path to the management host configuration file - (<filename>config.ini</filename>). Optionally, you can supply - the name of a user that is able to access the cluster's data - nodes via SSH, in order to copy the data node log files. - ndb_error_reporter then includes all of these files in archive - that is created in the same directory in which it is run. The - archive is named - <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>, - where <replaceable>YYYYMMDDHHMMSS</replaceable> is a datetime - string. - </para> + <para> + This utility is intended for use on a management node host, + and requires the path to the management host configuration + file (<filename>config.ini</filename>). Optionally, you can + supply the name of a user that is able to access the + cluster's data nodes via SSH, in order to copy the data node + log files. ndb_error_reporter then includes all of these + files in archive that is created in the same directory in + which it is run. The archive is named + <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>, + where <replaceable>YYYYMMDDHHMMSS</replaceable> is a + datetime string. + </para> - <para> - If the <option>--fs</option> is used, then the data node - filesystems are also copied to the management host and included - in the archive that is produced by this script. As data node - filesystems can be extremely large even after being compressed, - we ask that you please do <emphasis>not</emphasis> send archives - created using this option to MySQL AB unless you are - specifically requested to do so. - </para> + <para> + If the <option>--fs</option> is used, then the data node + filesystems are also copied to the management host and + included in the archive that is produced by this script. As + data node filesystems can be extremely large even after + being compressed, we ask that you please do + <emphasis>not</emphasis> send archives created using this + option to MySQL AB unless you are specifically requested to + do so. + </para> + </refsection> + + </refentry> + </section> - <section id="mysql-cluster-utilities-ndb-print-backup-file"> + <section id="fake-id-for-ndb-print-backup-file-manpage-section-wrapper"> - <title><command>ndb_print_backup_file</command></title> + <title>fake title for ndb_print_backup_file manpage section wrapper</title> - <indexterm> - <primary><command>ndb_print_backup_file</command></primary> - </indexterm> + <refentry id="mysql-cluster-utilities-ndb-print-backup-file"> - <para> - <emphasis role="bold">Description</emphasis>: Obtains diagnostic - information from a cluster backup file. - </para> + <indexterm> + <primary>ndb_print_backup_file</primary> + </indexterm> - <para> - <emphasis role="bold">Usage</emphasis>: - </para> + <refmeta> + <refentrytitle><command>ndb_print_backup_file</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">Print NDB Backup File Contents</refmiscinfo> + </refmeta> + <refnamediv> + <refname>ndb_print_backup_file</refname> + + <refpurpose>print NDB backup file contents</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ndb_print_backup_file <replaceable>file_name</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="ndb-print-backup-file-description"> + + <title>Description</title> + + <para> + <command>ndb_print_backup_file</command> obtains diagnostic + information from a cluster backup file. + </para> + + <para> + <emphasis role="bold">Usage</emphasis>: + </para> + <programlisting> ndb_print_backup_file <replaceable>file_name</replaceable> </programlisting> - <para> - <replaceable>file_name</replaceable> is the name of a cluster - backup file. This can be any of the files - (<filename>.Data</filename>, <filename>.ctl</filename>, or - <filename>.log</filename> file) found in a cluster backup - directory. These files are found in the data node's backup - directory under the subdirectory - <filename>BACKUP-<replaceable>#</replaceable></filename>, where - <replaceable>#</replaceable> is the sequence number for the - backup. For more information about cluster backup files and - their contents, see - <xref linkend="mysql-cluster-backup-concepts"/>. - </para> + <para> + <replaceable>file_name</replaceable> is the name of a + cluster backup file. This can be any of the files + (<filename>.Data</filename>, <filename>.ctl</filename>, or + <filename>.log</filename> file) found in a cluster backup + directory. These files are found in the data node's backup + directory under the subdirectory + <filename>BACKUP-<replaceable>#</replaceable></filename>, + where <replaceable>#</replaceable> is the sequence number + for the backup. For more information about cluster backup + files and their contents, see + <xref linkend="mysql-cluster-backup-concepts"/>. + </para> - <para> - Like <command>ndb_print_schema_file</command> and - <command>ndb_print_sys_file</command> (and unlike most of the - other <literal>NDB</literal> utilities that are intended to be - run on a management server host or to connect to a management - server) <command>ndb_print_backup_file</command> must be run on - a cluster data node, since it accesses the data node filesystem - directly. Because it does not make use of the management server, - this utility can be used when the management server is not - running, and even when the cluster has been completely shut - down. - </para> + <para> + Like <command>ndb_print_schema_file</command> and + <command>ndb_print_sys_file</command> (and unlike most of + the other <literal>NDB</literal> utilities that are intended + to be run on a management server host or to connect to a + management server) <command>ndb_print_backup_file</command> + must be run on a cluster data node, since it accesses the + data node filesystem directly. Because it does not make use + of the management server, this utility can be used when the + management server is not running, and even when the cluster + has been completely shut down. + </para> - <remark role="todo"> - [js] Add sample output with explanation. - </remark> + <remark role="todo"> + [js] Add sample output with explanation. + </remark> - <para> - <emphasis role="bold">Additional Options</emphasis>: None. - </para> + <para> + <emphasis role="bold">Additional Options</emphasis>: None. + </para> + </refsection> + + </refentry> + </section> <section id="mysql-cluster-utilities-ndb-print-schema-file">
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r5115 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 28 Feb |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.969 sec. using MySQL 5.1.14-beta-log