[MDEV-31363] innochecksum man page options do not match available options. Created: 2023-05-29  Updated: 2023-10-12  Resolved: 2023-10-12

Status: Closed
Project: MariaDB Server
Component/s: Documentation
Affects Version/s: 10.11.3
Fix Version/s: N/A

Type: Bug Priority: Minor
Reporter: Juan Assignee: Ian Gilfillan
Resolution: Duplicate Votes: 0
Labels: None
Environment:

Rocky Linux 8.6 (Green Obsidian) x86_64
Intel i7-9750H (1) @ 2.653GHz


Issue Links:
Duplicate
duplicates MDEV-20583 innochecksum man pages seem to be inc... Closed

 Description   

For example, the -S option does not appear in the man page, and the -d option appears on the man page & does not work.

~# man innochecksum | grep -v "^$" | head -n 45
INNOCHECKSUM(1)                                                          MariaDB Database System                                                          INNOCHECKSUM(1)
NAME
       innochecksum - offline InnoDB file checksum utility
SYNOPSIS
       innochecksum [options] file_name
DESCRIPTION
       innochecksum prints checksums for InnoDB files. This tool reads an InnoDB tablespace file, calculates the checksum for each page, compares the calculated checksum
       to the stored checksum, and reports mismatches, which indicate damaged pages. It was originally developed to speed up verifying the integrity of tablespace files
       after power outages but can also be used after file copies. Because checksum mismatches will cause InnoDB to deliberately shut down a running server, it can be
       preferable to use this tool rather than waiting for a server in production usage to encounter the damaged pages.
       innochecksum cannot be used on tablespace files that the server already has open. For such files, you should use CHECK TABLE to check tables within the
       tablespace.
       If checksum mismatches are found, you would normally restore the tablespace from backup or start the server and attempt to use mysqldump to make a backup of the
       tables within the tablespace.
       Invoke innochecksum like this:
           shell> innochecksum [options] file_name
       innochecksum supports the following options. For options that refer to page numbers, the numbers are zero-based.
       ·   -?, --help
           Displays help and exits.
       ·   -c, --count
           Print a count of the number of pages in the file.
       ·   -d, --debug
           Debug mode; prints checksums for each page.
       ·   -e num, --end-page=#
           End at this page number.
       ·   -i, --per-page-details
           Print out per-page detail information.
       ·   -I, --info
           Synonym for --help.
       ·   -l, --leaf
           Examine leaf index pages.
       ·   -m num, --merge=#
           Leaf page count if merge given number of consecutive pages.
       ·   -p num, --page-num=#
           Check only this page number.
       ·   -s num, --start-page
           Start at this page number.
       ·   -u, --skip-corrupt
           Skip corrupt pages.
       ·   -v, --verbose
           Verbose mode; print a progress indicator every five seconds.
       ·   -V, --version
           Displays version information and exits.
COPYRIGHT
       Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation
~# innochecksum -Sd /var/lib/mysql/ibdata1
innochecksum: unknown option '-d'
~# innochecksum -?
innochecksum Ver 10.11.3, for Linux (x86_64)
Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
 
InnoDB offline file checksum utility.
Usage: innochecksum [-c] [-s <start page>] [-e <end page>] [-p <page>] [-i] [-v]  [-a <allow mismatches>] [-n] [-S] [-D <page type dump>] [-l <log>] [-l] [-m <merge pages>] <filename or [-]>
See https://mariadb.com/kb/en/library/innochecksum/ for usage hints.
  -?, --help          Displays this help and exits.
  -I, --info          Synonym for --help.
  -V, --version       Displays version information and exits.
  -v, --verbose       Verbose (prints progress every 5 seconds).
  -c, --count         Print the count of pages in the file and exits.
  -s, --start-page=#  Start on this page number (0 based).
  -e, --end-page=#    End at this page number (0 based).
  -p, --page=#        Check only this page (0 based).
  -n, --no-check      Ignore the checksum verification.
  -a, --allow-mismatches=#
                      Maximum checksum mismatch allowed.
  -w, --write         Rewrite the checksum.
  -S, --page-type-summary
                      Display a count of each page type in a tablespace.
  -D, --page-type-dump=name
                      Dump the page type info for each page in a tablespace.
  -i, --per-page-details
                      Print out per-page detail information.
  -l, --log=name      log output.
  -f, --leaf          Examine leaf index pages
  -m, --merge=#       leaf page count if merge given number of consecutive
                      pages
 
Variables (--variable-name=value)
and boolean options {FALSE|TRUE}  Value (after reading options)
--------------------------------- ----------------------------------------
verbose                           FALSE
count                             FALSE
start-page                        0
end-page                          0
page                              0
no-check                          FALSE
allow-mismatches                  0
write                             FALSE
page-type-summary                 FALSE
page-type-dump                    (No default value)
per-page-details                  FALSE
log                               (No default value)
leaf                              FALSE
merge                             0
~#


Generated at Thu Feb 08 10:23:16 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.