Skip to content

Commit

Permalink
MDEV-22023 Update man page NAME section to say MariaDB instead of MySQL
Browse files Browse the repository at this point in the history
Continue the effort of a previous commit (PR#2114) which changed the man
pages titles from MariaDB to MySQL, to further update the man pages.

Update the man page NAME sections to use mariadb-* instead of mysql* for
MariaDB binaries that are drop-in replacements for MySQL equivalents,
indicating that the commands are actually of the MariaDB version.

Before:
    NAME
        mysql_upgrade - check tables for MariaDB upgrade
    ...

After:
    NAME
        mariadb-upgrade - check tables for MariaDB upgrade (mysql_upgrade
        is now a symlink to mariadb-upgrade)
    ...

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.
  • Loading branch information
PhysicsTing authored and grooverdan committed Jun 8, 2022
1 parent e8b0894 commit 4145618
Show file tree
Hide file tree
Showing 28 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion man/mysql.1
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
.\" SQL scripts
.\" batch SQL files
.SH "NAME"
mysql \- the MariaDB command\-line tool
mariadb \- the MariaDB command\-line tool (mysql is now a symlink to mariadb)
.SH "SYNOPSIS"
.HP \w'\fBmysql\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIdb_name\fR\fR\ 'u
\fBmysql [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR
Expand Down
4 changes: 2 additions & 2 deletions man/mysql_client_test.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
.\" mysql_client_test
.\" mysql_client_test_embedded
.SH "NAME"
mysql_client_test \- test client API
mariadb-client-test \- test client API (mysql_client_test is now a symlink to mariadb-client-test)
.br
mysql_client_test_embedded \- test client API for embedded server
mariadb-client-test-embedded \- test client API for embedded server (mysql_client_test_embedded is now a symlink to mariadb-client-test-embedded)
.SH "SYNOPSIS"
.HP \w'\fBmysql_client_test\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fItest_name\fR\fR\fB]\ \&.\&.\&.\fR\ 'u
\fBmysql_client_test [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] \&.\&.\&.\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_convert_table_format.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysql_convert_table_format
.SH "NAME"
mysql_convert_table_format \- convert tables to use a given storage engine
mariadb-convert-table-format \- convert tables to use a given storage engine (mysql_convert_table_format is now a symlink to mariadb-convert-table-format)
.SH "SYNOPSIS"
.HP \w'\fBmysql_convert_table_format\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIdb_name\fR\fR\ 'u
\fBmysql_convert_table_format [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_find_rows.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysql_find_rows
.SH "NAME"
mysql_find_rows \- extract SQL statements from files
mariadb-find-rows \- extract SQL statements from files (mysql_find_rows is now a symlink to mariadb-find-rows)
.SH "SYNOPSIS"
.HP \w'\fBmysql_find_rows\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIfile_name\fR\fR\fB\ \&.\&.\&.]\fR\ 'u
\fBmysql_find_rows [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIfile_name\fR\fR\fB \&.\&.\&.]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_fix_extensions.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysql_fix_extensions
.SH "NAME"
mysql_fix_extensions \- normalize table file name extensions
mariadb-fix-extensions \- normalize table file name extensions (mysql_fix_extensions is now a symlink to mariadb-fix-extensions)
.SH "SYNOPSIS"
.HP \w'\fBmysql_fix_extensions\ \fR\fB\fIdata_dir\fR\fR\ 'u
\fBmysql_fix_extensions \fR\fB\fIdata_dir\fR\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_install_db.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysql_install_db
.SH "NAME"
mysql_install_db \- initialize MariaDB data directory
mariadb-install-db \- initialize MariaDB data directory (mysql_install_db is now a symlink to mariadb-install-db)
.SH "SYNOPSIS"
.HP \w'\fBmysql_install_db\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBmysql_install_db [\fR\fB\fIoptions\fR\fR\fB]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_ldb.1
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
.\" disable justification (adjust text to left margin only)
.ad l
.SH NAME
mysql_ldb \- RocksDB tool
mariadb-ldb \- RocksDB tool (mysql_ldb is now a symlink to mariadb-ldb)
.SH DESCRIPTION
Use \fBmysql_ldb \-\-help\fR for details on usage\.
.PP
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_plugin.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
.\" -----------------------------------------------------------------
.\" mysql_plugin
.SH "NAME"
mysql_plugin \- configure MariaDB server plugins
mariadb-plugin \- configure MariaDB server plugins (mysql_plugin is now a symlink to mariadb-plugin)
.SH "SYNOPSIS"
.HP \w'\fBmysql_plugin\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIplugin\fR\fR\fB\ {ENABLE|DISABLE}\fR\ 'u
\fBmysql_plugin [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIplugin\fR\fR\fB {ENABLE|DISABLE}\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_secure_installation.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysql_secure_installation
.SH "NAME"
mysql_secure_installation \- improve MariaDB installation security
mariadb-secure-installation \- improve MariaDB installation security (mysql_secure_installation is now a symlink to mariadb-secure-installation)
.SH "SYNOPSIS"
.HP \w'\fBmysql_secure_installation\fR\ 'u
\fBmysql_secure_installation\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_setpermission.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysql_setpermission
.SH "NAME"
mysql_setpermission \- interactively set permissions in grant tables
mariadb-setpermission \- interactively set permissions in grant tables (mysql_setpermission is now a symlink to mariadb-setpermission)
.SH "SYNOPSIS"
.HP \w'\fBmysql_setpermission\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBmysql_setpermission [\fR\fB\fIoptions\fR\fR\fB]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_tzinfo_to_sql.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
.\" mysql_tzinfo_to_sql
.\" time zone tables
.SH "NAME"
mysql_tzinfo_to_sql \- load the time zone tables
mariadb-tzinfo-to-sql \- load the time zone tables (mysql_tzinfo_to_sql is now a symlink to mariadb-tzinfo-to-sql)
.SH "SYNOPSIS"
.HP \w'\fBmysql_tzinfo_to_sql\ \fR\fB\fIarguments\fR\fR\ 'u
\fBmysql_tzinfo_to_sql \fR\fB\fIarguments\fR\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_upgrade.1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
.\" upgrading MySQL
.\" MySQL: upgrading
.SH "NAME"
mysql_upgrade \- check tables for MariaDB upgrade
mariadb-upgrade \- check tables for MariaDB upgrade (mysql_upgrade is now a symlink to mariadb-upgrade)
.SH "SYNOPSIS"
.HP \w'\fBmysql_upgrade\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBmysql_upgrade [\fR\fB\fIoptions\fR\fR\fB]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_waitpid.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysql_waitpid
.SH "NAME"
mysql_waitpid \- kill process and wait for its termination
mariadb-waitpid \- kill process and wait for its termination (mysql_waitpid is now a symlink to mariadb-waitpid)
.SH "SYNOPSIS"
.HP \w'\fBmysql_waitpid\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIpid\fR\fR\fB\ \fR\fB\fIwait_time\fR\fR\ 'u
\fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlaccess.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysqlaccess
.SH "NAME"
mysqlaccess \- client for checking access privileges
mariadb-access \- client for checking access privileges (mysqlaccess is now a symlink to mariadb-access)
.SH "SYNOPSIS"
.HP \w'\fBmysqlaccess\ [\fR\fB\fIhost_name\fR\fR\fB\ [\fR\fB\fIuser_name\fR\fR\fB\ [\fR\fB\fIdb_name\fR\fR\fB]]]\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBmysqlaccess [\fR\fB\fIhost_name\fR\fR\fB [\fR\fB\fIuser_name\fR\fR\fB [\fR\fB\fIdb_name\fR\fR\fB]]] [\fR\fB\fIoptions\fR\fR\fB]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqladmin.1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
.\" administration: server
.\" server administration
.SH "NAME"
mysqladmin \- client for administering a MariaDB server
mariadb-admin \- client for administering a MariaDB server (mysqladmin is now a symlink to mariadb-admin)
.SH "SYNOPSIS"
.HP \w'\fBmysqladmin\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIcommand\fR\fR\fB\ [\fR\fB\fIcommand\-arg\fR\fR\fB]\ [\fR\fB\fIcommand\fR\fR\fB\ [\fR\fB\fIcommand\-arg\fR\fR\fB]]\ \&.\&.\&.\fR\ 'u
\fBmysqladmin [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB] [\fR\fB\fIcommand\fR\fR\fB [\fR\fB\fIcommand\-arg\fR\fR\fB]] \&.\&.\&.\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlbinlog.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysqlbinlog
.SH "NAME"
mysqlbinlog \- utility for processing binary log files
mariadb-binlog \- utility for processing binary log files (mysqlbinlog is now a symlink to mariadb-binlog)
.SH "SYNOPSIS"
.HP \w'\fBmysqlbinlog\ [\fR\fBoptions\fR\fB]\ \fR\fB\fIlog_file\fR\fR\fB\ \&.\&.\&.\fR\ 'u
\fBmysqlbinlog [\fR\fBoptions\fR\fB] \fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlcheck.1
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.\" tables: maintenance
.\" tables: repair
.SH "NAME"
mysqlcheck \- a table maintenance program
mariadb-check \- a table maintenance program (mysqlcheck is now a symlink to mariadb-check)
.SH "SYNOPSIS"
.HP \w'\fBmysqlcheck\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ \&.\&.\&.]]\fR\ 'u
\fBmysqlcheck [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.]]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqld.8
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
.\" mysqld: MariaDB server
.\" MariaDB server: mysqld
.SH "NAME"
mysqld \- the MariaDB server
mariadbd \- the MariaDB server (mysqld is now a symlink to mariadbd)
.SH "SYNOPSIS"
.HP \w'\fBmysqld\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBmysqld [\fR\fB\fIoptions\fR\fR\fB]\fR
Expand Down
4 changes: 2 additions & 2 deletions man/mysqld_multi.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMARIADB-MULTI\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADBD-MULTI\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand All @@ -16,7 +16,7 @@
.\" scripts
.\" multi mysqld
.SH "NAME"
mysqld_multi \- manage multiple MariaDB servers
mariadbd-multi \- manage multiple MariaDB servers (mysqld_multi is now a symlink to mariadbd-multi)
.SH "SYNOPSIS"
.HP \w'\fBmysqld_multi\ [\fR\fB\fIoptions\fR\fR\fB]\ {start|stop|report}\ [\fR\fB\fIGNR\fR\fR\fB[,\fR\fB\fIGNR\fR\fR\fB]\ \&.\&.\&.]\fR\ 'u
\fBmysqld_multi [\fR\fB\fIoptions\fR\fR\fB] {start|stop|report} [\fR\fB\fIGNR\fR\fR\fB[,\fR\fB\fIGNR\fR\fR\fB] \&.\&.\&.]\fR
Expand Down
4 changes: 2 additions & 2 deletions man/mysqld_safe.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMARIADB-SAFE\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADBD-SAFE\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand All @@ -15,7 +15,7 @@
.\" tools: mysqld_safe
.\" scripts
.SH "NAME"
mysqld_safe \- MariaDB server startup script
mariadbd-safe \- MariaDB server startup script (mysqld_safe is now a symlink to mariadbd-safe)
.SH "SYNOPSIS"
.HP \w'\fBmysqld_safe\ \fR\fB\fIoptions\fR\fR\ 'u
\fBmysqld_safe \fR\fB\fIoptions\fR\fR
Expand Down
4 changes: 2 additions & 2 deletions man/mysqld_safe_helper.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMARIADB-SAFE-HELPER\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADBD-SAFE-HELPER\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand All @@ -9,7 +9,7 @@
.\" disable justification (adjust text to left margin only)
.ad l
.SH NAME
mysqld_safe_helper \- helper script
mariadbd-safe-helper \- helper script (mysqld_safe_helper is now a symlink to mariadbd-safe-helper)
.SH DESCRIPTION
Use: Helper script\.
.PP
Expand Down
2 changes: 1 addition & 1 deletion man/mysqldump.1
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.\" databases: dumping
.\" tables: dumping
.SH "NAME"
mysqldump \- a database backup program
mariadb-dump \- a database backup program (mysqldump is now a symlink to mariadb-dump)
.SH "SYNOPSIS"
.HP \w'\fBmysqldump\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ \&.\&.\&.]]\fR\ 'u
\fBmysqldump [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.]]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqldumpslow.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
.\" -----------------------------------------------------------------
.\" mysqldumpslow
.SH "NAME"
mysqldumpslow \- Summarize slow query log files
mariadb-dumpslow \- Summarize slow query log files (mysqldumpslow is now a symlink to mariadb-dumpslow)
.SH "SYNOPSIS"
.HP \w'\fBmysqldumpslow\ [\fR\fBoptions\fR\fB]\ [\fR\fB\fIlog_file\fR\fR\fB\ \&.\&.\&.]\fR\ 'u
\fBmysqldumpslow [\fR\fBoptions\fR\fB] [\fR\fB\fIlog_file\fR\fR\fB \&.\&.\&.]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlhotcopy.1
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.\" databases: dumping
.\" tables: dumping
.SH "NAME"
mysqlhotcopy \- a database backup program
mariadb-hotcopy \- a database backup program (mysqlhotcopy is now a symlink to mariadb-hotcopy)
.SH "SYNOPSIS"
.HP \w'\fBmysqlhotcopy\ \fR\fB\fIarguments\fR\fR\ 'u
\fBmysqlhotcopy \fR\fB\fIarguments\fR\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlimport.1
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.\" files: text
.\" text files: importing
.SH "NAME"
mysqlimport \- a data import program
mariadb-import \- a data import program (mysqlimport is now a symlink to mariadb-import)
.SH "SYNOPSIS"
.HP \w'\fBmysqlimport\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIdb_name\fR\fR\fB\ \fR\fB\fItextfile1\fR\fR\fB\ \&.\&.\&.\fR\ 'u
\fBmysqlimport [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB \fR\fB\fItextfile1\fR\fR\fB \&.\&.\&.\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlshow.1
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
.\" columns: displaying
.\" showing: database information
.SH "NAME"
mysqlshow \- display database, table, and column information
mariadb-show \- display database, table, and column information (mysqlshow is now a symlink to mariadb-show)
.SH "SYNOPSIS"
.HP \w'\fBmysqlshow\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ [\fR\fB\fIcol_name\fR\fR\fB]]]\fR\ 'u
\fBmysqlshow [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB [\fR\fB\fIcol_name\fR\fR\fB]]]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlslap.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
.\" mysqlslap
.\" load emulation
.SH "NAME"
mysqlslap \- load emulation client
mariadb-slap \- load emulation client (mysqlslap is now a symlink to mariadb-slap)
.SH "SYNOPSIS"
.HP \w'\fBmysqlslap\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR
Expand Down
2 changes: 1 addition & 1 deletion man/mysqltest.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
.\" mysqltest
.\" mysqltest_embedded
.SH "NAME"
mysqltest \- program to run test cases
mariadb-test \- program to run test cases (mysqltest is now a symlink to mariadb-test)
.br
mysqltest_embedded \- program to run embedded test cases
.SH "SYNOPSIS"
Expand Down

0 comments on commit 4145618

Please sign in to comment.