Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball.

1 files changed, 176 insertions, 0 deletions

diff --git a/man/mysqldumpslow.1 b/man/mysqldumpslow.1
new file mode 100644
index 00000000000..4bc6a1e8b6c
--- /dev/null
+++ b/man/mysqldumpslow.1
@@ -0,0 +1,176 @@
+.\"     Title: \fBmysqldumpslow\fR
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\"      Date: 03/31/2009
+.\"    Manual: MySQL Database System
+.\"    Source: MySQL 5.1
+.\"
+.TH "\fBMYSQLDUMPSLOW\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"
+mysqldumpslow \- Summarize slow query log files
+.SH "SYNOPSIS"
+.HP 39
+\fBmysqldumpslow [\fR\fBoptions\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB ...]\fR
+.SH "DESCRIPTION"
+.PP
+The MySQL slow query log contains information about queries that take a long time to execute (see
+Section\ 5.2.5, \(lqThe Slow Query Log\(rq).
+\fBmysqldumpslow\fR
+parses MySQL slow query log files and prints a summary of their contents.
+.PP
+Normally,
+\fBmysqldumpslow\fR
+groups queries that are similar except for the particular values of number and string data values. It
+\(lqabstracts\(rq
+these values to
+N
+and
+\'S'
+when displaying summary output. The
+\fB\-a\fR
+and
+\fB\-n\fR
+options can be used to modify value abstracting behavior.
+.PP
+Invoke
+\fBmysqldumpslow\fR
+like this:
+.sp
+.RS 3n
+.nf
+shell> \fBmysqldumpslow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB ...]\fR
+.fi
+.RE
+.PP
+\fBmysqldumpslow\fR
+supports the following options:
+.TP 3n
+\(bu
+\fB\-\-help\fR
+.sp
+Display a help message and exit.
+.TP 3n
+\(bu
+\fB\-a\fR
+.sp
+Do not abstract all numbers to
+N
+and strings to
+\'S'.
+.TP 3n
+\(bu
+\fB\-\-debug\fR,
+\fB\-d\fR
+.sp
+Run in debug mode.
+.TP 3n
+\(bu
+\fB\-g \fR\fB\fIpattern\fR\fR
+.sp
+Consider only queries that match the (\fBgrep\fR\-style) pattern.
+.TP 3n
+\(bu
+\fB\-h \fR\fB\fIhost_name\fR\fR
+.sp
+Host name of MySQL server for
+\fI*\-slow.log\fR
+file name. The value can contain a wildcare. The default is
+*
+(match all).
+.TP 3n
+\(bu
+\fB\-i \fR\fB\fIname\fR\fR
+.sp
+Name of server instance (if using
+\fBmysql.server\fR
+startup script).
+.TP 3n
+\(bu
+\fB\-l\fR
+.sp
+Do not subtract lock time from total time.
+.TP 3n
+\(bu
+\fB\-n \fR\fB\fIN\fR\fR
+.sp
+Abstract numbers with at least
+\fIN\fR
+digits within names.
+.TP 3n
+\(bu
+\fB\-r\fR
+.sp
+Reverse the sort order.
+.TP 3n
+\(bu
+\fB\-s \fR\fB\fIsort_type\fR\fR
+.sp
+How to sort the output. The value of
+\fIsort_type\fR
+should be chosen from the following list:
+.RS 3n
+.TP 3n
+\(bu
+t,
+at: Sort by query time or average query time
+.TP 3n
+\(bu
+l,
+al: Sort by lock time or average lock time
+.TP 3n
+\(bu
+s,
+as: Sort by rows sent or average rows went
+.TP 3n
+\(bu
+c: Sort by count
+.RE
+.TP 3n
+\(bu
+\fB\-t \fR\fB\fIN\fR\fR
+.sp
+Display only the first
+\fIN\fR
+queries in the output.
+.TP 3n
+\(bu
+\fB\-\-verbose\fR,
+\fB\-v\fR
+.sp
+Verbose mode. Print more information about what the program does.
+.sp
+.RE
+.PP
+Example of usage:
+.sp
+.RS 3n
+.nf
+shell> \fBmysqldumpslow\fR
+Reading mysql slow query log from /usr/local/mysql/data/mysqld51\-apple\-slow.log
+Count: 1  Time=4.32s (4s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ insert into t2 select * from t1
+Count: 3  Time=2.53s (7s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ insert into t2 select * from t1 limit N
+Count: 3  Time=2.13s (6s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ insert into t1 select * from t1
+.fi
+.RE
+.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/).