Skip to content

Commit 618e6ce

Browse files
committed
Updating man pages from Docs
Approved By: Erlend Dahl <erlend.dahl@oracle.com>
1 parent 2ee0e71 commit 618e6ce

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

+5290
-4929
lines changed

man/comp_err.1

Lines changed: 3 additions & 16 deletions
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: 03/06/2020
5+
.\" Date: 06/01/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBCOMP_ERR\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBCOMP_ERR\FR" "1" "06/01/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -115,7 +115,6 @@ supports the following options\&.
115115
.\}
116116
\fB\-\-help\fR,
117117
\fB\-?\fR
118-
.sp
119118
Display a help message and exit\&.
120119
.RE
121120
.sp
@@ -129,7 +128,6 @@ Display a help message and exit\&.
129128
.\}
130129
\fB\-\-charset=\fR\fB\fIdir_name\fR\fR,
131130
\fB\-C \fR\fB\fIdir_name\fR\fR
132-
.sp
133131
The character set directory\&. The default is
134132
\&.\&./sql/share/charsets\&.
135133
.RE
@@ -144,7 +142,6 @@ The character set directory\&. The default is
144142
.\}
145143
\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR,
146144
\fB\-# \fR\fB\fIdebug_options\fR\fR
147-
.sp
148145
Write a debugging log\&. A typical
149146
\fIdebug_options\fR
150147
string is
@@ -162,7 +159,6 @@ d:t:O,/tmp/comp_err\&.trace\&.
162159
.\}
163160
\fB\-\-debug\-info\fR,
164161
\fB\-T\fR
165-
.sp
166162
Print some debugging information when the program exits\&.
167163
.RE
168164
.sp
@@ -176,7 +172,6 @@ Print some debugging information when the program exits\&.
176172
.\}
177173
\fB\-\-errmsg\-file=\fR\fB\fIfile_name\fR\fR,
178174
\fB\-H \fR\fB\fIfile_name\fR\fR
179-
.sp
180175
The name of the error message file\&. The default is
181176
mysqld_errmsg\&.h\&. This option was added in MySQL 8\&.0\&.18\&.
182177
.RE
@@ -191,7 +186,6 @@ mysqld_errmsg\&.h\&. This option was added in MySQL 8\&.0\&.18\&.
191186
.\}
192187
\fB\-\-header\-file=\fR\fB\fIfile_name\fR\fR,
193188
\fB\-H \fR\fB\fIfile_name\fR\fR
194-
.sp
195189
The name of the error header file\&. The default is
196190
mysqld_error\&.h\&.
197191
.RE
@@ -206,7 +200,6 @@ mysqld_error\&.h\&.
206200
.\}
207201
\fB\-\-in\-file=\fR\fB\fIfile_name\fR\fR,
208202
\fB\-F \fR\fB\fIfile_name\fR\fR
209-
.sp
210203
The name of the input file\&. The default is
211204
\&.\&./share/errmsg\-utf8\&.txt\&.
212205
.sp
@@ -227,7 +220,6 @@ options\&.
227220
.\}
228221
\fB\-\-in\-file\-errlog=\fR\fB\fIfile_name\fR\fR,
229222
\fB\-e \fR\fB\fIfile_name\fR\fR
230-
.sp
231223
The name of the input file that defines error messages intended to be written to the error log\&. The default is
232224
\&.\&./share/messages_to_error_log\&.txt\&.
233225
.sp
@@ -244,7 +236,6 @@ This option was added in MySQL 8\&.0\&.19\&.
244236
.\}
245237
\fB\-\-in\-file\-toclient=\fR\fB\fIfile_name\fR\fR,
246238
\fB\-c \fR\fB\fIfile_name\fR\fR
247-
.sp
248239
The name of the input file that defines error messages intended to be written to clients\&. The default is
249240
\&.\&./share/messages_to_clients\&.txt\&.
250241
.sp
@@ -261,7 +252,6 @@ This option was added in MySQL 8\&.0\&.19\&.
261252
.\}
262253
\fB\-\-name\-file=\fR\fB\fIfile_name\fR\fR,
263254
\fB\-N \fR\fB\fIfile_name\fR\fR
264-
.sp
265255
The name of the error name file\&. The default is
266256
mysqld_ername\&.h\&.
267257
.RE
@@ -276,7 +266,6 @@ mysqld_ername\&.h\&.
276266
.\}
277267
\fB\-\-out\-dir=\fR\fB\fIdir_name\fR\fR,
278268
\fB\-D \fR\fB\fIdir_name\fR\fR
279-
.sp
280269
The name of the output base directory\&. The default is
281270
\&.\&./sql/share/\&.
282271
.RE
@@ -291,7 +280,6 @@ The name of the output base directory\&. The default is
291280
.\}
292281
\fB\-\-out\-file=\fR\fB\fIfile_name\fR\fR,
293282
\fB\-O \fR\fB\fIfile_name\fR\fR
294-
.sp
295283
The name of the output file\&. The default is
296284
errmsg\&.sys\&.
297285
.RE
@@ -306,13 +294,12 @@ errmsg\&.sys\&.
306294
.\}
307295
\fB\-\-version\fR,
308296
\fB\-V\fR
309-
.sp
310297
Display version information and exit\&.
311298
.RE
312299
.SH "COPYRIGHT"
313300
.br
314301
.PP
315-
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
302+
Copyright \(co 1997, 2020, Oracle and/or its affiliates.
316303
.PP
317304
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.
318305
.PP

man/ibd2sdi.1

Lines changed: 3 additions & 13 deletions
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: 03/06/2020
5+
.\" Date: 06/01/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBIBD2SDI\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBIBD2SDI\FR" "1" "06/01/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -117,7 +117,6 @@ supports the following options:
117117
.\}
118118
\fB\-\-help\fR,
119119
\fB\-h\fR
120-
.sp
121120
Displays command\-line help\&.
122121
.sp
123122
.if n \{\
@@ -173,7 +172,6 @@ pretty TRUE
173172
.\}
174173
\fB\-\-version\fR,
175174
\fB\-v\fR
176-
.sp
177175
Displays MySQL version information\&.
178176
.sp
179177
.if n \{\
@@ -198,7 +196,6 @@ ibd2sdi Ver 8\&.0\&.3\-dmr for Linux on x86_64 (Source distribution)
198196
.\}
199197
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
200198
\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
201-
.sp
202199
Prints a debug log\&. For debug options, refer to
203200
Section\ \&29.5.4, \(lqThe DBUG Package\(rq\&.
204201
.sp
@@ -228,7 +225,6 @@ built using this option\&.
228225
.\}
229226
\fB\-\-dump\-file=\fR,
230227
\fB\-d\fR
231-
.sp
232228
Dumps serialized dictionary information (SDI) into the specified dump file\&. If a dump file is not specified, the tablespace SDI is dumped to
233229
stdout\&.
234230
.sp
@@ -253,7 +249,6 @@ shell> \fBibd2sdi \-\-dump\-file=\fR\fB\fIfile_name\fR\fR\fB \&.\&./data/test/t1
253249
.\}
254250
\fB\-\-skip\-data\fR,
255251
\fB\-s\fR
256-
.sp
257252
Skips retrieval of
258253
data
259254
field values from the serialized dictionary information (SDI) and only retrieves the
@@ -295,7 +290,6 @@ shell> \fBibd2sdi \-\-skip\-data \&.\&./data/test/t1\&.ibd\fR
295290
.\}
296291
\fB\-\-id=\fR\fB\fI#\fR\fR,
297292
\fB\-i \fR\fB\fI#\fR\fR
298-
.sp
299293
Retrieves serialized dictionary information (SDI) matching the specified table or tablespace object id\&. An object id is unique to the object type\&. Table and tablespace object IDs are also found in the
300294
id
301295
column of the
@@ -354,7 +348,6 @@ shell> \fBibd2sdi \-\-id=7 \&.\&./data/test/t1\&.ibd\fR
354348
.\}
355349
\fB\-\-type=\fR\fB\fI#\fR\fR,
356350
\fB\-t \fR\fB\fI#\fR\fR
357-
.sp
358351
Retrieves serialized dictionary information (SDI) matching the specified object type\&. SDI is provided for table (type=1) and tablespace (type=2) objects\&.
359352
.sp
360353
.if n \{\
@@ -406,7 +399,6 @@ shell> \fBibd2sdi \-\-type=2 \&.\&./data/test/t1\&.ibd\fR
406399
.\}
407400
\fB\-\-strict\-check\fR,
408401
\fB\-c\fR
409-
.sp
410402
Specifies a strict checksum algorithm for validating the checksum of pages that are read\&. Options include
411403
innodb,
412404
crc32, and
@@ -460,7 +452,6 @@ checksums\&.
460452
.\}
461453
\fB\-\-no\-check\fR,
462454
\fB\-n\fR
463-
.sp
464455
Skips checksum validation for pages that are read\&.
465456
.sp
466457
.if n \{\
@@ -484,7 +475,6 @@ shell> \fBibd2sdi \-\-no\-check \&.\&./data/test/t1\&.ibd\fR
484475
.\}
485476
\fB\-\-pretty\fR,
486477
\fB\-p\fR
487-
.sp
488478
Outputs SDI data in JSON pretty print format\&. Enabled by default\&. If disabled, SDI is not human readable but is smaller in size\&. Use
489479
\-\-skip\-pretty
490480
to disable\&.
@@ -502,7 +492,7 @@ shell> \fBibd2sdi \-\-skip\-pretty \&.\&./data/test/t1\&.ibd\fR
502492
.SH "COPYRIGHT"
503493
.br
504494
.PP
505-
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
495+
Copyright \(co 1997, 2020, Oracle and/or its affiliates.
506496
.PP
507497
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.
508498
.PP

man/innochecksum.1

Lines changed: 3 additions & 19 deletions
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: 03/06/2020
5+
.\" Date: 06/01/2020
66
.\" Manual: MySQL Database System
77
.\" Source: MySQL 8.0
88
.\" Language: English
99
.\"
10-
.TH "\FBINNOCHECKSUM\FR" "1" "03/06/2020" "MySQL 8\&.0" "MySQL Database System"
10+
.TH "\FBINNOCHECKSUM\FR" "1" "06/01/2020" "MySQL 8\&.0" "MySQL Database System"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -85,7 +85,6 @@ supports the following options\&. For options that refer to page numbers, the nu
8585
.\}
8686
\fB\-\-help\fR,
8787
\fB\-?\fR
88-
.sp
8988
Displays command line help\&. Example usage:
9089
.sp
9190
.if n \{\
@@ -109,7 +108,6 @@ shell> \fBinnochecksum \-\-help\fR
109108
.\}
110109
\fB\-\-info\fR,
111110
\fB\-I\fR
112-
.sp
113111
Synonym for
114112
\fB\-\-help\fR\&. Displays command line help\&. Example usage:
115113
.sp
@@ -134,7 +132,6 @@ shell> \fBinnochecksum \-\-info\fR
134132
.\}
135133
\fB\-\-version\fR,
136134
\fB\-V\fR
137-
.sp
138135
Displays version information\&. Example usage:
139136
.sp
140137
.if n \{\
@@ -158,7 +155,6 @@ shell> \fBinnochecksum \-\-version\fR
158155
.\}
159156
\fB\-\-verbose\fR,
160157
\fB\-v\fR
161-
.sp
162158
Verbose mode; prints a progress indicator to the log file every five seconds\&. In order for the progress indicator to be printed, the log file must be specified using the
163159
\-\-log option\&. To turn on
164160
verbose
@@ -248,7 +244,6 @@ page 54463 okay: 93\&.722% done
248244
.\}
249245
\fB\-\-count\fR,
250246
\fB\-c\fR
251-
.sp
252247
Print a count of the number of pages in the file and exit\&. Example usage:
253248
.sp
254249
.if n \{\
@@ -272,7 +267,6 @@ shell> \fBinnochecksum \-\-count \&.\&./data/test/tab1\&.ibd\fR
272267
.\}
273268
\fB\-\-start\-page=\fR\fB\fInum\fR\fR,
274269
\fB\-s \fR\fB\fInum\fR\fR
275-
.sp
276270
Start at this page number\&. Example usage:
277271
.sp
278272
.if n \{\
@@ -308,7 +302,6 @@ shell> \fBinnochecksum \-s 600 \&.\&./data/test/tab1\&.ibd\fR
308302
.\}
309303
\fB\-\-end\-page=\fR\fB\fInum\fR\fR,
310304
\fB\-e \fR\fB\fInum\fR\fR
311-
.sp
312305
End at this page number\&. Example usage:
313306
.sp
314307
.if n \{\
@@ -344,7 +337,6 @@ shell> \fBinnochecksum \-\-p 700 \&.\&./data/test/tab1\&.ibd\fR
344337
.\}
345338
\fB\-\-page=\fR\fB\fInum\fR\fR,
346339
\fB\-p \fR\fB\fInum\fR\fR
347-
.sp
348340
Check only this page number\&. Example usage:
349341
.sp
350342
.if n \{\
@@ -368,7 +360,6 @@ shell> \fBinnochecksum \-\-page=701 \&.\&./data/test/tab1\&.ibd\fR
368360
.\}
369361
\fB\-\-strict\-check\fR,
370362
\fB\-C\fR
371-
.sp
372363
Specify a strict checksum algorithm\&. Options include
373364
innodb,
374365
crc32, and
@@ -479,7 +470,6 @@ are allowed\&.
479470
.\}
480471
\fB\-\-no\-check\fR,
481472
\fB\-n\fR
482-
.sp
483473
Ignore the checksum verification when rewriting a checksum\&. This option may only be used with the
484474
\fBinnochecksum\fR
485475
\fB\-\-write\fR
@@ -514,7 +504,6 @@ shell> \fBinnochecksum \-\-no\-check \-\-write innodb \&.\&./data/test/tab1\&.ib
514504
.\}
515505
\fB\-\-allow\-mismatches\fR,
516506
\fB\-a\fR
517-
.sp
518507
The maximum number of checksum mismatches allowed before
519508
\fBinnochecksum\fR
520509
terminates\&. The default setting is 0\&. If
@@ -563,7 +552,6 @@ is set to 1, the checksum tolerates the first mismatch and terminates on the sec
563552
.\}
564553
\fB\-\-write=\fR\fB\fIname\fR\fR,
565554
\fB\-w \fR\fB\fInum\fR\fR
566-
.sp
567555
Rewrite a checksum\&. When rewriting an invalid checksum, the
568556
\fB\-\-no\-check\fR
569557
option must be used together with the
@@ -669,7 +657,6 @@ shell> \fBinnochecksum \-\-no\-check \-\-write crc32 \&.\&./data/test/tab1\&.ibd
669657
.\}
670658
\fB\-\-page\-type\-summary\fR,
671659
\fB\-S\fR
672-
.sp
673660
Display a count of each page type in a tablespace\&. Example usage:
674661
.sp
675662
.if n \{\
@@ -726,7 +713,6 @@ Undo page state: 0 active, 0 cached, 0 to_free, 0 to_purge, 0 prepared, 0 other
726713
.\}
727714
\fB\-\-page\-type\-dump\fR,
728715
\fB\-D\fR
729-
.sp
730716
Dump the page type information for each page in a tablespace to
731717
stderr
732718
or
@@ -753,7 +739,6 @@ shell> \fBinnochecksum \-\-page\-type\-dump=/tmp/a\&.txt \&.\&./data/test/tab1\&
753739
.\}
754740
\fB\-\-log\fR,
755741
\fB\-l\fR
756-
.sp
757742
Log output for the
758743
\fBinnochecksum\fR
759744
tool\&. A log file name must be provided\&. Log output contains checksum values for each tablespace page\&. For uncompressed tables, LSN values are also provided\&. The
@@ -795,7 +780,6 @@ shell> \fBinnochecksum \-l /tmp/log\&.txt \&.\&./data/test/tab1\&.ibd\fR
795780
.\}
796781
\-
797782
option\&.
798-
.sp
799783
Specify the
800784
\-
801785
option to read from standard input\&. If the
@@ -1017,7 +1001,7 @@ cmd> innochecksum\&.exe ibdata3
10171001
.SH "COPYRIGHT"
10181002
.br
10191003
.PP
1020-
Copyright \(co 1997, 2020, Oracle and/or its affiliates. All rights reserved.
1004+
Copyright \(co 1997, 2020, Oracle and/or its affiliates.
10211005
.PP
10221006
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.
10231007
.PP

0 commit comments

Comments
 (0)