Skip to content

Commit ed195b2

Browse files
iangilfillanvuvova
authored andcommitted
MDEV-7680: mysqld_safe and mysql_multi man pages
1 parent 5077509 commit ed195b2

File tree

2 files changed

+137
-109
lines changed

2 files changed

+137
-109
lines changed

man/mysqld_multi.1

Lines changed: 19 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
.\" scripts
1717
.\" multi mysqld
1818
.SH "NAME"
19-
mysqld_multi \- manage multiple MySQL servers
19+
mysqld_multi \- manage multiple MariaDB servers
2020
.SH "SYNOPSIS"
2121
.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
2222
\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
2525
\fBmysqld_multi\fR
2626
is designed to manage several
2727
\fBmysqld\fR
28-
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
29-
\fBmysqlmanager\fR(8))\&.
28+
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\&.
3029
.PP
3130
\fBmysqld_multi\fR
3231
searches for groups named
@@ -43,9 +42,7 @@ can be any positive integer\&. This number is referred to in the following discu
4342
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
4443
[mysqld]
4544
group used for starting
46-
\fBmysqld\fR\&. (See, for example,
47-
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
48-
Section\ \&5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq\&.
45+
\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\&.
4946
.PP
5047
To invoke
5148
\fBmysqld_multi\fR, use the following syntax:
@@ -129,7 +126,6 @@ shell> \fBmysqld_multi \-\-example\fR
129126
.RE
130127
.\}
131128
.PP
132-
As of MySQL 5\&.1\&.18,
133129
\fBmysqld_multi\fR
134130
searches for option files as follows:
135131
.sp
@@ -176,16 +172,6 @@ Otherwise, option files in the standard list of locations are read, including an
176172
option, if one is given\&. (If the option is given multiple times, the last value is used\&.)
177173
.RE
178174
.PP
179-
Before MySQL 5\&.1\&.18, the preceding options are not recognized\&. Files in the standard locations are read, and any file named by the
180-
\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR
181-
option, if one is given\&. A file named by
182-
\fB\-\-config\-file\fR
183-
is read only for
184-
[mysqld\fIN\fR]
185-
option groups, not the
186-
[mysqld_multi]
187-
group\&.
188-
.PP
189175
Option files read are searched for
190176
[mysqld_multi]
191177
and
@@ -200,7 +186,7 @@ groups can be used for options passed to specific
200186
\fBmysqld\fR
201187
instances\&.
202188
.PP
203-
As of MySQL 5\&.1\&.35, the
189+
The
204190
[mysqld]
205191
or
206192
[mysqld_safe]
@@ -213,11 +199,7 @@ option to use a different configuration file for that instance, in which case th
213199
[mysqld]
214200
or
215201
[mysqld_safe]
216-
groups from that file will be used for that instance\&. Before MySQL 5\&.1\&.35, some versions of
217-
\fBmysqld_multi\fR
218-
pass the
219-
\fB\-\-no\-defaults\fR
220-
options to instances, so these techniques are inapplicable\&.
202+
groups from that file will be used for that instance\&.
221203
.PP
222204
\fBmysqld_multi\fR
223205
supports the following options\&.
@@ -245,38 +227,6 @@ Display a help message and exit\&.
245227
.sp -1
246228
.IP \(bu 2.3
247229
.\}
248-
.\" mysqld_multi: config-file option
249-
.\" config-file option: mysqld_multi
250-
\fB\-\-config\-file=\fR\fB\fIfile_name\fR\fR
251-
.sp
252-
As of MySQL 5\&.1\&.18, this option is deprecated\&. If given, it is treated the same way as
253-
\fB\-\-defaults\-extra\-file\fR, described earlier\&.
254-
\fB\-\-config\-file\fR
255-
is removed in MySQL 5\&.5\&.
256-
.sp
257-
Before MySQL 5\&.1\&.18, this option specifies the name of an extra option file\&. It affects where
258-
\fBmysqld_multi\fR
259-
looks for
260-
[mysqld\fIN\fR]
261-
option groups\&. Without this option, all options are read from the usual
262-
my\&.cnf
263-
file\&. The option does not affect where
264-
\fBmysqld_multi\fR
265-
reads its own options, which are always taken from the
266-
[mysqld_multi]
267-
group in the usual
268-
my\&.cnf
269-
file\&.
270-
.RE
271-
.sp
272-
.RS 4
273-
.ie n \{\
274-
\h'-04'\(bu\h'+03'\c
275-
.\}
276-
.el \{\
277-
.sp -1
278-
.IP \(bu 2.3
279-
.\}
280230
.\" mysqld_multi: example option
281231
.\" example option: mysqld_multi
282232
\fB\-\-example\fR
@@ -387,8 +337,8 @@ rather than to the log file\&. By default, output goes to the log file\&.
387337
.\" password option: mysqld_multi
388338
\fB\-\-password=\fR\fB\fIpassword\fR\fR
389339
.sp
390-
The password of the MySQL account to use when invoking
391-
\fBmysqladmin\fR\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&.
340+
The password of the MariaDB account to use when invoking
341+
\fBmysqladmin\fR\&. Note that the password value is not optional for this option, unlike for other MariaDB programs\&.
392342
.RE
393343
.sp
394344
.RS 4
@@ -418,11 +368,10 @@ Silent mode; disable warnings\&.
418368
.\" tcp-ip option: mysqld_multi
419369
\fB\-\-tcp\-ip\fR
420370
.sp
421-
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
422-
stop
423-
and
424-
report
425-
operations\&.
371+
Connect to the MariaDB server(s) via the TCP/IP port instead of the UNIX socket\&. This affects stopping
372+
and reporting. If a socket file is missing, the server may still be running, but can be accessed only
373+
via the TCP/IP port\&. By default connecting is done via the UNIX socket\&. This option affects
374+
stop and report operations\&.
426375
.RE
427376
.sp
428377
.RS 4
@@ -437,7 +386,7 @@ operations\&.
437386
.\" user option: mysqld_multi
438387
\fB\-\-user=\fR\fB\fIuser_name\fR\fR
439388
.sp
440-
The user name of the MySQL account to use when invoking
389+
The user name of the MariaDB account to use when invoking
441390
\fBmysqladmin\fR\&.
442391
.RE
443392
.sp
@@ -496,8 +445,9 @@ servers with the same data directory\&. Use separate data directories, unless yo
496445
\fIknow\fR
497446
what you are doing\&. Starting multiple servers with the same data directory does
498447
\fInot\fR
499-
give you extra performance in a threaded system\&. See
500-
Section\ \&5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq\&.
448+
give you extra performance in a threaded system\&.
449+
.sp .5v
450+
.RE
501451
.RE
502452
.sp
503453
.RS 4
@@ -508,28 +458,15 @@ Section\ \&5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq\&.
508458
.sp -1
509459
.IP \(bu 2.3
510460
.\}
511-
.if n \{\
512-
.sp
513-
.\}
514-
.RS 4
515-
.it 1 an-trap
516-
.nr an-no-space-flag 1
517-
.nr an-break-flag 1
518-
.br
519-
.ps +1
520-
\fBImportant\fR
521-
.ps -1
522-
.br
523-
Make sure that the data directory for each server is fully accessible to the Unix account that the specific
461+
\fBImportant\fR: Make sure that the data directory for each server is fully accessible to the Unix account that the specific
524462
\fBmysqld\fR
525463
process is started as\&.
526464
\fIDo not\fR
527465
use the Unix
528466
\fIroot\fR
529467
account for this, unless you
530468
\fIknow\fR
531-
what you are doing\&. See
532-
Section\ \&5.3.6, \(lqHow to Run MySQL as a Normal User\(rq\&.
469+
what you are doing\&.
533470
.sp .5v
534471
.RE
535472
.RE
@@ -542,7 +479,7 @@ Section\ \&5.3.6, \(lqHow to Run MySQL as a Normal User\(rq\&.
542479
.sp -1
543480
.IP \(bu 2.3
544481
.\}
545-
Make sure that the MySQL account used for stopping the
482+
Make sure that the MariaDB account used for stopping the
546483
\fBmysqld\fR
547484
servers (with the
548485
\fBmysqladmin\fR
@@ -565,10 +502,7 @@ mysql> \fBGRANT SHUTDOWN ON *\&.*\fR
565502
.RE
566503
.\}
567504
.sp
568-
See
569-
Section\ \&5.4, \(lqThe MySQL Access Privilege System\(rq\&. You have to do this for each
570-
\fBmysqld\fR
571-
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
505+
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
572506
multi_admin
573507
from the host where you want to run
574508
\fBmysqld_multi\fR\&.
@@ -716,8 +650,6 @@ user = jani
716650
.RE
717651
.\}
718652
.PP
719-
See
720-
Section\ \&4.2.3.3, \(lqUsing Option Files\(rq\&.
721653
.SH "COPYRIGHT"
722654
.br
723655
.PP

0 commit comments

Comments
 (0)