Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball.

1 files changed, 111 insertions, 0 deletions

diff --git a/man/my_print_defaults.1 b/man/my_print_defaults.1
new file mode 100644
index 00000000000..a92b2c2ad85
--- /dev/null
+++ b/man/my_print_defaults.1
@@ -0,0 +1,111 @@
+.\"     Title: \fBmy_print_defaults\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 "\fBMY_PRINT_DEFAULTS" "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"
+my_print_defaults \- display options from option files
+.SH "SYNOPSIS"
+.HP 45
+\fBmy_print_defaults [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIoption_group\fR\fR\fB ...\fR
+.SH "DESCRIPTION"
+.PP
+\fBmy_print_defaults\fR
+displays the options that are present in option groups of option files. The output indicates what options will be used by programs that read the specified option groups. For example, the
+\fBmysqlcheck\fR
+program reads the
+[mysqlcheck]
+and
+[client]
+option groups. To see what options are present in those groups in the standard option files, invoke
+\fBmy_print_defaults\fR
+like this:
+.sp
+.RS 3n
+.nf
+shell> \fBmy_print_defaults mysqlcheck client\fR
+\-\-user=myusername
+\-\-password=secret
+\-\-host=localhost
+.fi
+.RE
+.PP
+The output consists of options, one per line, in the form that they would be specified on the command line.
+.PP
+\fBmy_print_defaults\fR
+understands the following options:
+.TP 3n
+\(bu
+\fB\-\-help\fR,
+\fB\-?\fR
+.sp
+Display a help message and exit.
+.TP 3n
+\(bu
+\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR,
+\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR,
+\fB\-c \fR\fB\fIfile_name\fR\fR
+.sp
+Read only the given option file.
+.TP 3n
+\(bu
+\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR\fB, \-# \fR\fB\fIdebug_options\fR\fR
+.sp
+Write a debugging log. The
+\fIdebug_options\fR
+string often is
+\'d:t:o,\fIfile_name\fR'. The default is
+\'d:t:o,/tmp/my_print_defaults.trace'.
+.TP 3n
+\(bu
+\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR,
+\fB\-\-extra\-file=\fR\fB\fIfile_name\fR\fR,
+\fB\-e \fR\fB\fIfile_name\fR\fR
+.sp
+Read this option file after the global option file but (on Unix) before the user option file.
+.TP 3n
+\(bu
+\fB\-\-defaults\-group\-suffix=\fR\fB\fIsuffix\fR\fR,
+\fB\-g \fR\fB\fIsuffix\fR\fR
+.sp
+In addition to the groups named on the command line, read groups that have the given suffix.
+.TP 3n
+\(bu
+\fB\-\-no\-defaults\fR,
+\fB\-n\fR
+.sp
+Return an empty string.
+.TP 3n
+\(bu
+\fB\-\-verbose\fR,
+\fB\-v\fR
+.sp
+Verbose mode. Print more information about what the program does.
+.TP 3n
+\(bu
+\fB\-\-version\fR,
+\fB\-V\fR
+.sp
+Display version information and exit.
+.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/).