MDEV-7680: mysqld_safe and mysql_multi man pages

2 files changed, 137 insertions, 109 deletions

diff --git a/man/mysqld_multi.1 b/man/mysqld_multi.1
index 0476e7e0af6..3f540944c61 100644
--- a/man/mysqld_multi.1
+++ b/man/mysqld_multi.1
@@ -16,7 +16,7 @@
 .\" scripts
 .\" multi mysqld
 .SH "NAME"
-mysqld_multi \- manage multiple MySQL servers
+mysqld_multi \- manage multiple MariaDB servers
 .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
@@ -25,8 +25,7 @@ mysqld_multi \- manage multiple MySQL servers
 \fBmysqld_multi\fR
 is designed to manage several
 \fBmysqld\fR
-processes that listen for connections on different Unix socket files and TCP/IP ports\&. It can start or stop servers, or report their current status\&. The MySQL Instance Manager is an alternative means of managing multiple servers (see
-\fBmysqlmanager\fR(8))\&.
+processes that listen for connections on different Unix socket files and TCP/IP ports\&. It can start or stop servers, or report their current status\&.
 .PP
 \fBmysqld_multi\fR
 searches for groups named
@@ -43,9 +42,7 @@ can be any positive integer\&. This number is referred to in the following discu
 to specify which servers you want to start, stop, or obtain a status report for\&. Options listed in these groups are the same that you would use in the
 [mysqld]
 group used for starting
-\fBmysqld\fR\&. (See, for example,
-Section\ \&2.13.1.2, \(lqStarting and Stopping MySQL Automatically\(rq\&.) However, when using multiple servers, it is necessary that each one use its own value for options such as the Unix socket file and TCP/IP port number\&. For more information on which options must be unique per server in a multiple\-server environment, see
-Section\ \&5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq\&.
+\fBmysqld\fR\&. However, when using multiple servers, it is necessary that each one use its own value for options such as the Unix socket file and TCP/IP port number\&.
 .PP
 To invoke
 \fBmysqld_multi\fR, use the following syntax:
@@ -129,7 +126,6 @@ shell> \fBmysqld_multi \-\-example\fR
 .RE
 .\}
 .PP
-As of MySQL 5\&.1\&.18,
 \fBmysqld_multi\fR
 searches for option files as follows:
 .sp
@@ -176,16 +172,6 @@ Otherwise, option files in the standard list of locations are read, including an
 option, if one is given\&. (If the option is given multiple times, the last value is used\&.)
 .RE
 .PP
-Before MySQL 5\&.1\&.18, the preceding options are not recognized\&. Files in the standard locations are read, and any file named by the
-\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR
-option, if one is given\&. A file named by
-\fB\-\-config\-file\fR
-is read only for
-[mysqld\fIN\fR]
-option groups, not the
-[mysqld_multi]
-group\&.
-.PP
 Option files read are searched for
 [mysqld_multi]
 and
@@ -200,7 +186,7 @@ groups can be used for options passed to specific
 \fBmysqld\fR
 instances\&.
 .PP
-As of MySQL 5\&.1\&.35, the
+The
 [mysqld]
 or
 [mysqld_safe]
@@ -213,11 +199,7 @@ option to use a different configuration file for that instance, in which case th
 [mysqld]
 or
 [mysqld_safe]
-groups from that file will be used for that instance\&. Before MySQL 5\&.1\&.35, some versions of
-\fBmysqld_multi\fR
-pass the
-\fB\-\-no\-defaults\fR
-options to instances, so these techniques are inapplicable\&.
+groups from that file will be used for that instance\&.
 .PP
 \fBmysqld_multi\fR
 supports the following options\&.
@@ -245,38 +227,6 @@ Display a help message and exit\&.
 .sp -1
 .IP \(bu 2.3
 .\}
-.\" mysqld_multi: config-file option
-.\" config-file option: mysqld_multi
-\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR
-.sp
-As of MySQL 5\&.1\&.18, this option is deprecated\&. If given, it is treated the same way as
-\fB\-\-defaults\-extra\-file\fR, described earlier\&.
-\fB\-\-config\-file\fR
-is removed in MySQL 5\&.5\&.
-.sp
-Before MySQL 5\&.1\&.18, this option specifies the name of an extra option file\&. It affects where
-\fBmysqld_multi\fR
-looks for
-[mysqld\fIN\fR]
-option groups\&. Without this option, all options are read from the usual
-my\&.cnf
-file\&. The option does not affect where
-\fBmysqld_multi\fR
-reads its own options, which are always taken from the
-[mysqld_multi]
-group in the usual
-my\&.cnf
-file\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
 .\" mysqld_multi: example option
 .\" example option: mysqld_multi
 \fB\-\-example\fR
@@ -387,8 +337,8 @@ rather than to the log file\&. By default, output goes to the log file\&.
 .\" password option: mysqld_multi
 \fB\-\-password=\fR\fB\fIpassword\fR\fR
 .sp
-The password of the MySQL account to use when invoking
-\fBmysqladmin\fR\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&.
+The password of the MariaDB account to use when invoking
+\fBmysqladmin\fR\&. Note that the password value is not optional for this option, unlike for other MariaDB programs\&.
 .RE
 .sp
 .RS 4
@@ -418,11 +368,10 @@ Silent mode; disable warnings\&.
 .\" tcp-ip option: mysqld_multi
 \fB\-\-tcp\-ip\fR
 .sp
-Connect to each MySQL server via the TCP/IP port instead of the Unix socket file\&. (If a socket file is missing, the server might still be running, but accessible only via the TCP/IP port\&.) By default, connections are made using the Unix socket file\&. This option affects
-stop
-and
-report
-operations\&.
+Connect to the MariaDB server(s) via the TCP/IP port instead of the UNIX socket\&. This affects stopping 
+and reporting. If a socket file is missing, the server may still be running, but can be accessed only 
+via the TCP/IP port\&. By default connecting is done via the UNIX socket\&. This option affects
+stop and report operations\&.
 .RE
 .sp
 .RS 4
@@ -437,7 +386,7 @@ operations\&.
 .\" user option: mysqld_multi
 \fB\-\-user=\fR\fB\fIuser_name\fR\fR
 .sp
-The user name of the MySQL account to use when invoking
+The user name of the MariaDB account to use when invoking
 \fBmysqladmin\fR\&.
 .RE
 .sp
@@ -496,8 +445,9 @@ servers with the same data directory\&. Use separate data directories, unless yo
 \fIknow\fR
 what you are doing\&. Starting multiple servers with the same data directory does
 \fInot\fR
-give you extra performance in a threaded system\&. See
-Section\ \&5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq\&.
+give you extra performance in a threaded system\&.
+.sp .5v
+.RE
 .RE
 .sp
 .RS 4
@@ -508,19 +458,7 @@ Section\ \&5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq\&.
 .sp -1
 .IP \(bu 2.3
 .\}
-.if n \{\
-.sp
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBImportant\fR
-.ps -1
-.br
-Make sure that the data directory for each server is fully accessible to the Unix account that the specific
+\fBImportant\fR: Make sure that the data directory for each server is fully accessible to the Unix account that the specific
 \fBmysqld\fR
 process is started as\&.
 \fIDo not\fR
@@ -528,8 +466,7 @@ use the Unix
 \fIroot\fR
 account for this, unless you
 \fIknow\fR
-what you are doing\&. See
-Section\ \&5.3.6, \(lqHow to Run MySQL as a Normal User\(rq\&.
+what you are doing\&.
 .sp .5v
 .RE
 .RE
@@ -542,7 +479,7 @@ Section\ \&5.3.6, \(lqHow to Run MySQL as a Normal User\(rq\&.
 .sp -1
 .IP \(bu 2.3
 .\}
-Make sure that the MySQL account used for stopping the
+Make sure that the MariaDB account used for stopping the
 \fBmysqld\fR
 servers (with the
 \fBmysqladmin\fR
@@ -565,10 +502,7 @@ mysql> \fBGRANT SHUTDOWN ON *\&.*\fR
 .RE
 .\}
 .sp
-See
-Section\ \&5.4, \(lqThe MySQL Access Privilege System\(rq\&. You have to do this for each
-\fBmysqld\fR
-server\&. Change the connection parameters appropriately when connecting to each one\&. Note that the host name part of the account name must allow you to connect as
+Change the connection parameters appropriately when connecting to each one\&. Note that the host name part of the account name must allow you to connect as
 multi_admin
 from the host where you want to run
 \fBmysqld_multi\fR\&.
@@ -716,8 +650,6 @@ user       = jani
 .RE
 .\}
 .PP
-See
-Section\ \&4.2.3.3, \(lqUsing Option Files\(rq\&.
 .SH "COPYRIGHT"
 .br
 .PP
diff --git a/man/mysqld_safe.1 b/man/mysqld_safe.1
index 08ea7ed54e9..fe89c4e2aad 100644
--- a/man/mysqld_safe.1
+++ b/man/mysqld_safe.1
@@ -15,7 +15,7 @@
 .\" tools: mysqld_safe
 .\" scripts
 .SH "NAME"
-mysqld_safe \- MySQL server startup script
+mysqld_safe \- MariaDB server startup script
 .SH "SYNOPSIS"
 .HP \w'\fBmysqld_safe\ \fR\fB\fIoptions\fR\fR\ 'u
 \fBmysqld_safe \fR\fB\fIoptions\fR\fR
@@ -145,6 +145,21 @@ should be able to create\&. The option value is passed to
 .sp -1
 .IP \(bu 2.3
 .\}
+.\" mysqld_safe: crash-script option
+.\" crash-script option: mysqld_safe
+\fB\-\-crash\-script=\fR\fB\fIfile\fR\fR
+.sp
+Script to call in the event of mysqld crashing\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 .\" mysqld_safe: datadir option
 .\" datadir option: mysqld_safe
 \fB\-\-datadir=\fR\fB\fIpath\fR\fR
@@ -190,6 +205,21 @@ The name of an option file to be read instead of the usual option files\&. This
 .sp -1
 .IP \(bu 2.3
 .\}
+.\" mysqld_safe: flush-caches option
+.\" flush-caches option: mysqld_safe
+\fB\-\-flush\-caches\fR
+.sp
+Flush and purge buffers/caches before starting the server\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 .\" mysqld_safe: ledir option
 .\" ledir option: mysqld_safe
 \fB\-\-ledir=\fR\fB\fIpath\fR\fR
@@ -211,8 +241,22 @@ cannot find the server, use this option to indicate the path name to the directo
 .\" log-error option: mysqld_safe
 \fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR
 .sp
-Write the error log to the given file\&. See
-Section\ \&5.2.2, \(lqThe Error Log\(rq\&.
+Write the error log to the given file\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mysqld_safe: malloc-lib option
+.\" malloc-lib option: mysqld_safe
+\fB\-\-malloc\-lib=\fR\fB\fIlib\fR\fR
+.sp
+Preload shared library lib if available\&.
 .RE
 .sp
 .RS 4
@@ -294,6 +338,21 @@ program to set the server\'s scheduling priority to the given value\&.
 .sp -1
 .IP \(bu 2.3
 .\}
+.\" mysqld_safe: no-auto-restart option
+.\" no-auto-restart option: mysqld_safe
+\fB\-\-no\-auto\-restart\fR
+.sp
+Exit after starting mysqld\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 .\" mysqld_safe: no-defaults option
 .\" no-defaults option: mysqld_safe
 \fB\-\-no\-defaults\fR
@@ -309,6 +368,36 @@ Do not read any option files\&. This must be the first option on the command lin
 .sp -1
 .IP \(bu 2.3
 .\}
+.\" mysqld_safe: no-watch option
+.\" no-watch option: mysqld_safe
+\fB\-\-no\-auto\-restart\fR
+.sp
+Exit after starting mysqld\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" mysqld_safe: numa-interleave option
+.\" numa-interleave option: mysqld_safe
+\fB\-\-numa\-interleave\fR
+.sp
+Run mysqld with its memory interleaved on all NUMA nodes\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 .\" mysqld_safe: open-files-limit option
 .\" open-files-limit option: mysqld_safe
 \fB\-\-open\-files\-limit=\fR\fB\fIcount\fR\fR
@@ -346,6 +435,21 @@ The path name of the process ID file\&.
 .sp -1
 .IP \(bu 2.3
 .\}
+.\" mysqld_safe: plugin-dir option
+.\" plugin-dir option: mysqld_safe
+\fB\-\-plugin\-dir=\fIdir_name\fR
+.sp
+Directory for client-side plugins\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 .\" mysqld_safe: port option
 .\" port option: mysqld_safe
 \fB\-\-port=\fR\fB\fIport_num\fR\fR
@@ -437,7 +541,7 @@ mysqld, respectively\&. To specify a suffix for the tag, use
 \fB\-\-syslog\-tag=\fR\fB\fItag\fR\fR, which modifies the tags to be
 mysqld_safe\-\fItag\fR
 and
-mysqld\-\fItag\fR\&. This option was added in MySQL 5\&.1\&.21\&.
+mysqld\-\fItag\fR\&.
 .RE
 .sp
 .RS 4
@@ -475,7 +579,7 @@ server as the user having the name
 \fIuser_name\fR
 or the numeric user ID
 \fIuser_id\fR\&. (\(lqUser\(rq
-in this context refers to a system login account, not a MySQL user listed in the grant tables\&.)
+in this context refers to a system login account, not a MariaDB user listed in the grant tables\&.)
 .RE
 .PP
 If you execute
@@ -510,8 +614,7 @@ mysql> \fBmysqld_safe \-\-defaults\-file=\fR\fB\fIfile_name\fR\fR\fB \-\-port=\f
 .PP
 The
 \fBmysqld_safe\fR
-script is written so that it normally can start a server that was installed from either a source or a binary distribution of MySQL, even though these types of distributions typically install the server in slightly different locations\&. (See
-Section\ \&2.1.5, \(lqInstallation Layouts\(rq\&.)
+script is written so that it normally can start a server that was installed from either a source or a binary distribution of MariaDB, even though these types of distributions typically install the server in slightly different locations\&.
 \fBmysqld_safe\fR
 expects one of the following conditions to be true:
 .sp
@@ -537,7 +640,7 @@ and
 var
 directories\&. This condition should be met if you execute
 \fBmysqld_safe\fR
-from your MySQL installation directory (for example,
+from your MariaDB installation directory (for example,
 /usr/local/mysql
 for a binary distribution)\&.
 .RE
@@ -555,14 +658,14 @@ If the server and databases cannot be found relative to the working directory,
 attempts to locate them by absolute path names\&. Typical locations are
 /usr/local/libexec
 and
-/usr/local/var\&. The actual locations are determined from the values configured into the distribution at the time it was built\&. They should be correct if MySQL is installed in the location specified at configuration time\&.
+/usr/local/var\&. The actual locations are determined from the values configured into the distribution at the time it was built\&. They should be correct if MariaDB is installed in the location specified at configuration time\&.
 .RE
 .PP
 Because
 \fBmysqld_safe\fR
-tries to find the server and databases relative to its own working directory, you can install a binary distribution of MySQL anywhere, as long as you run
+tries to find the server and databases relative to its own working directory, you can install a binary distribution of MariaDB anywhere, as long as you run
 \fBmysqld_safe\fR
-from the MySQL installation directory:
+from the MariaDB installation directory:
 .sp
 .if n \{\
 .RS 4
@@ -577,7 +680,7 @@ shell> \fBbin/mysqld_safe &\fR
 .PP
 If
 \fBmysqld_safe\fR
-fails, even when invoked from the MySQL installation directory, you can specify the
+fails, even when invoked from the MariaDB installation directory, you can specify the
 \fB\-\-ledir\fR
 and
 \fB\-\-datadir\fR
@@ -592,7 +695,7 @@ arranges for error (and notice) messages from itself and from
 \fBmysqld\fR
 to go to the same destination\&.
 .PP
-As of MySQL 5\&.1\&.20, there are several
+There are several
 \fBmysqld_safe\fR
 options for controlling the destination of these messages:
 .sp
@@ -652,9 +755,6 @@ If none of these options is given, the default is
 .ps -1
 .br
 .PP
-In MySQL 5\&.1\&.20
-\fIonly\fR, the default is
-\fB\-\-syslog\fR\&. This differs from logging behavior for other versions of MySQL, for which the default is to write messages to the default error log file\&.
 .sp .5v
 .RE
 .PP
@@ -673,10 +773,6 @@ or the error log file) and
 stdout\&. Errors go to the logging destination and
 stderr\&.
 .PP
-Before MySQL 5\&.1\&.20, error logging is controlled only with the
-\fB\-\-log\-error\fR
-option\&. If it is given, messages go to the named error file\&. Otherwise, messages go to the default error file\&.
-.PP
 Normally, you should not edit the
 \fBmysqld_safe\fR
 script\&. Instead, configure
@@ -689,7 +785,7 @@ option file\&. In rare cases, it might be necessary to edit
 \fBmysqld_safe\fR
 to get it to start the server properly\&. However, if you do this, your modified version of
 \fBmysqld_safe\fR
-might be overwritten if you upgrade MySQL in the future, so you should make a copy of your edited version that you can reinstall\&.
+might be overwritten if you upgrade MariaDB in the future, so you should make a copy of your edited version that you can reinstall\&.
 .PP
 On NetWare,
 \fBmysqld_safe\fR
@@ -727,7 +823,7 @@ tables\&.
 .sp -1
 .IP "  3." 4.2
 .\}
-Provides a screen presence for the MySQL server\&.
+Provides a screen presence for the MariaDB server\&.
 .RE
 .sp
 .RS 4