From cc5e283d15f10413924e92a86b4584d97246c64b Mon Sep 17 00:00:00 2001 From: unknown Date: Mon, 25 May 2009 11:59:47 +0200 Subject: Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball. --- man/myisam_ftdump.1 | 151 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 man/myisam_ftdump.1 (limited to 'man/myisam_ftdump.1') diff --git a/man/myisam_ftdump.1 b/man/myisam_ftdump.1 new file mode 100644 index 00000000000..3fc43e11e0d --- /dev/null +++ b/man/myisam_ftdump.1 @@ -0,0 +1,151 @@ +.\" Title: \fBmyisam_ftdump\fR +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 +.\" Date: 03/31/2009 +.\" Manual: MySQL Database System +.\" Source: MySQL 5.1 +.\" +.TH "\fBMYISAM_FTDUMP\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +myisam_ftdump \- display full\-text index information +.SH "SYNOPSIS" +.HP 43 +\fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR +.SH "DESCRIPTION" +.PP +\fBmyisam_ftdump\fR +displays information about +FULLTEXT +indexes in +MyISAM +tables. It reads the +MyISAM +index file directly, so it must be run on the server host where the table is located +.PP +Invoke +\fBmyisam_ftdump\fR +like this: +.sp +.RS 3n +.nf +shell> \fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR +.fi +.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 +\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. +.PP +Example: Suppose that the +test +database contains a table named +mytexttablel +that has the following definition: +.sp +.RS 3n +.nf +CREATE TABLE mytexttable +( + id INT NOT NULL, + txt TEXT NOT NULL, + PRIMARY KEY (id), + FULLTEXT (txt) +); +.fi +.RE +.PP +The index on +id +is index 0 and the +FULLTEXT +index on +txt +is index 1. If your working directory is the +test +database directory, invoke +\fBmyisam_ftdump\fR +as follows: +.sp +.RS 3n +.nf +shell> \fBmyisam_ftdump mytexttable 1\fR +.fi +.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 +\fBmyisam_ftdump\fR +in the database directory: +.sp +.RS 3n +.nf +shell> \fBmyisam_ftdump /usr/local/mysql/data/test/mytexttable 1\fR +.fi +.RE +.PP +\fBmyisam_ftdump\fR +understands the following options: +.TP 3n +\(bu +\fB\-\-help\fR, +\fB\-h\fR +\fB\-?\fR +.sp +Display a help message and exit. +.TP 3n +\(bu +\fB\-\-count\fR, +\fB\-c\fR +.sp +Calculate per\-word statistics (counts and global weights). +.TP 3n +\(bu +\fB\-\-dump\fR, +\fB\-d\fR +.sp +Dump the index, including data offsets and word weights. +.TP 3n +\(bu +\fB\-\-length\fR, +\fB\-l\fR +.sp +Report the length distribution. +.TP 3n +\(bu +\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 +\fB\-\-verbose\fR, +\fB\-v\fR +.sp +Verbose mode. Print more output about what the program does. +.SH "COPYRIGHT" +.PP +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/. +.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/). -- cgit v1.2.1 From 36f3cbfdc6188d63416b2fbd5a88fe2f8faa2425 Mon Sep 17 00:00:00 2001 From: unknown Date: Wed, 16 Sep 2009 14:03:18 +0200 Subject: Imported MySQL documentation files from /home/knielsen/devel/maria/mysql-5.1.38 --- man/myisam_ftdump.1 | 163 ++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 125 insertions(+), 38 deletions(-) (limited to 'man/myisam_ftdump.1') 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 -.\" Date: 03/31/2009 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" 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/). -- cgit v1.2.1 From 4b69d0ee5245b26a3bd7bd5dfd3bd066cd38ea4c Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 1 Dec 2009 08:24:05 +0100 Subject: Imported MySQL documentation files from MySQL 5.1.41 source tarball --- man/myisam_ftdump.1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'man/myisam_ftdump.1') diff --git a/man/myisam_ftdump.1 b/man/myisam_ftdump.1 index 59cd4469257..3818bcf6ae7 100644 --- a/man/myisam_ftdump.1 +++ b/man/myisam_ftdump.1 @@ -2,12 +2,12 @@ .\" Title: \fBmyisam_ftdump\fR .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 08/12/2009 +.\" Date: 11/04/2009 .\" Manual: MySQL Database System .\" Source: MySQL 5.1 .\" Language: English .\" -.TH "\FBMYISAM_FTDUMP\FR" "1" "08/12/2009" "MySQL 5\&.1" "MySQL Database System" +.TH "\FBMYISAM_FTDUMP\FR" "1" "11/04/2009" "MySQL 5\&.1" "MySQL Database System" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- -- cgit v1.2.1 From f7f922774451a1c0017122f11ed9f08734b61e4b Mon Sep 17 00:00:00 2001 From: unknown Date: Wed, 28 Apr 2010 15:06:11 +0200 Subject: Imported MySQL documentation files from ../mysql-5.1.46 --- man/myisam_ftdump.1 | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) (limited to 'man/myisam_ftdump.1') diff --git a/man/myisam_ftdump.1 b/man/myisam_ftdump.1 index 3818bcf6ae7..f85467aabe0 100644 --- a/man/myisam_ftdump.1 +++ b/man/myisam_ftdump.1 @@ -2,12 +2,12 @@ .\" Title: \fBmyisam_ftdump\fR .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 11/04/2009 +.\" Date: 04/06/2010 .\" Manual: MySQL Database System .\" Source: MySQL 5.1 .\" Language: English .\" -.TH "\FBMYISAM_FTDUMP\FR" "1" "11/04/2009" "MySQL 5\&.1" "MySQL Database System" +.TH "\FBMYISAM_FTDUMP\FR" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -33,7 +33,13 @@ indexes in MyISAM tables\&. It reads the MyISAM -index file directly, so it must be run on the server host where the table is located +index file directly, so it must be run on the server host where the table is located\&. Before using +\fBmyisam_ftdump\fR, be sure to issue a +FLUSH TABLES +statement first if the server is running\&. +.PP +\fBmyisam_ftdump\fR +scans and dumps the entire index, which is not particularly fast\&. On the other hand, the distribution of words changes infrequently, so it need not be run often\&. .PP Invoke \fBmyisam_ftdump\fR @@ -120,6 +126,20 @@ shell> \fBmyisam_ftdump /usr/local/mysql/data/test/mytexttable 1\fR .RE .\} .PP +You can use +\fBmyisam_ftdump\fR +to generate a list of index entries in order of frequency of occurrence like this: +.sp +.if n \{\ +.RS 4 +.\} +.nf +shell> \fBmyisam_ftdump \-c mytexttable 1 | sort \-r\fR +.fi +.if n \{\ +.RE +.\} +.PP \fBmyisam_ftdump\fR supports the following options: .sp @@ -222,7 +242,7 @@ Verbose mode\&. Print more output about what the program does\&. .SH "COPYRIGHT" .br .PP -Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc. +Copyright 2007-2008 MySQL AB, 2008-2010 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 -- cgit v1.2.1