Skip to content

Commit 6616674

Browse files
committed
Updating man pages from Docs
Approved-by: Bjorn Munch <bjorn.munch@oracle.com>
1 parent 5516dfe commit 6616674

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+4421
-3689
lines changed

man/comp_err.1

+101-36
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBcomp_err\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 11/23/2019
5+
.\" Date: 03/06/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBCOMP_ERR\FR" "1" "11/23/2019" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBCOMP_ERR\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -43,20 +43,51 @@ to determine the error messages to display for different error codes\&.
4343
\fBcomp_err\fR
4444
normally is run automatically when MySQL is built\&. It compiles the
4545
errmsg\&.sys
46-
file from the text file located at
47-
sql/share/errmsg\-utf8\&.txt
48-
in MySQL source distributions\&.
46+
file from text\-format error information in MySQL source distributions:
47+
.sp
48+
.RS 4
49+
.ie n \{\
50+
\h'-04'\(bu\h'+03'\c
51+
.\}
52+
.el \{\
53+
.sp -1
54+
.IP \(bu 2.3
55+
.\}
56+
As of MySQL 8\&.0\&.19, the error information comes from the
57+
messages_to_error_log\&.txt
58+
and
59+
messages_to_clients\&.txt
60+
files in the
61+
share
62+
directory\&.
63+
.sp
64+
For more information about defining error messages, see the comments within those files, along with the
65+
errmsg_readme\&.txt
66+
file\&.
67+
.RE
68+
.sp
69+
.RS 4
70+
.ie n \{\
71+
\h'-04'\(bu\h'+03'\c
72+
.\}
73+
.el \{\
74+
.sp -1
75+
.IP \(bu 2.3
76+
.\}
77+
Prior to MySQL 8\&.0\&.19, the error information comes from the
78+
errmsg\-utf8\&.txt
79+
file in the
80+
sql/share
81+
directory\&.
82+
.RE
4983
.PP
5084
\fBcomp_err\fR
51-
also generates
85+
also generates the
5286
mysqld_error\&.h,
5387
mysqld_ername\&.h, and
54-
sql_state\&.h
88+
mysqld_errmsg\&.h
5589
header files\&.
5690
.PP
57-
For more information about how error messages are defined, see the
58-
\m[blue]\fBMySQL Internals Manual\fR\m[]\&\s-2\u[1]\d\s+2\&.
59-
.PP
6091
Invoke
6192
\fBcomp_err\fR
6293
like this:
@@ -143,7 +174,22 @@ Print some debugging information when the program exits\&.
143174
.sp -1
144175
.IP \(bu 2.3
145176
.\}
146-
\fB\-\-header_file=\fR\fB\fIfile_name\fR\fR,
177+
\fB\-\-errmsg\-file=\fR\fB\fIfile_name\fR\fR,
178+
\fB\-H \fR\fB\fIfile_name\fR\fR
179+
.sp
180+
The name of the error message file\&. The default is
181+
mysqld_errmsg\&.h\&. This option was added in MySQL 8\&.0\&.18\&.
182+
.RE
183+
.sp
184+
.RS 4
185+
.ie n \{\
186+
\h'-04'\(bu\h'+03'\c
187+
.\}
188+
.el \{\
189+
.sp -1
190+
.IP \(bu 2.3
191+
.\}
192+
\fB\-\-header\-file=\fR\fB\fIfile_name\fR\fR,
147193
\fB\-H \fR\fB\fIfile_name\fR\fR
148194
.sp
149195
The name of the error header file\&. The default is
@@ -158,11 +204,17 @@ mysqld_error\&.h\&.
158204
.sp -1
159205
.IP \(bu 2.3
160206
.\}
161-
\fB\-\-in_file=\fR\fB\fIfile_name\fR\fR,
207+
\fB\-\-in\-file=\fR\fB\fIfile_name\fR\fR,
162208
\fB\-F \fR\fB\fIfile_name\fR\fR
163209
.sp
164210
The name of the input file\&. The default is
165-
\&.\&./sql/share/errmsg\-utf8\&.txt\&.
211+
\&.\&./share/errmsg\-utf8\&.txt\&.
212+
.sp
213+
This option was removed in MySQL 8\&.0\&.19 and replaced by the
214+
\fB\-\-in\-file\-errlog\fR
215+
and
216+
\fB\-\-in\-file\-toclient\fR
217+
options\&.
166218
.RE
167219
.sp
168220
.RS 4
@@ -173,11 +225,13 @@ The name of the input file\&. The default is
173225
.sp -1
174226
.IP \(bu 2.3
175227
.\}
176-
\fB\-\-name_file=\fR\fB\fIfile_name\fR\fR,
177-
\fB\-N \fR\fB\fIfile_name\fR\fR
228+
\fB\-\-in\-file\-errlog=\fR\fB\fIfile_name\fR\fR,
229+
\fB\-e \fR\fB\fIfile_name\fR\fR
178230
.sp
179-
The name of the error name file\&. The default is
180-
mysqld_ername\&.h\&.
231+
The name of the input file that defines error messages intended to be written to the error log\&. The default is
232+
\&.\&./share/messages_to_error_log\&.txt\&.
233+
.sp
234+
This option was added in MySQL 8\&.0\&.19\&.
181235
.RE
182236
.sp
183237
.RS 4
@@ -188,11 +242,13 @@ mysqld_ername\&.h\&.
188242
.sp -1
189243
.IP \(bu 2.3
190244
.\}
191-
\fB\-\-out_dir=\fR\fB\fIdir_name\fR\fR,
192-
\fB\-D \fR\fB\fIdir_name\fR\fR
245+
\fB\-\-in\-file\-toclient=\fR\fB\fIfile_name\fR\fR,
246+
\fB\-c \fR\fB\fIfile_name\fR\fR
193247
.sp
194-
The name of the output base directory\&. The default is
195-
\&.\&./sql/share/\&.
248+
The name of the input file that defines error messages intended to be written to clients\&. The default is
249+
\&.\&./share/messages_to_clients\&.txt\&.
250+
.sp
251+
This option was added in MySQL 8\&.0\&.19\&.
196252
.RE
197253
.sp
198254
.RS 4
@@ -203,11 +259,26 @@ The name of the output base directory\&. The default is
203259
.sp -1
204260
.IP \(bu 2.3
205261
.\}
206-
\fB\-\-out_file=\fR\fB\fIfile_name\fR\fR,
207-
\fB\-O \fR\fB\fIfile_name\fR\fR
262+
\fB\-\-name\-file=\fR\fB\fIfile_name\fR\fR,
263+
\fB\-N \fR\fB\fIfile_name\fR\fR
208264
.sp
209-
The name of the output file\&. The default is
210-
errmsg\&.sys\&.
265+
The name of the error name file\&. The default is
266+
mysqld_ername\&.h\&.
267+
.RE
268+
.sp
269+
.RS 4
270+
.ie n \{\
271+
\h'-04'\(bu\h'+03'\c
272+
.\}
273+
.el \{\
274+
.sp -1
275+
.IP \(bu 2.3
276+
.\}
277+
\fB\-\-out\-dir=\fR\fB\fIdir_name\fR\fR,
278+
\fB\-D \fR\fB\fIdir_name\fR\fR
279+
.sp
280+
The name of the output base directory\&. The default is
281+
\&.\&./sql/share/\&.
211282
.RE
212283
.sp
213284
.RS 4
@@ -218,11 +289,11 @@ errmsg\&.sys\&.
218289
.sp -1
219290
.IP \(bu 2.3
220291
.\}
221-
\fB\-\-statefile=\fR\fB\fIfile_name\fR\fR,
222-
\fB\-S \fR\fB\fIfile_name\fR\fR
292+
\fB\-\-out\-file=\fR\fB\fIfile_name\fR\fR,
293+
\fB\-O \fR\fB\fIfile_name\fR\fR
223294
.sp
224-
The name for the SQLSTATE header file\&. The default is
225-
sql_state\&.h\&.
295+
The name of the output file\&. The default is
296+
errmsg\&.sys\&.
226297
.RE
227298
.sp
228299
.RS 4
@@ -241,20 +312,14 @@ Display version information and exit\&.
241312
.SH "COPYRIGHT"
242313
.br
243314
.PP
244-
Copyright \(co 1997, 2019, Oracle and/or its affiliates. All rights reserved.
315+
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
245316
.PP
246317
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.
247318
.PP
248319
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.
249320
.PP
250321
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/.
251322
.sp
252-
.SH "NOTES"
253-
.IP " 1." 4
254-
MySQL Internals Manual
255-
.RS 4
256-
\%https://dev.mysql.com/doc/internals/en
257-
.RE
258323
.SH "SEE ALSO"
259324
For more information, please refer to the MySQL Reference Manual,
260325
which may already be installed locally and which is also available

man/ibd2sdi.1

+10-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBibd2sdi\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 11/23/2019
5+
.\" Date: 03/06/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBIBD2SDI\FR" "1" "11/23/2019" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBIBD2SDI\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -102,7 +102,8 @@ The files of a multi\-file tablespace must be specified in order of the ascendin
102102
outputs SDI (containing id, type, and data fields) in
103103
JSON
104104
format\&.
105-
ibd2sdi Options.PP
105+
ibd2sdi Options
106+
.PP
106107
\fBibd2sdi\fR
107108
supports the following options:
108109
.sp
@@ -210,6 +211,11 @@ shell> \fBibd2sdi \-\-debug=d:t /tmp/ibd2sdi\&.trace\fR
210211
.if n \{\
211212
.RE
212213
.\}
214+
.sp
215+
This option is available only if MySQL was built using
216+
\fBWITH_DEBUG\fR\&. MySQL release binaries provided by Oracle are
217+
\fInot\fR
218+
built using this option\&.
213219
.RE
214220
.sp
215221
.RS 4
@@ -496,7 +502,7 @@ shell> \fBibd2sdi \-\-skip\-pretty \&.\&./data/test/t1\&.ibd\fR
496502
.SH "COPYRIGHT"
497503
.br
498504
.PP
499-
Copyright \(co 1997, 2019, Oracle and/or its affiliates. All rights reserved.
505+
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
500506
.PP
501507
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.
502508
.PP

man/innochecksum.1

+9-6
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBinnochecksum\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 11/23/2019
5+
.\" Date: 03/06/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBINNOCHECKSUM\FR" "1" "11/23/2019" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBINNOCHECKSUM\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -70,7 +70,8 @@ shell> \fBinnochecksum [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIfile_name\fR\fR
7070
.RE
7171
.\}
7272
.sp
73-
innochecksum Options.PP
73+
innochecksum Options
74+
.PP
7475
\fBinnochecksum\fR
7576
supports the following options\&. For options that refer to page numbers, the numbers are zero\-based\&.
7677
.sp
@@ -839,7 +840,8 @@ shell> \fBcat t1\&.ibd | innochecksum \-\-write=crc32 \- > a\&.ibd\fR
839840
.RE
840841
.\}
841842
.RE
842-
Running innochecksum on Multiple User\-defined Tablespace Files.PP
843+
Running innochecksum on Multiple User\-defined Tablespace Files
844+
.PP
843845
The following examples demonstrate how to run
844846
\fBinnochecksum\fR
845847
on multiple user\-defined tablespace files (\&.ibd
@@ -928,7 +930,8 @@ cmd> innochecksum\&.exe t3\&.ibd
928930
.\}
929931
.sp .5v
930932
.RE
931-
Running innochecksum on Multiple System Tablespace Files.PP
933+
Running innochecksum on Multiple System Tablespace Files
934+
.PP
932935
By default, there is only one
933936
InnoDB
934937
system tablespace file (ibdata1) but multiple files for the system tablespace can be defined using the
@@ -1014,7 +1017,7 @@ cmd> innochecksum\&.exe ibdata3
10141017
.SH "COPYRIGHT"
10151018
.br
10161019
.PP
1017-
Copyright \(co 1997, 2019, Oracle and/or its affiliates. All rights reserved.
1020+
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
10181021
.PP
10191022
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.
10201023
.PP

man/lz4_decompress.1

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBlz4_decompress\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 11/23/2019
5+
.\" Date: 03/06/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBLZ4_DECOMPRESS\FR" "1" "11/23/2019" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBLZ4_DECOMPRESS\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -101,7 +101,7 @@ ZLIB\-compressed output, use
101101
.SH "COPYRIGHT"
102102
.br
103103
.PP
104-
Copyright \(co 1997, 2019, Oracle and/or its affiliates. All rights reserved.
104+
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
105105
.PP
106106
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.
107107
.PP

man/my_print_defaults.1

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmy_print_defaults\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 11/23/2019
5+
.\" Date: 03/06/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMY_PRINT_DEFAULTS\FR" "1" "11/23/2019" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMY_PRINT_DEFAULTS\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -231,7 +231,7 @@ Display version information and exit\&.
231231
.SH "COPYRIGHT"
232232
.br
233233
.PP
234-
Copyright \(co 1997, 2019, Oracle and/or its affiliates. All rights reserved.
234+
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
235235
.PP
236236
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.
237237
.PP

man/myisam_ftdump.1

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: \fBmyisam_ftdump\fR
33
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 11/23/2019
5+
.\" Date: 03/06/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBMYISAM_FTDUMP\FR" "1" "11/23/2019" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBMYISAM_FTDUMP\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -250,7 +250,7 @@ Verbose mode\&. Print more output about what the program does\&.
250250
.SH "COPYRIGHT"
251251
.br
252252
.PP
253-
Copyright \(co 1997, 2019, Oracle and/or its affiliates. All rights reserved.
253+
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
254254
.PP
255255
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.
256256
.PP

0 commit comments

Comments
 (0)