summaryrefslogtreecommitdiffstats
path: root/man/my_print_defaults.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/my_print_defaults.1')
-rw-r--r--man/my_print_defaults.1219
1 files changed, 219 insertions, 0 deletions
diff --git a/man/my_print_defaults.1 b/man/my_print_defaults.1
new file mode 100644
index 00000000..ae151743
--- /dev/null
+++ b/man/my_print_defaults.1
@@ -0,0 +1,219 @@
+'\" t
+.\"
+.TH "\FBMY_PRINT_DEFAULTS" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.\" my_print_defaults
+.SH "NAME"
+my_print_defaults \- display options from option files
+.SH "SYNOPSIS"
+.HP \w'\fBmy_print_defaults\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIoption_group\fR\fR\fB\ \&.\&.\&.\fR\ 'u
+\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
+.if n \{\
+.RS 4
+.\}
+.nf
+shell> \fBmy_print_defaults mysqlcheck client\fR
+\-\-user=myusername
+\-\-password=secret
+\-\-host=localhost
+.fi
+.if n \{\
+.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
+supports the following options\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: help option
+.\" help option: my_print_defaults
+\fB\-\-help\fR,
+\fB\-?\fR
+.sp
+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
+.\}
+.\" my_print_defaults: config-file option
+.\" config-file option: my_print_defaults
+\fB
+.\" my_print_defaults: defaults-file option
+.\" defaults-file option: my_print_defaults
+\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR,
+\fB\-c \fR\fB\fIfile_name\fR\fR
+.sp
+Read only the given option file\&. If no extension is given, default extension(.ini or .cnf) will
+be used\&. If \fB\-\-defaults\-file\fR is
+the first option, then read this file only, do not read global or per\-user config files; should be the first option.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: debug option
+.\" debug option: my_print_defaults
+\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR,
+\fB\-# \fR\fB\fIdebug_options\fR\fR
+.sp
+Write a debugging log\&. A typical
+\fIdebug_options\fR
+string is
+\'d:t:o,\fIfile_name\fR\'\&. The default is
+\'d:t:o,/tmp/my_print_defaults\&.trace\'\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: defaults-extra-file option
+.\" defaults-extra-file option: my_print_defaults
+\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR,
+.\" my_print_defaults: extra-file option
+.\" extra-file option: my_print_defaults
+\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\&. Should be the first option\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: defaults-group-suffix option
+.\" defaults-group-suffix option: my_print_defaults
+\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\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: --mysqld option
+.\" mysqld option: my_print_defaults
+\fB\-\-mysqld\fR
+.sp
+Read the same set of groups that the mysqld binary does.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: no-defaults option
+.\" no-defaults option: my_print_defaults
+\fB\-\-no\-defaults\fR,
+\fB\-n\fR
+.sp
+Return an empty string (useful for scripts)\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: verbose option
+.\" verbose option: my_print_defaults
+\fB\-\-verbose\fR,
+\fB\-v\fR
+.sp
+Verbose mode\&. Print more information about what the program does\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" my_print_defaults: version option
+.\" version option: my_print_defaults
+\fB\-\-version\fR,
+\fB\-V\fR
+.sp
+Display version information and exit\&.
+.RE
+.SH "COPYRIGHT"
+.br
+.PP
+Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2019 MariaDB Foundation
+.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-1335 USA or see http://www.gnu.org/licenses/.
+.sp
+.SH "SEE ALSO"
+For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
+.SH AUTHOR
+MariaDB Foundation (http://www.mariadb.org/).