summaryrefslogtreecommitdiff
path: root/man/mysqld_safe.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/mysqld_safe.1')
-rw-r--r--man/mysqld_safe.1202
1 files changed, 131 insertions, 71 deletions
diff --git a/man/mysqld_safe.1 b/man/mysqld_safe.1
index 25848aecb9c..fe89c4e2aad 100644
--- a/man/mysqld_safe.1
+++ b/man/mysqld_safe.1
@@ -1,13 +1,6 @@
'\" t
-.\" Title: \fBmysqld_safe\fR
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 04/06/2010
-.\" Manual: MySQL Database System
-.\" Source: MySQL 5.1
-.\" Language: English
.\"
-.TH "\FBMYSQLD_SAFE\FR" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
+.TH "\FBMYSQLD_SAFE\FR" "1" "04/08/2015" "MariaDB 10\&.0" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -22,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
@@ -31,34 +24,10 @@ mysqld_safe \- MySQL server startup script
\fBmysqld_safe\fR
is the recommended way to start a
\fBmysqld\fR
-server on Unix and NetWare\&.
+server on Unix\&.
\fBmysqld_safe\fR
-adds some safety features such as restarting the server when an error occurs and logging runtime information to an error log file\&. Descriptions of error logging and NetWare\-specific behaviors are given later in this section\&.
-.if n \{\
+adds some safety features such as restarting the server when an error occurs and logging runtime information to an error log file\&. Descriptions of error logging is given later in this section\&.
.sp
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
-.PP
-In MySQL 5\&.1\&.20 (only), the default error logging behavior with
-\fBmysqld_safe\fR
-is to write errors to
-syslog
-on systems that support the
-\fBlogger\fR
-program\&. This differs from the default behavior of writing an error log file for other versions\&.
-.PP
-\fBIn 5\&.1\&.20, logging to \fR\fBsyslog\fR\fB may fail to operate correctly in some cases; if so, use \fR\fB\fB\-\-skip\-syslog\fR\fR\fB to use the default log file or \fR\fB\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR\fR\fB to specify a log file name explicitly\&.\fR
-.sp .5v
-.RE
-.PP
\fBmysqld_safe\fR
tries to start an executable named
\fBmysqld\fR\&. To override the default behavior and specify explicitly the name of the server you want to run, specify a
@@ -75,8 +44,7 @@ should look for the server\&.
Many of the options to
\fBmysqld_safe\fR
are the same as the options to
-\fBmysqld\fR\&. See
-Section\ \&5.1.2, \(lqServer Command Options\(rq\&.
+\fBmysqld\fR\&.
.PP
Options unknown to
\fBmysqld_safe\fR
@@ -84,8 +52,7 @@ are passed to
\fBmysqld\fR
if they are specified on the command line, but ignored if they are specified in the
[mysqld_safe] or [mariadb_safe]
-groups of an option file\&. See
-Section\ \&4.2.3.3, \(lqUsing Option Files\(rq\&.
+groups of an option file\&.
.PP
\fBmysqld_safe\fR
reads all options from the
@@ -117,11 +84,10 @@ also reads
[safe_mysqld]
sections, although you should rename such sections to
[mysqld_safe]
-in MySQL 5\&.1 installations\&.
+in current installations\&.
.PP
\fBmysqld_safe\fR
-supports the options in the following list\&. It also reads option files and supports the options for processing them described at
-Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
+supports the options in the following list\&. It also reads option files and supports the options for processing them.
.sp
.RS 4
.ie n \{\
@@ -150,7 +116,7 @@ Display a help message and exit\&.
.\" basedir option: mysqld_safe
\fB\-\-basedir=\fR\fB\fIpath\fR\fR
.sp
-The path to the MySQL installation directory\&.
+The path to the MariaDB installation directory\&.
.RE
.sp
.RS 4
@@ -179,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
@@ -224,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
@@ -245,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
@@ -263,7 +273,7 @@ Section\ \&5.2.2, \(lqThe Error Log\(rq\&.
.sp
The name of the server program (in the
ledir
-directory) that you want to start\&. This option is needed if you use the MySQL binary distribution but have the data directory outside of the binary distribution\&. If
+directory) that you want to start\&. This option is needed if you use the MariaDB binary distribution but have the data directory outside of the binary distribution\&. If
\fBmysqld_safe\fR
cannot find the server, use the
\fB\-\-ledir\fR
@@ -328,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
@@ -343,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
@@ -380,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
@@ -444,7 +514,7 @@ on systems that support the
program\&.
\-\-skip\-syslog
suppresses the use of
-syslog; messages are written to an error log file\&. These options were added in MySQL 5\&.1\&.20\&.
+syslog; messages are written to an error log file\&.
.RE
.sp
.RS 4
@@ -471,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
@@ -509,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
@@ -544,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
@@ -571,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
@@ -589,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
@@ -611,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
@@ -626,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
@@ -686,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
@@ -707,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
@@ -723,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
@@ -761,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
@@ -808,7 +870,7 @@ file in the data directory\&.
.SH "COPYRIGHT"
.br
.PP
-Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
+Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2015 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
@@ -817,8 +879,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
.sp
.SH "SEE ALSO"
-For more information, please refer to the MySQL Reference Manual,
-which may already be installed locally and which is also available
-online at http://dev.mysql.com/doc/.
+For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
.SH AUTHOR
-Sun Microsystems, Inc. (http://www.mysql.com/).
+MariaDB Foundation (http://www.mariadb.org/).