Skip to content

Commit

Permalink
Update innochecksum man page
Browse files Browse the repository at this point in the history
  • Loading branch information
iangilfillan authored and grooverdan committed Oct 12, 2023
1 parent 4045ead commit 358209d
Showing 1 changed file with 85 additions and 7 deletions.
92 changes: 85 additions & 7 deletions man/innochecksum.1
Expand Up @@ -34,7 +34,7 @@ CHECK TABLE
to check tables within the tablespace\&.
.PP
If checksum mismatches are found, you would normally restore the tablespace from backup or start the server and attempt to use
\fBmysqldump\fR
\fBmariadb-dump\fR
to make a backup of the tables within the tablespace\&.
.PP
Invoke
Expand Down Expand Up @@ -75,9 +75,9 @@ Displays help and exits\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-c, --count\fR
\fB\-a \fR\fB\fInum\fB, --allow-mismatches=#\fR
.sp
Print a count of the number of pages in the file\&.
Maximum checksum mismatch allowed before innochecksum terminates. Defaults to 0, which terminates on the first mismatch\&.
.RE
.sp
.RS 4
Expand All @@ -88,9 +88,9 @@ Print a count of the number of pages in the file\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-d, --debug\fR
\fB\-c, --count\fR
.sp
Debug mode; prints checksums for each page\&.
Print a count of the number of pages in the file\&.
.RE
.sp
.RS 4
Expand Down Expand Up @@ -140,7 +140,7 @@ Synonym for \fB--help\fR\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-l, --leaf\fR
\fB\-f, --leaf\fR
.sp
Examine leaf index pages\&.
.RE
Expand All @@ -153,6 +153,19 @@ Examine leaf index pages\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-l \fR\fB\fIfn\fB, --log=fn\fR\fR
.sp
Log output to the specified filename, fn\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-m \fR\fB\fInum\fB, --merge=#\fR\fR
.sp
Leaf page count if merge given number of consecutive pages\&.
Expand All @@ -166,6 +179,19 @@ Leaf page count if merge given number of consecutive pages\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-n, --no-check\fR\fR
.sp
Ignore the checksum verification. Until MariaDB 10.6, must be used with the --write option\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-p \fR\fB\fInum\fB, --page-num=#\fR\fR
.sp
Check only this page number\&.
Expand All @@ -179,6 +205,32 @@ Check only this page number\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-D \fR\fB\fIname\fB, --page-type-dump=name\fR\fR
.sp
Dump the page type info for each page in a tablespace\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-S, --page-type-summary\fR\fR
.sp
Display a count of each page type in a tablespace\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-s \fR\fB\fInum\fB, --start-page\fR\fR
.sp
Start at this page number\&.
Expand All @@ -205,6 +257,32 @@ Skip corrupt pages\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-C \fR\fB\fIname\fB, --strict-check=name\fR\fR
.sp
Specify the strict checksum algorithm. One of: crc32, innodb, none. If not specified, validates against innodb, crc32 and none. Removed in MariaDB 10.6\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-w \fR\fB\fIname\fB, --write=name\fR\fR
.sp
Rewrite the checksum algorithm. One of crc32, innodb, none. An exclusive lock is obtained during use. Use in conjunction with the -no-check option to rewrite an invalid checksum. Removed in MariaDB 10.6\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-v, --verbose\fR
.sp
Verbose mode; print a progress indicator every five seconds\&.
Expand All @@ -225,7 +303,7 @@ Displays version information and exits\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2015 MariaDB Foundation
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2023 MariaDB Foundation
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
Expand Down

0 comments on commit 358209d

Please sign in to comment.