2009-09-16 14:03:18 +02:00
'\" t
2009-05-25 11:59:47 +02:00
. \"
2023-03-12 01:00:19 +01:00
.TH "\fBMY_PRINT_DEFAULTS\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System"
2009-09-16 14:03:18 +02:00
. \" -----------------------------------------------------------------
. \" * set default formatting
. \" -----------------------------------------------------------------
2009-05-25 11:59:47 +02:00
. \" disable hyphenation
.nh
. \" disable justification (adjust text to left margin only)
.ad l
2009-09-16 14:03:18 +02:00
. \" -----------------------------------------------------------------
. \" * MAIN CONTENT STARTS HERE *
. \" -----------------------------------------------------------------
. \" my_print_defaults
2009-05-25 11:59:47 +02:00
.SH "NAME"
my_print_defaults \- display options from option files
.SH "SYNOPSIS"
2009-09-16 14:03:18 +02:00
.HP \w '\fBmy_print_defaults\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR \fB \fI option_group\fR\fR\fB\ \& .\&.\&.\fR\ 'u
\fB my_print_defaults [\fR \fB \fI options\fR \fR \fB ] \fR \fB \fI option_group\fR \fR \fB \& .\& .\& .\fR
2009-05-25 11:59:47 +02:00
.SH "DESCRIPTION"
.PP
\fB my_print_defaults\fR
2009-09-16 14:03:18 +02:00
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
2009-05-25 11:59:47 +02:00
\fB mysqlcheck\fR
program reads the
[mysqlcheck]
and
[client]
2009-09-16 14:03:18 +02:00
option groups\& . To see what options are present in those groups in the standard option files, invoke
2009-05-25 11:59:47 +02:00
\fB my_print_defaults\fR
like this:
.sp
2009-09-16 14:03:18 +02:00
.if n \{ \
.RS 4
. \}
2009-05-25 11:59:47 +02:00
.nf
shell> \fB my_print_defaults mysqlcheck client\fR
\- \- user=myusername
\- \- password=secret
\- \- host=localhost
.fi
2009-09-16 14:03:18 +02:00
.if n \{ \
2009-05-25 11:59:47 +02:00
.RE
2009-09-16 14:03:18 +02:00
. \}
2009-05-25 11:59:47 +02:00
.PP
2009-09-16 14:03:18 +02:00
The output consists of options, one per line, in the form that they would be specified on the command line\& .
2009-05-25 11:59:47 +02:00
.PP
\fB my_print_defaults\fR
2010-04-28 15:06:11 +02:00
supports the following options\& .
2009-09-16 14:03:18 +02:00
.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
2009-05-25 11:59:47 +02:00
\fB \- \- help\fR ,
\fB \- ?\fR
.sp
2009-09-16 14:03:18 +02:00
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
2018-01-14 03:34:10 +01:00
\fB
2009-09-16 14:03:18 +02:00
. \" my_print_defaults: defaults-file option
. \" defaults-file option: my_print_defaults
2009-05-25 11:59:47 +02:00
\fB \- \- defaults\- file=\fR \fB \fI file_name\fR \fR ,
\fB \- c \fR \fB \fI file_name\fR \fR
.sp
MDEV-23789: Fix unnecessary acute accents in man pages
The man pages has several places where \' is intended to escape the single
quote and just print '. However, in reality this will print an ` (acute
accent). Fix this by removing excess backslashes. Also remove some excess
& in front of dots, such escaping is also unnecessary.
Also join several lines to avoid lone words in quotes to be read by groff
as macros when they are just text.
In a table (t{}) the content must be on new lines separately, so groff
will try to read them as macros too, so use \(aq that renders to '
(single quote).
This error was originally detected by Lintian:
https://lintian.debian.org/tags/acute-accent-in-manual-page
Example of man page sections before and after:
Make a backup of each table´s data file using the name tbl_name.OLD.
->
Make a backup of each table's data file using the name tbl_name.OLD.
A typical debug_options string is ´d:t:o,file_name´.
The default is ´d:t:o,/tmp/my_print_defaults.trace´.
->
A typical debug_options string is 'd:t:o,file_name'.
The default is 'd:t:o,/tmp/my_print_defaults.trace'.
shell> mysql --xml -uroot -e "SHOW VARIABLES LIKE ´version%´"
<?xml version="1.0"?>
<resultset statement="SHOW VARIABLES LIKE ´version%´" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
->
shell> mysql --xml -uroot -e "SHOW VARIABLES LIKE 'version%'"
<?xml version="1.0"?>
<resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
This command was used to validate no man pages have syntax errors:
for x in *.?
do
echo "##### $x #####"
LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z $x >/dev/null
done
The man pages are not perfect after this, there are still a lot of
suboptimal syntax, but this helps towards better man pages.
All new code of the whole pull request, including one or several files
that are either new files or modified ones, are contributed under the
BSD-new license. I am contributing on behalf of my employer Amazon Web
Services, Inc.
2023-03-11 22:01:39 +01:00
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
2015-09-09 14:32:52 +02:00
the first option, then read this file only, do not read global or per\- user config files; should be the first option.
2009-09-16 14:03:18 +02:00
.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
2009-12-01 08:24:05 +01:00
\fB \- \- debug=\fR \fB \fI debug_options\fR \fR ,
\fB \- # \fR \fB \fI debug_options\fR \fR
2009-05-25 11:59:47 +02:00
.sp
2009-09-16 14:03:18 +02:00
Write a debugging log\& . A typical
2009-05-25 11:59:47 +02:00
\fI debug_options\fR
MDEV-23789: Fix unnecessary acute accents in man pages
The man pages has several places where \' is intended to escape the single
quote and just print '. However, in reality this will print an ` (acute
accent). Fix this by removing excess backslashes. Also remove some excess
& in front of dots, such escaping is also unnecessary.
Also join several lines to avoid lone words in quotes to be read by groff
as macros when they are just text.
In a table (t{}) the content must be on new lines separately, so groff
will try to read them as macros too, so use \(aq that renders to '
(single quote).
This error was originally detected by Lintian:
https://lintian.debian.org/tags/acute-accent-in-manual-page
Example of man page sections before and after:
Make a backup of each table´s data file using the name tbl_name.OLD.
->
Make a backup of each table's data file using the name tbl_name.OLD.
A typical debug_options string is ´d:t:o,file_name´.
The default is ´d:t:o,/tmp/my_print_defaults.trace´.
->
A typical debug_options string is 'd:t:o,file_name'.
The default is 'd:t:o,/tmp/my_print_defaults.trace'.
shell> mysql --xml -uroot -e "SHOW VARIABLES LIKE ´version%´"
<?xml version="1.0"?>
<resultset statement="SHOW VARIABLES LIKE ´version%´" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
->
shell> mysql --xml -uroot -e "SHOW VARIABLES LIKE 'version%'"
<?xml version="1.0"?>
<resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
This command was used to validate no man pages have syntax errors:
for x in *.?
do
echo "##### $x #####"
LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z $x >/dev/null
done
The man pages are not perfect after this, there are still a lot of
suboptimal syntax, but this helps towards better man pages.
All new code of the whole pull request, including one or several files
that are either new files or modified ones, are contributed under the
BSD-new license. I am contributing on behalf of my employer Amazon Web
Services, Inc.
2023-03-11 22:01:39 +01:00
string is 'd:t:o,\fI file_name\fR '. The default is 'd:t:o,/tmp/my_print_defaults.trace'.
2009-09-16 14:03:18 +02:00
.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
2009-05-25 11:59:47 +02:00
\fB \- \- defaults\- extra\- file=\fR \fB \fI file_name\fR \fR ,
2009-09-16 14:03:18 +02:00
. \" my_print_defaults: extra-file option
. \" extra-file option: my_print_defaults
2009-05-25 11:59:47 +02:00
\fB \- e \fR \fB \fI file_name\fR \fR
.sp
MDEV-23789: Fix unnecessary acute accents in man pages
The man pages has several places where \' is intended to escape the single
quote and just print '. However, in reality this will print an ` (acute
accent). Fix this by removing excess backslashes. Also remove some excess
& in front of dots, such escaping is also unnecessary.
Also join several lines to avoid lone words in quotes to be read by groff
as macros when they are just text.
In a table (t{}) the content must be on new lines separately, so groff
will try to read them as macros too, so use \(aq that renders to '
(single quote).
This error was originally detected by Lintian:
https://lintian.debian.org/tags/acute-accent-in-manual-page
Example of man page sections before and after:
Make a backup of each table´s data file using the name tbl_name.OLD.
->
Make a backup of each table's data file using the name tbl_name.OLD.
A typical debug_options string is ´d:t:o,file_name´.
The default is ´d:t:o,/tmp/my_print_defaults.trace´.
->
A typical debug_options string is 'd:t:o,file_name'.
The default is 'd:t:o,/tmp/my_print_defaults.trace'.
shell> mysql --xml -uroot -e "SHOW VARIABLES LIKE ´version%´"
<?xml version="1.0"?>
<resultset statement="SHOW VARIABLES LIKE ´version%´" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
->
shell> mysql --xml -uroot -e "SHOW VARIABLES LIKE 'version%'"
<?xml version="1.0"?>
<resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
This command was used to validate no man pages have syntax errors:
for x in *.?
do
echo "##### $x #####"
LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z $x >/dev/null
done
The man pages are not perfect after this, there are still a lot of
suboptimal syntax, but this helps towards better man pages.
All new code of the whole pull request, including one or several files
that are either new files or modified ones, are contributed under the
BSD-new license. I am contributing on behalf of my employer Amazon Web
Services, Inc.
2023-03-11 22:01:39 +01:00
Read this option file after the global option file but (on Unix) before the user option
2018-01-14 03:34:10 +01:00
file\& . Should be the first option\& .
2009-09-16 14:03:18 +02:00
.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
2009-05-25 11:59:47 +02:00
\fB \- \- defaults\- group\- suffix=\fR \fB \fI suffix\fR \fR ,
\fB \- g \fR \fB \fI suffix\fR \fR
.sp
2009-09-16 14:03:18 +02:00
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
. \}
2015-09-09 14:32:52 +02:00
. \" 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
. \}
2009-09-16 14:03:18 +02:00
. \" my_print_defaults: no-defaults option
. \" no-defaults option: my_print_defaults
2009-05-25 11:59:47 +02:00
\fB \- \- no\- defaults\fR ,
\fB \- n\fR
.sp
2015-09-09 14:32:52 +02:00
Return an empty string (useful for scripts)\& .
2009-09-16 14:03:18 +02:00
.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
2009-05-25 11:59:47 +02:00
\fB \- \- verbose\fR ,
\fB \- v\fR
.sp
2009-09-16 14:03:18 +02:00
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
2009-05-25 11:59:47 +02:00
\fB \- \- version\fR ,
\fB \- V\fR
.sp
2009-09-16 14:03:18 +02:00
Display version information and exit\& .
.RE
2009-05-25 11:59:47 +02:00
.SH "COPYRIGHT"
2009-09-16 14:03:18 +02:00
.br
2009-05-25 11:59:47 +02:00
.PP
2020-05-15 17:35:47 +02:00
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation
2009-05-25 11:59:47 +02:00
.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
2019-05-11 20:29:06 +02:00
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/.
2009-09-16 14:03:18 +02:00
.sp
2009-05-25 11:59:47 +02:00
.SH "SEE ALSO"
2015-09-09 14:32:52 +02:00
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
2009-05-25 11:59:47 +02:00
.SH AUTHOR
2015-09-09 14:32:52 +02:00
MariaDB Foundation (http://www.mariadb.org/).