531 lines
7.8 KiB
Groff
531 lines
7.8 KiB
Groff
'\" t
|
|
.\" Title: comp_err
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 12/13/2024
|
|
.\" Manual: MySQL Database System
|
|
.\" Source: MySQL 8.4
|
|
.\" Language: English
|
|
.\"
|
|
.TH "COMP_ERR" "1" "12/13/2024" "MySQL 8\&.4" "MySQL Database System"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
comp_err \- compile MySQL error message file
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBcomp_err\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
|
|
\fBcomp_err [\fR\fB\fIoptions\fR\fR\fB]\fR
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBcomp_err\fR
|
|
creates the
|
|
errmsg\&.sys
|
|
file that is used by
|
|
\fBmysqld\fR
|
|
to determine the error messages to display for different error codes\&.
|
|
\fBcomp_err\fR
|
|
normally is run automatically when MySQL is built\&. It compiles the
|
|
errmsg\&.sys
|
|
file from text\-format error information in MySQL source distributions:
|
|
.PP
|
|
The error information comes from the
|
|
messages_to_error_log\&.txt
|
|
and
|
|
messages_to_clients\&.txt
|
|
files in the
|
|
share
|
|
directory\&.
|
|
.PP
|
|
For more information about defining error messages, see the comments within those files, along with the
|
|
errmsg_readme\&.txt
|
|
file\&.
|
|
.PP
|
|
\fBcomp_err\fR
|
|
also generates the
|
|
mysqld_error\&.h,
|
|
mysqld_ername\&.h, and
|
|
mysqld_errmsg\&.h
|
|
header files\&.
|
|
.PP
|
|
Invoke
|
|
\fBcomp_err\fR
|
|
like this:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
comp_err [\fIoptions\fR]
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
\fBcomp_err\fR
|
|
supports the following options\&.
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-help\fR,
|
|
\fB\-?\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--help
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
false
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Display a help message and exit\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-charset=\fR\fB\fIdir_name\fR\fR,
|
|
\fB\-C \fR\fB\fIdir_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--charset
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
../share/charsets
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The character set directory\&. The default is
|
|
\&.\&./sql/share/charsets\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-debug=\fR\fB\fIdebug_options\fR\fR,
|
|
\fB\-# \fR\fB\fIdebug_options\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--debug=options
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
d:t:O,/tmp/comp_err.trace
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Write a debugging log\&. A typical
|
|
\fIdebug_options\fR
|
|
string is
|
|
d:t:O,\fIfile_name\fR\&. The default is
|
|
d:t:O,/tmp/comp_err\&.trace\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-debug\-info\fR,
|
|
\fB\-T\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--debug-info
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
false
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Print some debugging information when the program exits\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-errmsg\-file=\fR\fB\fIfile_name\fR\fR,
|
|
\fB\-H \fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--errmsg-file=name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
mysqld_errmsg.h
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The name of the error message file\&. The default is
|
|
mysqld_errmsg\&.h\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-header\-file=\fR\fB\fIfile_name\fR\fR,
|
|
\fB\-H \fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--header-file=name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
mysqld_error.h
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The name of the error header file\&. The default is
|
|
mysqld_error\&.h\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-in\-file\-errlog=\fR\fB\fIfile_name\fR\fR,
|
|
\fB\-e \fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--in-file-errlog
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
../share/messages_to_error_log.txt
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The name of the input file that defines error messages intended to be written to the error log\&. The default is
|
|
\&.\&./share/messages_to_error_log\&.txt\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-in\-file\-toclient=\fR\fB\fIfile_name\fR\fR,
|
|
\fB\-c \fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--in-file-toclient=path
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
../share/messages_to_clients.txt
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The name of the input file that defines error messages intended to be written to clients\&. The default is
|
|
\&.\&./share/messages_to_clients\&.txt\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-name\-file=\fR\fB\fIfile_name\fR\fR,
|
|
\fB\-N \fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--name-file=name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
mysqld_ername.h
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The name of the error name file\&. The default is
|
|
mysqld_ername\&.h\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-out\-dir=\fR\fB\fIdir_name\fR\fR,
|
|
\fB\-D \fR\fB\fIdir_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--out-dir=path
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
../share/
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The name of the output base directory\&. The default is
|
|
\&.\&./sql/share/\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-out\-file=\fR\fB\fIfile_name\fR\fR,
|
|
\fB\-O \fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--out-file=name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
errmsg.sys
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The name of the output file\&. The default is
|
|
errmsg\&.sys\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-version\fR,
|
|
\fB\-V\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--version
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
false
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Display version information and exit\&.
|
|
.RE
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
.PP
|
|
Copyright \(co 1997, 2024, Oracle and/or its affiliates.
|
|
.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
|
|
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
.PP
|
|
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/.
|
|
.SH AUTHOR
|
|
Oracle Corporation (http://dev.mysql.com/).
|