Imported MySQL documentation files from /home/knielsen/devel/maria/mysql-5.1.38

1 files changed, 125 insertions, 38 deletions

diff --git a/man/myisam_ftdump.1 b/man/myisam_ftdump.1
index 3fc43e11e0d..59cd4469257 100644
--- a/man/myisam_ftdump.1
+++ b/man/myisam_ftdump.1
@@ -1,19 +1,28 @@
+'\" t
 .\"     Title: \fBmyisam_ftdump\fR
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\"      Date: 03/31/2009
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 08/12/2009
 .\"    Manual: MySQL Database System
 .\"    Source: MySQL 5.1
+.\"  Language: English
 .\"
-.TH "\fBMYISAM_FTDUMP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System"
+.TH "\FBMYISAM_FTDUMP\FR" "1" "08/12/2009" "MySQL 5\&.1" "MySQL Database System"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.\" myisam_ftdump
 .SH "NAME"
 myisam_ftdump \- display full\-text index information
 .SH "SYNOPSIS"
-.HP 43
+.HP \w'\fBmyisam_ftdump\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fItbl_name\fR\fR\fB\ \fR\fB\fIindex_num\fR\fR\ 'u
 \fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR
 .SH "DESCRIPTION"
 .PP
@@ -22,7 +31,7 @@ displays information about
 FULLTEXT
 indexes in
 MyISAM
-tables. It reads the
+tables\&. It reads the
 MyISAM
 index file directly, so it must be run on the server host where the table is located
 .PP
@@ -30,21 +39,25 @@ Invoke
 \fBmyisam_ftdump\fR
 like this:
 .sp
-.RS 3n
+.if n \{\
+.RS 4
+.\}
 .nf
 shell> \fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR
 .fi
+.if n \{\
 .RE
+.\}
 .PP
 The
 \fItbl_name\fR
 argument should be the name of a
 MyISAM
-table. You can also specify a table by naming its index file (the file with the
-\fI.MYI\fR
-suffix). If you do not invoke
+table\&. You can also specify a table by naming its index file (the file with the
+\&.MYI
+suffix)\&. If you do not invoke
 \fBmyisam_ftdump\fR
-in the directory where the table files are located, the table or index file name must be preceded by the path name to the table's database directory. Index numbers begin with 0.
+in the directory where the table files are located, the table or index file name must be preceded by the path name to the table\'s database directory\&. Index numbers begin with 0\&.
 .PP
 Example: Suppose that the
 test
@@ -52,7 +65,9 @@ database contains a table named
 mytexttablel
 that has the following definition:
 .sp
-.RS 3n
+.if n \{\
+.RS 4
+.\}
 .nf
 CREATE TABLE mytexttable
 (
@@ -62,7 +77,9 @@ CREATE TABLE mytexttable
   FULLTEXT (txt)
 );
 .fi
+.if n \{\
 .RE
+.\}
 .PP
 The index on
 id
@@ -70,82 +87,152 @@ is index 0 and the
 FULLTEXT
 index on
 txt
-is index 1. If your working directory is the
+is index 1\&. If your working directory is the
 test
 database directory, invoke
 \fBmyisam_ftdump\fR
 as follows:
 .sp
-.RS 3n
+.if n \{\
+.RS 4
+.\}
 .nf
 shell> \fBmyisam_ftdump mytexttable 1\fR
 .fi
+.if n \{\
 .RE
+.\}
 .PP
 If the path name to the
 test
 database directory is
-\fI/usr/local/mysql/data/test\fR, you can also specify the table name argument using that path name. This is useful if you do not invoke
+/usr/local/mysql/data/test, you can also specify the table name argument using that path name\&. This is useful if you do not invoke
 \fBmyisam_ftdump\fR
 in the database directory:
 .sp
-.RS 3n
+.if n \{\
+.RS 4
+.\}
 .nf
 shell> \fBmyisam_ftdump /usr/local/mysql/data/test/mytexttable 1\fR
 .fi
+.if n \{\
 .RE
+.\}
 .PP
 \fBmyisam_ftdump\fR
-understands the following options:
-.TP 3n
-\(bu
+supports the following options:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" myisam_ftdump: help option
+.\" help option: myisam_ftdump
 \fB\-\-help\fR,
 \fB\-h\fR
 \fB\-?\fR
 .sp
-Display a help message and exit.
-.TP 3n
-\(bu
+Display a help message and exit\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" myisam_ftdump: count option
+.\" count option: myisam_ftdump
 \fB\-\-count\fR,
 \fB\-c\fR
 .sp
-Calculate per\-word statistics (counts and global weights).
-.TP 3n
-\(bu
+Calculate per\-word statistics (counts and global weights)\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" myisam_ftdump: dump option
+.\" dump option: myisam_ftdump
 \fB\-\-dump\fR,
 \fB\-d\fR
 .sp
-Dump the index, including data offsets and word weights.
-.TP 3n
-\(bu
+Dump the index, including data offsets and word weights\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" myisam_ftdump: length option
+.\" length option: myisam_ftdump
 \fB\-\-length\fR,
 \fB\-l\fR
 .sp
-Report the length distribution.
-.TP 3n
-\(bu
+Report the length distribution\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" myisam_ftdump: stats option
+.\" stats option: myisam_ftdump
 \fB\-\-stats\fR,
 \fB\-s\fR
 .sp
-Report global index statistics. This is the default operation if no other operation is specified.
-.TP 3n
-\(bu
+Report global index statistics\&. This is the default operation if no other operation is specified\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" myisam_ftdump: verbose option
+.\" verbose option: myisam_ftdump
 \fB\-\-verbose\fR,
 \fB\-v\fR
 .sp
-Verbose mode. Print more output about what the program does.
+Verbose mode\&. Print more output about what the program does\&.
+.RE
 .SH "COPYRIGHT"
+.br
 .PP
-Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc.
+Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
 .PP
 This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
 .PP
 This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 .PP
-You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/.
+You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
+.sp
 .SH "SEE ALSO"
 For more information, please refer to the MySQL Reference Manual,
 which may already be installed locally and which is also available
 online at http://dev.mysql.com/doc/.
 .SH AUTHOR
-MySQL AB (http://www.mysql.com/).
+Sun Microsystems, Inc. (http://www.mysql.com/).