mirror/mariadb
1
0
Fork 0
mirror of https://github.com/MariaDB/server.git synced 2025-01-29 02:05:57 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDEV-23789: Fix unnecessary acute accents in man pages

Browse source 
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.
This commit is contained in:
Otto Kekäläinen 2023-03-11 13:01:39 -08:00 • committed by Daniel Black
parent 3430767e00
commit e36b648077
20 changed files with 203 additions and 269 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
man/my_print_defaults.1
View file

@ -80,8 +80,8 @@ Display a help message and exit\&.
\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
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
@ -100,9 +100,7 @@ the first option, then read this file only, do not read global or per\-user conf
.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\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/my_print_defaults.trace'.
.RE
.sp
.RS 4
@ -120,7 +118,7 @@ string is
.\" 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
Read this option file after the global option file but (on Unix) before the user option
file\&. Should be the first option\&.
.RE
.sp

2
man/myisam_ftdump.1
View file

@ -56,7 +56,7 @@ table\&. You can also specify a table by naming its index file (the file with th
\&.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

32
man/myisamchk.1
View file

@ -189,7 +189,7 @@ Otherwise, when you run
.RS 4
.\}
.nf
warning: clients are using or haven\'t closed the table properly
warning: clients are using or haven't closed the table properly
.fi
.if n \{\
.RE
@ -197,7 +197,7 @@ warning: clients are using or haven\'t closed the table properly
.PP
This means that you are trying to check a table that has been updated by another program (such as the
\fBmysqld\fR
server) that hasn\'t yet closed the file or that has died without closing the file properly, which can sometimes lead to the corruption of one or more
server) that hasn't yet closed the file or that has died without closing the file properly, which can sometimes lead to the corruption of one or more
MyISAM
tables\&.
.PP
@ -273,9 +273,7 @@ Display a help message and exit\&. Options are presented in a single list\&.
.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/myisamchk\&.trace\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/myisamchk.trace'.
.RE
.sp
.RS 4
@ -729,7 +727,7 @@ the section called \(lqMYISAMCHK TABLE INFORMATION\(rq\&.
\fB\-\-fast\fR,
\fB\-F\fR
.sp
Check only tables that haven\'t been closed properly\&.
Check only tables that haven't been closed properly\&.
.RE
.sp
.RS 4
@ -751,7 +749,7 @@ finds any errors in the table\&. The repair type is the same as that specified w
\fB\-\-recover\fR
or
\fB\-r\fR
option\&. States will be updated as with
option\&. States will be updated as with
\fB\-\-update\-state\fR\&.
.RE
.sp
@ -826,7 +824,7 @@ Store information in the
\&.MYI
file to indicate when the table was checked and whether the table crashed\&. This should be used to get full benefit of the
\fB\-\-check\-only\-changed\fR
option, but you shouldn\'t use this option if the
option, but you shouldn't use this option if the
\fBmysqld\fR
server is using the table and you are running it with external locking disabled\&.
.RE
@ -902,8 +900,8 @@ Correct the checksum information for the table\&.
.\" create-missing-keys option: myisamchk
\fB\-\-create\-missing\-keys\fR
.sp
Create missing keys. This assumes that the data file is correct and that the
number of rows stored in the index file is correct\&. Enables
Create missing keys. This assumes that the data file is correct and that the
number of rows stored in the index file is correct\&. Enables
\fB\-\-quick\fR\&.
.RE
@ -960,8 +958,8 @@ the section called \(lqMYISAMCHK TABLE INFORMATION\(rq\&.
Overwrite old intermediate files (files with names like
\fItbl_name\fR\&.TMD) instead of aborting\&. Add another
\fB\-\-force\fR
to avoid 'myisam_sort_buffer_size is too small' errors\&. In this case
we will attempt to do the repair with the given
to avoid 'myisam_sort_buffer_size is too small' errors\&. In this case
we will attempt to do the repair with the given
\fBmyisam_sort_buffer_size\fR
and dynamically allocate as many management buffers as needed\&.
.RE
@ -1287,8 +1285,8 @@ Sort records according to a particular index\&. This makes your data much more l
SELECT
and
ORDER BY
operations that use this index\&. (The first time you use this option to sort a table, it may be very slow\&.) To determine a table\'s index numbers, use
SHOW INDEX, which displays a table\'s indexes in the same order that
operations that use this index\&. (The first time you use this option to sort a table, it may be very slow\&.) To determine a table's index numbers, use
SHOW INDEX, which displays a table's indexes in the same order that
\fBmyisamchk\fR
sees them\&. Indexes are numbered beginning with 1\&.
.sp
@ -1311,7 +1309,7 @@ must unpack key blocks first, then re\-create indexes and pack the key blocks ag
.\" stats_method option: myisamchk
\fB\-\-stats\-method=name\fR
.sp
Specifies how index statistics collection code should treat NULLs\&. Possible values
Specifies how index statistics collection code should treat NULLs\&. Possible values
of name are "nulls_unequal" (default), "nulls_equal" (emulate MySQL 4 behavior), and "nulls_ignored"\&.
.RE
.SH "MYISAMCHK TABLE INFORMATION"
@ -1616,7 +1614,7 @@ sorted index pages\&.
Auto increment key,
Last value
.sp
The key number associated the table\'s
The key number associated the table's
AUTO_INCREMENT
column, and the most recently generated value for this column\&. These fields do not appear if there is no such column\&.
.RE
@ -1757,7 +1755,7 @@ displays some low\-level information:
.\}
Key
.sp
This key\'s number\&. This value is shown only for the first column of the key\&. If this value is missing, the line corresponds to the second or later column of a multiple\-column key\&. For the table shown in the example, there are two
This key's number\&. This value is shown only for the first column of the key\&. If this value is missing, the line corresponds to the second or later column of a multiple\-column key\&. For the table shown in the example, there are two
table description
lines for the second index\&. This indicates that it is a multiple\-part index with two parts\&.
.RE

6
man/myisampack.1
View file

@ -125,7 +125,7 @@ Display a help message and exit\&.
\fB\-\-backup\fR,
\fB\-b\fR
.sp
Make a backup of each table\'s data file using the name
Make a backup of each table's data file using the name
\fItbl_name\fR\&.OLD\&.
.RE
.sp
@ -160,9 +160,7 @@ Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.sp
Write a debugging log\&. A typical
\fIdebug_options\fR
string is
\'d:t:o,\fIfile_name\fR\'\&. The default is
\'d:t:o\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'.
.RE
.sp
.RS 4

26
man/mysql-test-run.pl.1
View file

@ -191,7 +191,7 @@ shell> \fBmake test force="\-\-skip\-test=init_file"\fR
.PP
To run
\fBmysql\-test\-run\&.pl\fR
on Windows, you\'ll need either Cygwin or ActiveState Perl to run it\&. You may also need to install the modules required by the script\&. To run the test script, change location into the
on Windows, you'll need either Cygwin or ActiveState Perl to run it\&. You may also need to install the modules required by the script\&. To run the test script, change location into the
mysql\-test
directory, set the
MTR_VS_CONFIG
@ -829,7 +829,7 @@ Add setting from the named file to all generated configs\&.
.sp
Run all test cases having a name that begins with the given
\fIprefix\fR
value, or fulfils the
value, or fulfils the
\fIregex\fR\&. This option provides a convenient way to run a family of similarly named tests\&.
.sp
The argument for the
@ -1038,7 +1038,7 @@ file per source and header file\&.
.\" gcov-src-dir option: mysql-test-run.pl
\fB\-\-gcov\-src\-dir\fR
.sp
Colllect coverage only within the given subdirectory\&. For example, if you're only developing the SQL layer,
Colllect coverage only within the given subdirectory\&. For example, if you're only developing the SQL layer,
it makes sense to use \fB--gcov-src-dir=sql\fR\&.
.RE
.sp
@ -1513,7 +1513,7 @@ number of times\&.
.\" report-features option: mysql-test-run.pl
\fB\-\-report\-features\fR
.sp
First run a "test" that reports MariaDB features, displaying the output of SHOW ENGINES and SHOW VARIABLES\&. This can be
First run a "test" that reports MariaDB features, displaying the output of SHOW ENGINES and SHOW VARIABLES\&. This can be
used to verify that binaries are built with all required features\&.
.RE
.sp
@ -1546,7 +1546,7 @@ Report how much time has been spent on different phases of test execution\&.
.sp
If a test fails, it is retried up to a maximum of
\fIN\fR
runs (default 1)\&. Retries are also limited by the maximum number of failures before stopping,
runs (default 1)\&. Retries are also limited by the maximum number of failures before stopping,
set with the \fB-\-retry\-failure\fR option\&. This option has no effect unless
\fB\-\-force\fR
is also used; without it, test execution will terminate after the first failure\&.
@ -1572,7 +1572,7 @@ may fail in total, as each repetition is considered a new test case, which may i
.\" retry-failure option: mysql-test-run.pl
\fB\-\-retry\-failure=\fR\fB\fIN\fR\fR
.sp
When using the \fB-\-retry\fR option to retry failed tests,
When using the \fB-\-retry\fR option to retry failed tests,
stop when N failures have occurred (default 2)\&. Setting it to 0 or 1 effectively turns off retries\&.
.RE
.sp
@ -1744,7 +1744,7 @@ option, it sets up a secure connection for all test cases\&. In this case, if
does not support SSL,
\fBmysql\-test\-run\&.pl\fR
exits with an error message:
Couldn\'t find support for SSL
Couldn't find support for SSL
.RE
.sp
.RS 4
@ -1810,7 +1810,7 @@ will stop once the server has been started, but will terminate if the server die
.\" start-and-exit option: mysql-test-run.pl
\fB\-\-start\-and\-exit\fR
.sp
Same
Same
\fB\-\-start\fR, but mysql-test-run terminates and leaves just the server running\&.
.RE
.sp
@ -1877,7 +1877,7 @@ Run the "mysqld" executables using strace. Default options are \fB-f -o var/log/
Create
\fBstrace\fR
output for
\fBmysqltest\fR, optionally specifying name and path
\fBmysqltest\fR, optionally specifying name and path
to the trace program to use\&.
.sp
Example: \&./mysql\-test\-run\&.pl \-\-strace\-client=ktrace
@ -1895,8 +1895,8 @@ Example: \&./mysql\-test\-run\&.pl \-\-strace\-client=ktrace
.\" strace-option option: mysql-test-run.pl
\fB\-\-strace\-option\fR=\fR\fB\fIARGS\fR\fR
.sp
Option to give
\fBstrace\fR,
Option to give
\fBstrace\fR,
replaces default option(s)\&.
.RE
.sp
@ -2144,9 +2144,9 @@ server with
.\" valgrind-mysqltest option: mysql-test-run.pl
\fB\-\-valgrind\-mysqltest\fR
.sp
Run the
Run the
\fBmysqltest\fR
and
and
\fBmysql_client_test\fR
executables with
\fBvalgrind\fR\&.

42
man/mysql.1
View file

@ -340,9 +340,7 @@ The database to use\&.
.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/mysql\&.trace\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysql.trace'.
.RE
.sp
.RS 4
@ -884,7 +882,7 @@ Directory for client-side plugins\&.
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
The TCP/IP port number to use for the connection or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&.
The TCP/IP port number to use for the connection or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&.
Forces --protocol=tcp when specified on the command line without other connection properties\&.
.RE
.sp
@ -1238,7 +1236,7 @@ Forces --protocol=socket when specified on the command line without other connec
.\" SSL options: mysql
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp
@ -1529,9 +1527,9 @@ The XML output also uses an XML namespace, as shown here:
.RS 4
.\}
.nf
shell> \fBmysql \-\-xml \-uroot \-e "SHOW VARIABLES LIKE \'version%\'"\fR
shell> \fBmysql \-\-xml \-uroot \-e "SHOW VARIABLES LIKE 'version%'"\fR
<?xml version="1\&.0"?>
<resultset statement="SHOW VARIABLES LIKE \'version%\'" xmlns:xsi="http://www\&.w3\&.org/2001/XMLSchema\-instance">
<resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www\&.w3\&.org/2001/XMLSchema\-instance">
<row>
<field name="Variable_name">version</field>
<field name="Value">5\&.0\&.40\-debug</field>
@ -1665,7 +1663,7 @@ if it exists, and then use either of the following techniques:
Set the
MYSQL_HISTFILE
variable to
/dev/null\&. To cause this setting to take effect each time you log in, put the setting in one of your shell\'s startup files\&.
/dev/null\&. To cause this setting to take effect each time you log in, put the setting in one of your shell's startup files\&.
.RE
.sp
.RS 4
@ -1713,8 +1711,8 @@ prompt:
.nf
mysql> \fBhelp\fR
List of all MySQL commands:
Note that all text commands must be first on line and end with \';\'
? (\e?) Synonym for `help\'\&.
Note that all text commands must be first on line and end with ';'
? (\e?) Synonym for 'help'\&.
clear (\ec) Clear command\&.
connect (\er) Reconnect to the server\&. Optional arguments are db and host\&.
delimiter (\ed) Set statement delimiter\&.
@ -1724,7 +1722,7 @@ exit (\eq) Exit mysql\&. Same as quit\&.
go (\eg) Send command to mysql server\&.
help (\eh) Display this help\&.
nopager (\en) Disable pager, print to stdout\&.
notee (\et) Don\'t write into outfile\&.
notee (\et) Don't write into outfile\&.
pager (\eP) Set PAGER [to_pager]\&. Print the query results via PAGER\&.
print (\ep) Print current command\&.
prompt (\eR) Change your mysql prompt\&.
@ -1739,8 +1737,8 @@ use (\eu) Use another database\&. Takes database name as argument\&.
charset (\eC) Switch to another charset\&. Might be needed for processing
binlog with multi\-byte charsets\&.
warnings (\eW) Show warnings after every statement\&.
nowarning (\ew) Don\'t show warnings after every statement\&.
For server side help, type \'help contents\'
nowarning (\ew) Don't show warnings after every statement\&.
For server side help, type 'help contents'
.fi
.if n \{\
.RE
@ -1848,7 +1846,7 @@ Change the string that
\fBmysql\fR
interprets as the separator between SQL statements\&. The default is the semicolon character (\(lq;\(rq)\&.
.sp
The delimiter can be specified as an unquoted or quoted argument\&. Quoting can be done with either single quote (\') or douple quote (") characters\&. To include a quote within a quoted string, either quote the string with the other quote character or escape the quote with a backslash (\(lq\e\(rq) character\&. Backslash should be avoided outside of quoted strings because it is the escape character for MariaDB\&. For an unquoted argument, the delmiter is read up to the first space or end of line\&. For a quoted argument, the delimiter is read up to the matching quote on the line\&.
The delimiter can be specified as an unquoted or quoted argument\&. Quoting can be done with either single quote (') or douple quote (") characters\&. To include a quote within a quoted string, either quote the string with the other quote character or escape the quote with a backslash (\(lq\e\(rq) character\&. Backslash should be avoided outside of quoted strings because it is the escape character for MariaDB\&. For an unquoted argument, the delmiter is read up to the first space or end of line\&. For a quoted argument, the delimiter is read up to the matching quote on the line\&.
.sp
When the delimiter recognized by
\fBmysql\fR
@ -2556,7 +2554,7 @@ T}:T{
A space (a space follows the backslash)
T}
T{
\e\'
\e'
T}:T{
Single quote
T}
@ -2702,7 +2700,7 @@ prompt
.\}
.nf
mysql> \fBprompt (\eu@\eh) [\ed]>\e_\fR
PROMPT set to \'(\eu@\eh) [\ed]>\e_\'
PROMPT set to '(\eu@\eh) [\ed]>\e_'
(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]>
(\fIuser\fR@\fIhost\fR) [\fIdatabase\fR]> prompt
Returning to default PROMPT of mysql>
@ -2740,7 +2738,7 @@ If there is no match for the search string, the search fails:
.nf
mysql> \fBhelp me\fR
Nothing found
Please try to run \'help contents\' for a list of all accessible topics
Please try to run 'help contents' for a list of all accessible topics
.fi
.if n \{\
.RE
@ -2756,7 +2754,7 @@ to see a list of the help categories:
.nf
mysql> \fBhelp contents\fR
You asked for help about help category: "Contents"
For more information, type \'help <item>\', where <item> is one of the
For more information, type 'help <item>', where <item> is one of the
following categories:
Account Management
Administration
@ -2788,7 +2786,7 @@ shows a list of matching topics:
.nf
mysql> \fBhelp logs\fR
Many help items for your request exist\&.
To make a more specific request, please type \'help <item>\',
To make a more specific request, please type 'help <item>',
where <item> is one of the following topics:
SHOW
SHOW BINARY LOGS
@ -2806,7 +2804,7 @@ Use a topic as the search string to see the help entry for that topic:
.\}
.nf
mysql> \fBhelp show binary logs\fR
Name: \'SHOW BINARY LOGS\'
Name: 'SHOW BINARY LOGS'
Description:
Syntax:
SHOW BINARY LOGS
@ -2906,7 +2904,7 @@ Sometimes you may want your script to display progress information to the user\&
.RS 4
.\}
.nf
SELECT \'<info_to_display>\' AS \' \';
SELECT '<info_to_display>' AS ' ';
.fi
.if n \{\
.RE
@ -2953,7 +2951,7 @@ mail_from: Monty
sbj: UTF\-8
txt: >>>>> "Thimble" == Thimble Smith writes:
Thimble> Hi\&. I think this is a good idea\&. Is anyone familiar
Thimble> with UTF\-8 or Unicode? Otherwise, I\'ll put this on my
Thimble> with UTF\-8 or Unicode? Otherwise, I'll put this on my
Thimble> TODO list and see what happens\&.
Yes, please do that\&.
Regards,

3
man/mysql_client_test.1
View file

@ -123,8 +123,7 @@ The database to use\&.
.sp
Write a debugging log if MariaDB is built with debugging support\&. The default
\fIdebug_options\fR
value is
\'d:t:o,/tmp/mysql_client_test\&.trace\'\&.
value is 'd:t:o,/tmp/mysql_client_test.trace'.
.RE
.sp
.RS 4

2
man/mysql_tzinfo_to_sql.1
View file

@ -64,7 +64,7 @@ shell> \fBmysql_tzinfo_to_sql /usr/share/zoneinfo | mysql \-u root mysql\fR
.\}
.PP
\fBmysql_tzinfo_to_sql\fR
reads your system\'s time zone files and generates SQL statements from them\&.
reads your system's time zone files and generates SQL statements from them\&.
\fBmysql\fR
processes those statements to load the time zone tables\&.
.PP

2
man/mysqlaccess.1
View file

@ -400,7 +400,7 @@ script at approximately line 18\&. Search for a line that looks like this:
.RS 4
.\}
.nf
$MYSQL = \'/usr/local/bin/mysql\'; # path to mysql executable
$MYSQL = '/usr/local/bin/mysql'; # path to mysql executable
.fi
.if n \{\
.RE

16
man/mysqladmin.1
View file

@ -22,7 +22,7 @@ mariadb-admin \- client for administering a MariaDB server (mysqladmin is now a
.SH "DESCRIPTION"
.PP
\fBmysqladmin\fR
is a client for performing administrative operations\&. You can use it to check the server\'s configuration and current status, to create and drop databases, and more\&.
is a client for performing administrative operations\&. You can use it to check the server's configuration and current status, to create and drop databases, and more\&.
.PP
Invoke
\fBmysqladmin\fR
@ -763,7 +763,7 @@ If you execute
\fBmysqladmin shutdown\fR
when connecting to a local server using a Unix socket file,
\fBmysqladmin\fR
waits until the server\'s process ID file has been removed, to ensure that the server has stopped properly\&.
waits until the server's process ID file has been removed, to ensure that the server has stopped properly\&.
.\" mysqladmin command options
.\" command options: mysqladmin
.\" options: command-line: mysqladmin
@ -871,9 +871,7 @@ option is given\&.
.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/mysqladmin\&.trace\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysqladmin.trace'.
.RE
.sp
.RS 4
@ -1103,7 +1101,7 @@ On Windows, connect to the server via a named pipe\&. This option applies only i
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
The TCP/IP port number to use for the connection or 0 for default to,
The TCP/IP port number to use for the connection or 0 for default to,
in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&.
Forces --protocol=tcp when specified on the command line without other connection properties\&.
.RE
@ -1243,7 +1241,7 @@ Forces --protocol=socket when specified on the command line without other connec
.\" SSL options: mysqladmin
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp
@ -1386,7 +1384,7 @@ Verify server's "Common Name" in its cert against hostname used when connecting.
.\" TLS Version option: mysqladmin
\fB\-\-tls\-version=\fR\fB\fIname\fR\fR,
.sp
Accepts a comma-separated list of TLS protocol versions\&. A TLS protocol version will only be enabled if it
Accepts a comma-separated list of TLS protocol versions\&. A TLS protocol version will only be enabled if it
is present in this list\&. All other TLS protocol versions will not be permitted\&.
.RE
.sp
@ -1485,7 +1483,7 @@ value is given, it indicates the number of times to retry\&. The default is one
.\" --wait-for-all-slaves option: mysqladmin
\fB\-\-wait\-for\-all\-slaves\fR
.sp
Wait for the last binlog event to be sent to all connected slaves before shutting down\&.
Wait for the last binlog event to be sent to all connected slaves before shutting down\&.
This option is off by default\&.
.RE
.PP

160
man/mysqlbinlog.1
View file

@ -19,7 +19,7 @@ mariadb-binlog \- utility for processing binary log files (mysqlbinlog is now a
\fBmysqlbinlog [\fR\fBoptions\fR\fB] \fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.\fR
.SH "DESCRIPTION"
.PP
The server\'s binary log consists of files containing
The server's binary log consists of files containing
\(lqevents\(rq
that describe modifications to database contents\&. The server writes these files in binary format\&. To display their contents in text format, use the
\fBmysqlbinlog\fR
@ -400,7 +400,7 @@ INSERT
statements following
USE db2\&.
.PP
\fBRow-based logging\fR.
\fBRow-based logging\fR.
\fBmysqlbinlog\fR
outputs only entries that change tables belonging to
\fIdb_name\fR\&. The default database has no effect on this\&. Suppose that the binary log just described was created using row\-based logging rather than statement\-based logging\&.
@ -455,9 +455,7 @@ with row\-based logging prior to MySQL 5\&.1\&.37\&.
.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/mysqlbinlog\&.trace\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysqlbinlog.trace'.
.RE
.sp
.RS 4
@ -725,7 +723,7 @@ option on the command line,
\fBmysqlbinlog\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. You
Specifying a password on the command line should be considered insecure\&. You
can use an option file to avoid giving the password on the command line\&.
.RE
.sp
@ -772,8 +770,8 @@ Print the program argument list from all option files and exit\&.
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
The TCP/IP port number to use for connecting to a remote server,
or \fB0\fR for default to, in order of preference, \fBmy.cnf\fR,
The TCP/IP port number to use for connecting to a remote server,
or \fB0\fR for default to, in order of preference, \fBmy.cnf\fR,
\fB$MYSQL_TCP_PORT\fR, \fB/etc/services\fR, \fRbuilt-in default (3306)\fR\&.
Forces --protocol=tcp when specified on the command line without other connection properties\&.
.RE
@ -861,16 +859,16 @@ Direct output to the given file\&. With --raw this is a prefix for the file name
\fB\-\-rewrite\-db=\fR\fB\fIname\fR\fR,
\fB\-r \fR\fB\fIname\fR\fR
.sp
Updates to a database with a different name than the original.
Example: \fBrewrite-db='from->to'\fR\&. For events that are
binlogged as statements, rewriting the database constitutes changing a
statement's default database from \fIdb1\fB to \fIdb2\fR\&. There is no statement
Updates to a database with a different name than the original.
Example: \fBrewrite-db='from->to'\fR\&. For events that are
binlogged as statements, rewriting the database constitutes changing a
statement's default database from \fIdb1\fB to \fIdb2\fR\&. There is no statement
analysis or rewrite of any kind, that is, if one specifies \fB"db1.tbl"\fR
in the statement explicitly, that occurrence won't be changed to
\fB"db2.tbl"\fR\&. Row-based events are rewritten correctly to use the new
database name\&. Filtering (e.g. with \fB--database=name\fR) happens after
the database rewrites have been performed\&. If you use this option on the
command line and \fB">"\fR has a special meaning to your command interpreter,
in the statement explicitly, that occurrence won't be changed to
\fB"db2.tbl"\fR\&. Row-based events are rewritten correctly to use the new
database name\&. Filtering (e.g. with \fB--database=name\fR) happens after
the database rewrites have been performed\&. If you use this option on the
command line and \fB">"\fR has a special meaning to your command interpreter,
quote the value (e.g. \fB--rewrite-db="oldname->newname"\fR\&.
.RE
.sp
@ -919,9 +917,9 @@ statement to the output to specify the character set to be used for processing l
\fB\-\-short\-form\fR,
\fB\-s\fR
.sp
Display only the statements contained in the log, no extra info
and no row-based events\&. This is for testing only, and should
not be used in production systems. If you want to suppress
Display only the statements contained in the log, no extra info
and no row-based events\&. This is for testing only, and should
not be used in production systems. If you want to suppress
base64-output, consider using \fB--base64-output=never\fR instead\&.
.RE
.sp
@ -1210,7 +1208,7 @@ You can pipe the output of
\fBmysqlbinlog\fR
into the
\fBmysql\fR
client to execute the events contained in the binary log\&. This technique is used to recover from a crash when you have an old
client to execute the events contained in the binary log\&. This technique is used to recover from a crash when you have an old
backup\&. For example:
.sp
.if n \{\
@ -1422,11 +1420,8 @@ Position: The byte position within the log file\&.
.sp -1
.IP \(bu 2.3
.\}
Timestamp: The event timestamp\&. In the example shown,
\'9d fc 5c 43\'
is the representation of
\'051024 17:24:13\'
in hexadecimal\&.
Timestamp: The event timestamp\&. In the example shown, '9d fc 5c 43'
is the representation of '051024 17:24:13' in hexadecimal\&.
.RE
.sp
.RS 4
@ -1437,9 +1432,7 @@ in hexadecimal\&.
.sp -1
.IP \(bu 2.3
.\}
Type: The event type code\&. In the example shown,
\'0f\'
indicates a
Type: The event type code\&. In the example shown, '0f' indicates a
FORMAT_DESCRIPTION_EVENT\&. The following table lists the possible type codes\&.
.TS
allbox tab(:);
@ -1729,14 +1722,11 @@ T}:T{
.nf
LOG_EVENT_BINLOG_IN_USE_F
T}:T{
Log file correctly closed\&. (Used only in
FORMAT_DESCRIPTION_EVENT\&.) If
this flag is set (if the flags are, for example,
\'01 00\') in a
FORMAT_DESCRIPTION_EVENT, the log
file has not been properly closed\&. Most probably
this is because of a master crash (for example, due
to power failure)\&.
Log file correctly closed\&. (Used only in FORMAT_DESCRIPTION_EVENT\&.) If this
flag is set (if the flags are, for example, '01 00') in a
FORMAT_DESCRIPTION_EVENT, the log file has not been properly closed\&. Most
probably this is because of a master crash (for example, due to power
failure)\&.
T}
T{
02
@ -1752,7 +1742,7 @@ T}:T{
LOG_EVENT_THREAD_SPECIFIC_F
T}:T{
Set if the event is dependent on the connection it was executed in (for
example, \'04 00\'), for example,
example, '04 00'), for example,
if the event uses temporary tables\&.
T}
T{
@ -1794,8 +1784,8 @@ CREATE TABLE t
date DATE NULL
) ENGINE = InnoDB;
START TRANSACTION;
INSERT INTO t VALUES(1, \'apple\', NULL);
UPDATE t SET name = \'pear\', date = \'2009\-01\-01\' WHERE id = 1;
INSERT INTO t VALUES(1, 'apple', NULL);
UPDATE t SET name = 'pear', date = '2009\-01\-01' WHERE id = 1;
DELETE FROM t WHERE id = 1;
COMMIT;
.fi
@ -1817,24 +1807,18 @@ shell> \fBmysqlbinlog \fR\fB\fIlog_file\fR\fR
\&.\&.\&.
# at 218
#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ==
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/;
\&.\&.\&.
# at 302
#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/;
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/;
.fi
.if n \{\
.RE
@ -1859,43 +1843,37 @@ shell> \fBmysqlbinlog \-v \fR\fB\fIlog_file\fR\fR
\&.\&.\&.
# at 218
#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ==
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/;
### INSERT INTO test\&.t
### SET
### @1=1
### @2=\'apple\'
### @2='apple'
### @3=NULL
\&.\&.\&.
# at 302
#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/;
### UPDATE test\&.t
### WHERE
### @1=1
### @2=\'apple\'
### @2='apple'
### @3=NULL
### SET
### @1=1
### @2=\'pear\'
### @3=\'2009:01:01\'
### @2='pear'
### @3='2009:01:01'
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/;
### DELETE FROM test\&.t
### WHERE
### @1=1
### @2=\'pear\'
### @3=\'2009:01:01\'
### @2='pear'
### @3='2009:01:01'
.fi
.if n \{\
.RE
@ -1915,43 +1893,37 @@ shell> \fBmysqlbinlog \-vv \fR\fB\fIlog_file\fR\fR
\&.\&.\&.
# at 218
#080828 15:03:08 server id 1 end_log_pos 258 Write_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ==
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAANoAAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBcBAAAAKAAAAAIBAAAQABEAAAAAAAEAA//8AQAAAAVhcHBsZQ=='/*!*/;
### INSERT INTO test\&.t
### SET
### @1=1 /* INT meta=0 nullable=0 is_null=0 */
### @2=\'apple\' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */
\&.\&.\&.
# at 302
#080828 15:03:08 server id 1 end_log_pos 356 Update_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAAC4BAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBgBAAAANgAAAGQBAAAQABEAAAAAAAEAA////AEAAAAFYXBwbGX4AQAAAARwZWFyIbIP'/*!*/;
### UPDATE test\&.t
### WHERE
### @1=1 /* INT meta=0 nullable=0 is_null=0 */
### @2=\'apple\' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @2='apple' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @3=NULL /* VARSTRING(20) meta=0 nullable=1 is_null=1 */
### SET
### @1=1 /* INT meta=0 nullable=0 is_null=0 */
### @2=\'pear\' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @3=\'2009:01:01\' /* DATE meta=0 nullable=1 is_null=0 */
### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F
BINLOG \'
fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP
\'/*!*/;
BINLOG 'fAS3SBMBAAAALAAAAJABAAAAABEAAAAAAAAABHRlc3QAAXQAAwMPCgIUAAQ=
fAS3SBkBAAAAKgAAALoBAAAQABEAAAAAAAEAA//4AQAAAARwZWFyIbIP'/*!*/;
### DELETE FROM test\&.t
### WHERE
### @1=1 /* INT meta=0 nullable=0 is_null=0 */
### @2=\'pear\' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @3=\'2009:01:01\' /* DATE meta=0 nullable=1 is_null=0 */
### @2='pear' /* VARSTRING(20) meta=20 nullable=0 is_null=0 */
### @3='2009:01:01' /* DATE meta=0 nullable=1 is_null=0 */
.fi
.if n \{\
.RE
@ -1982,7 +1954,7 @@ shell> \fBmysqlbinlog \-v \-\-base64\-output=DECODE\-ROWS \fR\fB\fIlog_file\fR\f
### INSERT INTO test\&.t
### SET
### @1=1
### @2=\'apple\'
### @2='apple'
### @3=NULL
\&.\&.\&.
# at 302
@ -1990,20 +1962,20 @@ shell> \fBmysqlbinlog \-v \-\-base64\-output=DECODE\-ROWS \fR\fB\fIlog_file\fR\f
### UPDATE test\&.t
### WHERE
### @1=1
### @2=\'apple\'
### @2='apple'
### @3=NULL
### SET
### @1=1
### @2=\'pear\'
### @3=\'2009:01:01\'
### @2='pear'
### @3='2009:01:01'
\&.\&.\&.
# at 400
#080828 15:03:08 server id 1 end_log_pos 442 Delete_rows: table id 17 flags: STMT_END_F
### DELETE FROM test\&.t
### WHERE
### @1=1
### @2=\'pear\'
### @3=\'2009:01:01\'
### @2='pear'
### @3='2009:01:01'
.fi
.if n \{\
.RE

14
man/mysqlcheck.1
View file

@ -79,7 +79,7 @@ table, an attempt to check it produces this result:
.nf
shell> \fBmysqlcheck test t\fR
test\&.t
note : The storage engine for the table doesn\'t support check
note : The storage engine for the table doesn't support check
.fi
.if n \{\
.RE
@ -179,7 +179,7 @@ supports the following options, which can be specified on the command line or in
and
[client]
option file groups\&.
The \fB-c\fR, \fB-r\fR, \fB-a\fR and \fB-o\fR options are exclusive to each other\&.
The \fB-c\fR, \fB-r\fR, \fB-a\fR and \fB-o\fR options are exclusive to each other\&.
.sp
.RS 4
.ie n \{\
@ -381,9 +381,7 @@ treats the first name argument on the command line as a database name and follow
.sp
Write a debugging log\&. A typical
\fIdebug_options\fR
string is
\'d:t:o,\fIfile_name\fR\'\&. The default is
\'d:t:o\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'.
.RE
.sp
.RS 4
@ -495,7 +493,7 @@ Must be given as first option\&.
.sp
If you are using this option to check tables, it ensures that they are 100% consistent but takes a long time\&.
.sp
If you are using this option to repair tables, it will force using the old, slow, repair with keycache method,
If you are using this option to repair tables, it will force using the old, slow, repair with keycache method,
instead of the much faster repair by sorting.
.RE
.sp
@ -890,7 +888,7 @@ Forces --protocol=socket when specified on the command line without other connec
.\" SSL options: mysqladmin
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp
@ -1091,7 +1089,7 @@ The MariaDB user name to use when connecting to the server\&.
\fB\-v\fR
.sp
Verbose mode\&. Print information about the various stages of program operation\&.
Using one \fB--verbose\fR option will give you more information about what mysqlcheck is
Using one \fB--verbose\fR option will give you more information about what mysqlcheck is
doing\&.
.sp
Using two \fB--verbose\fR options will also give you connection information\&.

8
man/mysqld_multi.1
View file

@ -368,8 +368,8 @@ Silent mode; disable warnings\&.
.\" tcp-ip option: mysqld_multi
\fB\-\-tcp\-ip\fR
.sp
Connect to the MariaDB server(s) via the TCP/IP port instead of the UNIX socket\&. This affects stopping
and reporting. If a socket file is missing, the server may still be running, but can be accessed only
Connect to the MariaDB server(s) via the TCP/IP port instead of the UNIX socket\&. This affects stopping
and reporting. If a socket file is missing, the server may still be running, but can be accessed only
via the TCP/IP port\&. By default connecting is done via the UNIX socket\&. This option affects
stop and report operations\&.
.RE
@ -511,7 +511,7 @@ account by executing the following commands for each server:
shell> \fBmysql \-u root \-S /tmp/mysql\&.sock \-p\fR
Enter password:
mysql> \fBGRANT SHUTDOWN ON *\&.*\fR
\-> \fBTO \'multi_admin\'@\'localhost\' IDENTIFIED BY \'multipass\';\fR
\-> \fBTO 'multi_admin'@'localhost' IDENTIFIED BY 'multipass';\fR
.fi
.if n \{\
.RE
@ -606,7 +606,7 @@ option for
\fBmysqld_multi\fR
script as the Unix
root
user\&. Having the option in the option file doesn\'t matter; you just get a warning if you are not the superuser and the
user\&. Having the option in the option file doesn't matter; you just get a warning if you are not the superuser and the
\fBmysqld\fR
processes are started under your own Unix account\&.
.RE

2
man/mysqld_safe.1
View file

@ -327,7 +327,7 @@ directory\&.
.sp
Use the
nice
program to set the server\'s scheduling priority to the given value\&.
program to set the server's scheduling priority to the given value\&.
.RE
.sp
.RS 4

81
man/mysqldump.1
View file

@ -63,7 +63,7 @@ option, entire databases are dumped\&.
\fBmysqldump\fR
does not dump the
INFORMATION_SCHEMA or performance_schema
databases by default\&. To dump these,
databases by default\&. To dump these,
name them explicitly on the command line, although you must also use the
\fB\-\-skip\-lock\-tables\fR
option\&.
@ -504,7 +504,7 @@ Compress all information sent between the client and the server if both support
.\" copy-s3-tables option: mysqldump
\fB\-\-copy\-s3\-tables\fR
.sp
By default S3 tables are ignored\&. With this option set, the result file will contain a CREATE statement
By default S3 tables are ignored\&. With this option set, the result file will contain a CREATE statement
for a similar Aria table, followed by the table data and ending with an ALTER TABLE xxx ENGINE=S3\&.
.RE
.sp
@ -563,9 +563,7 @@ statements are included in the output before each new database\&.
.sp
Write a debugging log\&. A typical
\fIdebug_options\fR
string is
\'d:t:o,\fIfile_name\fR\'\&. The default value is
\'d:t:o,/tmp/mysqldump\&.trace\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default value is 'd:t:o,/tmp/mysqldump.trace'.
.RE
.sp
.RS 4
@ -793,14 +791,14 @@ suppresses date printing\&
.\" dump-slave option: mysqldump
\fB\-\-dump\-slave[=\fR\fB\fIvalue\fR\fR\fB]\fR
.sp
Used for producing a dump file from a replication slave server that can be used to set up another slave server
with the same master\&. Causes the binary log position and filename of the master to be appended to the dumped
data output\&. Setting the value to 1 (the default) will print it as a CHANGE MASTER command in the dumped data
output; if set to 2, that command will be prefixed with a comment symbol\&. This option will turn
\-\-lock\-all\-tables on, unless \-\-single-transaction is specified too (in which case a global read lock is only
taken a short time at the beginning of the dump \- don't forget to read about \-\-single-transaction below)\&. In
all cases any action on logs will happen at the exact moment of the dump\&. Option automatically turns
\-\-lock\-tables off\&. Using this option causes mysqldump to stop the slave SQL thread before beginning the dump,
Used for producing a dump file from a replication slave server that can be used to set up another slave server
with the same master\&. Causes the binary log position and filename of the master to be appended to the dumped
data output\&. Setting the value to 1 (the default) will print it as a CHANGE MASTER command in the dumped data
output; if set to 2, that command will be prefixed with a comment symbol\&. This option will turn
\-\-lock\-all\-tables on, unless \-\-single-transaction is specified too (in which case a global read lock is only
taken a short time at the beginning of the dump \- don't forget to read about \-\-single-transaction below)\&. In
all cases any action on logs will happen at the exact moment of the dump\&. Option automatically turns
\-\-lock\-tables off\&. Using this option causes mysqldump to stop the slave SQL thread before beginning the dump,
and restart it again after completion\&.
.RE
.sp
@ -1022,9 +1020,7 @@ Used together with --tab. When enabled, adds header with column names to the top
.\" hex-blob option: mysqldump
\fB\-\-hex\-blob\fR
.sp
Dump binary columns using hexadecimal notation (for example,
\'abc\'
becomes
Dump binary columns using hexadecimal notation (for example, 'abc' becomes
0x616263)\&. The affected data types are
BINARY,
VARBINARY, the
@ -1077,7 +1073,7 @@ Do not dump the given table, which must be specified using both the database and
.\" include-master-host-port option: mysqldump
\fB\-\-include\-master\-host\-port\fR
.sp
Add the MASTER_HOST and MASTER_PORT options for the CHANGE MASTER TO statement when using
Add the MASTER_HOST and MASTER_PORT options for the CHANGE MASTER TO statement when using
the \fB--dump-slave\fR option for a slave dump\&.
.RE
.sp
@ -1197,7 +1193,7 @@ Log warnings and errors by appending them to the named file\&. The default is to
.\" log-queries option: mysqldump
\fB\-\-log\-queries\fR\fR
.sp
When restoring the dump, the server will, if logging is turned on, log the queries to the general and slow query log\&.
When restoring the dump, the server will, if logging is turned on, log the queries to the general and slow query log\&.
Defaults to on; use \fB--skip-log-queries\fR to disable\&.
.RE
.sp
@ -1243,7 +1239,7 @@ It is also possible to set up a slave by dumping an existing slave of the master
.sp -1
.IP " 1." 4.2
.\}
Stop the slave\'s SQL thread and get its current status:
Stop the slave's SQL thread and get its current status:
.sp
.if n \{\
.RS 4
@ -1355,7 +1351,7 @@ On the new slave, set the replication coordinates to those of the master server
.\}
.nf
mysql> \fBCHANGE MASTER TO\fR
\-> \fBMASTER_LOG_FILE = \'\fR\fB\fIfile_name\fR\fR\fB\', MASTER_LOG_POS = \fR\fB\fIfile_pos\fR\fR\fB;\fR
\-> \fBMASTER_LOG_FILE = '\fR\fB\fIfile_name\fR\fR\fB', MASTER_LOG_POS = \fR\fB\fIfile_pos\fR\fR\fB;\fR
.fi
.if n \{\
.RE
@ -1564,7 +1560,7 @@ See the discussion at the beginning of this section for information about select
.\" order-by-primary option: mysqldump
\fB\-\-order\-by\-primary\fR
.sp
Dump each table\'s rows sorted by its primary key, or by its first unique index, if such an index exists\&. This is useful when dumping a
Dump each table's rows sorted by its primary key, or by its first unique index, if such an index exists\&. This is useful when dumping a
MyISAM
table to be loaded into an
InnoDB
@ -1880,7 +1876,7 @@ option with
.\" skip-add-drop-table option: mysqldump
\fB\-\-skip\-add\-drop\-table\fR
.sp
Disable the
Disable the
\fB\-\-add\-drop\-table\fR
option\&.
.RE
@ -1897,7 +1893,7 @@ option\&.
.\" skip-add-locks option: mysqldump
\fB\-\-skip\-add\-locks\fR
.sp
Disable the
Disable the
\fB\-\-add\-locks\fR
option\&.
.RE
@ -1914,7 +1910,7 @@ option\&.
.\" skip-comments option: mysqldump
\fB\-\-skip\-comments\fR
.sp
Disable the
Disable the
\fB\-\-comments\fR
option\&.
.RE
@ -1931,7 +1927,7 @@ option\&.
.\" skip-compact option: mysqldump
\fB\-\-skip\-compact\fR
.sp
Disable the
Disable the
\fB\-\-compact\fR
option\&.
.RE
@ -1948,7 +1944,7 @@ option\&.
.\" skip-disable-keys option: mysqldump
\fB\-\-skip\-disable\-keys\fR
.sp
Disable the
Disable the
\fB\-\-disable\-keys\fR
option\&.
.RE
@ -1965,7 +1961,7 @@ option\&.
.\" skip-extended-insert option: mysqldump
\fB\-\-skip\-extended\-insert\fR
.sp
Disable the
Disable the
\fB\-\-extended\-insert\fR
option\&.
.RE
@ -1999,7 +1995,7 @@ option\&.
.\" skip-quick option: mysqldump
\fB\-\-skip\-quick\fR
.sp
Disable the
Disable the
\fB\-\-quick\fR
option\&.
.RE
@ -2016,7 +2012,7 @@ option\&.
.\" skip-quote-names option: mysqldump
\fB\-\-skip\-quote\-names\fR
.sp
Disable the
Disable the
\fB\-\-quote\-names\fR
option\&.
.RE
@ -2033,7 +2029,7 @@ option\&.
.\" skip-set-charset option: mysqldump
\fB\-\-skip\-set\-charset\fR
.sp
Disable the
Disable the
\fB\-\-set\-charset\fR
option\&.
.RE
@ -2050,7 +2046,7 @@ option\&.
.\" skip-triggers option: mysqldump
\fB\-\-skip\-triggers\fR
.sp
Disable the
Disable the
\fB\-\-triggers\fR
option\&.
.RE
@ -2067,7 +2063,7 @@ option\&.
.\" skip-tz-utc option: mysqldump
\fB\-\-skip\-tz\-utc\fR
.sp
Disable the
Disable the
\fB\-\-tz\-utc\fR
option\&.
.RE
@ -2102,7 +2098,7 @@ Forces --protocol=socket when specified on the command line without other connec
.\" SSL options: mysqladmin
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp
@ -2446,7 +2442,7 @@ TIMESTAMP
columns to be dumped and reloaded between servers in different time zones\&.
\fBmysqldump\fR
sets its connection time zone to UTC and adds
SET TIME_ZONE=\'+00:00\'
SET TIME_ZONE='+00:00'
to the dump file\&. Without this option,
TIMESTAMP
columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change if the servers are in different time zones\&.
@ -2515,8 +2511,8 @@ Display version information and exit\&.
.\}
.\" mysqldump: where option
.\" where option: mysqldump
\fB\-\-where=\'\fR\fB\fIwhere_condition\fR\fR\fB\'\fR,
\fB\-w \'\fR\fB\fIwhere_condition\fR\fR\fB\'\fR
\fB\-\-where='\fR\fB\fIwhere_condition\fR\fR\fB'\fR,
\fB\-w '\fR\fB\fIwhere_condition\fR\fR\fB'\fR
.sp
Dump only rows selected by the given
WHERE
@ -2528,7 +2524,7 @@ Examples:
.RS 4
.\}
.nf
\-\-where="user=\'jimf\'"
\-\-where="user='jimf'"
\-w"userid>1"
\-w"userid<1"
.fi
@ -2552,11 +2548,8 @@ Examples:
.sp
Write dump output as well\-formed XML\&.
.sp
\fBNULL\fR\fB, \fR\fB\'NULL\'\fR\fB, and Empty Values\fR: For a column named
\fIcolumn_name\fR, the
NULL
value, an empty string, and the string value
\'NULL\'
\fBNULL\fR\fB, \fR\fB'NULL'\fR\fB, and Empty Values\fR: For a column named
\fIcolumn_name\fR, the NULL value, an empty string, and the string value 'NULL'
are distinguished from one another in the output generated by this option as follows\&.
.TS
allbox tab(:);
@ -2572,12 +2565,12 @@ T}:T{
<field name="\fIcolumn_name\fR" xsi:nil="true" />
T}
T{
\'\' (\fIempty string\fR)
\(aq\(aq (\fIempty string\fR)
T}:T{
<field name="\fIcolumn_name\fR"></field>
T}
T{
\'NULL\' (\fIstring value\fR)
\(aqNULL\(aq (\fIstring value\fR)
T}:T{
<field name="\fIcolumn_name\fR">NULL</field>
T}

11
man/mysqldumpslow.1
View file

@ -27,11 +27,7 @@ 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
these values to N and 'S' when displaying summary output\&. The
\fB\-a\fR
and
\fB\-n\fR
@ -79,10 +75,7 @@ Display a help message and exit\&.
.\}
\fB\-a\fR
.sp
Do not abstract all numbers to
N
and strings to
\'S\'\&.
Do not abstract all numbers to N and strings to 'S'.
.RE
.sp
.RS 4

12
man/mysqlimport.1
View file

@ -49,7 +49,7 @@ shell> \fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\
.PP
For each text file named on the command line,
\fBmysqlimport\fR
strips any extension from the file name and uses the result to determine the name of the table into which to import the file\'s contents\&. For example, files named
strips any extension from the file name and uses the result to determine the name of the table into which to import the file's contents\&. For example, files named
patient\&.txt,
patient\&.text, and
patient
@ -144,9 +144,7 @@ Compress all information sent between the client and the server if both support
.sp
Write a debugging log\&. A typical
\fIdebug_options\fR
string is
\'d:t:o,\fIfile_name\fR\'\&. The default is
\'d:t:o\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'.
.RE
.sp
.RS 4
@ -633,7 +631,7 @@ Forces --protocol=socket when specified on the command line without other connec
.\" SSL options: mysqladmin
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp
@ -836,7 +834,7 @@ Here is a sample session that demonstrates use of
.RS 4
.\}
.nf
shell> \fBmysql \-e \'CREATE TABLE imptest(id INT, n VARCHAR(30))\' test\fR
shell> \fBmysql \-e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test\fR
shell> \fBed\fR
a
100 Max Sydow
@ -851,7 +849,7 @@ shell> \fBod \-c imptest\&.txt\fR
0000040
shell> \fBmysqlimport \-\-local test imptest\&.txt\fR
test\&.imptest: Records: 2 Deleted: 0 Skipped: 0 Warnings: 0
shell> \fBmysql \-e \'SELECT * FROM imptest\' test\fR
shell> \fBmysql \-e 'SELECT * FROM imptest' test\fR
+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| id | n |
+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+

8
man/mysqlshow.1
View file

@ -26,7 +26,7 @@ mariadb-show \- display database, table, and column information (mysqlshow is no
.PP
The
\fBmysqlshow\fR
client can be used to quickly see which databases exist, their tables, or a table\'s columns or indexes\&.
client can be used to quickly see which databases exist, their tables, or a table's columns or indexes\&.
.PP
\fBmysqlshow\fR
provides a command\-line interface to several SQL
@ -191,9 +191,7 @@ tables\&.
.sp
Write a debugging log\&. A typical
\fIdebug_options\fR
string is
\'d:t:o,\fIfile_name\fR\'\&. The default is
\'d:t:o\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o'.
.RE
.sp
.RS 4
@ -510,7 +508,7 @@ Forces --protocol=socket when specified on the command line without other connec
.\" SSL options: mysqlshow
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp

22
man/mysqlslap.1
View file

@ -105,7 +105,7 @@ build the query SQL statement with a table of two
INT
columns and three
VARCHAR
columns\&. Use five clients querying 20 times each\&. Do not create the table or insert the data (that is, use the previous test\'s schema and data):
columns\&. Use five clients querying 20 times each\&. Do not create the table or insert the data (that is, use the previous test's schema and data):
.sp
.if n \{\
.RS 4
@ -119,15 +119,11 @@ mysqlslap \-\-concurrency=5 \-\-iterations=20 \e
.RE
.\}
.PP
Tell the program to load the create, insert, and query SQL statements from the specified files, where the
create\&.sql
file has multiple table creation statements delimited by
\';\'
and multiple insert statements delimited by
\';\'\&. The
Tell the program to load the create, insert, and query SQL statements from the specified files, where the create\&.sql
file has multiple table creation statements delimited by ';' and multiple insert statements delimited by ';'\&. The
\fB\-\-query\fR
file will have multiple queries delimited by
\';\'\&. Run all the load statements, then run all the queries in the query file with five clients (five times each):
file will have multiple queries delimited by ';'\&. Run all the load statements,
then run all the queries in the query file with five clients (five times each):
.sp
.if n \{\
.RS 4
@ -427,9 +423,7 @@ Generate output in comma\-separated values format\&. The output goes to the name
.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/mysqlslap\&.trace\'\&.
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysqlslap.trace'.
.RE
.sp
.RS 4
@ -556,7 +550,7 @@ statements\&. The default is 0 (connections are not detached)\&.
\fB\-\-engine=\fR\fB\fIengine_name\fR\fR,
\fB\-e \fR\fB\fIengine_name\fR\fR
.sp
Comma separated list of storage engines to use for creating the table\&. The test is run for
Comma separated list of storage engines to use for creating the table\&. The test is run for
each engine\&. You can also specify an option for an engine after a colon, for example
\fBmemory:max_row=2300\fR\&.
.RE
@ -976,7 +970,7 @@ Forces --protocol=socket when specified on the command line without other connec
.\" SSL options: mysqlshow
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp

13
man/mysqltest.1
View file

@ -218,9 +218,9 @@ This can be used to set the MYSQL_OPT_CONNECT_TIMEOUT parameter of mysql_options
.\" continue-on-error option: mysqltest
\fB\-\-continue\-on\-error\fR
.sp
Continue test even if we got an error\&. This is mostly
useful when testing a storage engine to see what from a
test file it can execute, or to find all syntax errors in
Continue test even if we got an error\&. This is mostly
useful when testing a storage engine to see what from a
test file it can execute, or to find all syntax errors in
a newly created big test file\&.
.RE
.sp
@ -270,8 +270,7 @@ The default database to use\&.
.sp
Write a debugging log if MariaDB is built with debugging support\&. The default
\fIdebug_options\fR
value is
\'d:t:S:i:O,/tmp/mysqltest\&.trace\'\&.
value is 'd:t:S:i:O,/tmp/mysqltest.trace'.
.RE
.sp
.RS 4
@ -478,7 +477,7 @@ Directory for client-side plugins\&.
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
\fB\-P \fR\fB\fIport_num\fR\fR
.sp
The TCP/IP port number to use for the connection or 0 for default to, in order of preference,
The TCP/IP port number to use for the connection or 0 for default to, in order of preference,
my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&.
.RE
.sp
@ -792,7 +791,7 @@ creates and invokes a stored procedure that executes the statement rather than e
.\" SSL options: mysqltest
\fB\-\-ssl\fR
.sp
Enable SSL for connection (automatically enabled with other flags). Disable with
Enable SSL for connection (automatically enabled with other flags). Disable with
\fB\-\-skip-ssl\fR\&.
.RE
.sp